API docs by Redocly

ScotLIS Land Register API (1.0)

Download OpenAPI specification:Download

Environments

Sandbox — https://api.sandbox.ros.gov.uk/v1/
Production — https://api.ros.gov.uk/v1/

Title Summary

Title summary

ℹ️ Free endpoint

Returns a summary of a title including addresses, description, consideration, interest type and the list of applications and plans available to download.

This endpoint supports registered, draft, closed, cancelled, amalgamated and absorbed titles. The information returned will depend on the status of the title; complete summary information is only returned for registered titles. See the response schemas for an illustration of what to expect.

Authorizations:
OAuth2.0-Client-Credentials
path Parameters
titleNumber
required
string [ 4 .. 11 ] characters ^[A-Z]{3}[0-9]{1,8}$
Example: MID15313

Title number

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Title Data

Title sheet data

⚠️ Chargeable endpoint - Title data and plans

Returns further details of a title including complete proprietorship, consideration, security and burden information.

Only registered titles are supported. The status of any pending, registered or closed title may be obtained from the summary endpoint.

Authorizations:
OAuth2.0-Client-Credentials
path Parameters
titleNumber
required
string [ 4 .. 11 ] characters ^[A-Z]{3}[0-9]{1,8}$
Example: MID15313

Title number

query Parameters
fas
required
string [ 4 .. 6 ] characters ^[0-9]{4,6}$
Example: fas=0877

FAS number for charging. Must be a ScotLIS FAS assigned to your organisation.

reference
string <= 75 characters
Example: reference=23/MACDONALD/114

Your search reference. Will appear on invoices.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "charges": [
    ]
}

Title pending applications

⚠️ Chargeable endpoint - Title pending applications

Returns details of all advance notices and pending applications for the title.

Registered and draft (undergoing registration) titles are supported.

Authorizations:
OAuth2.0-Client-Credentials
path Parameters
titleNumber
required
string [ 4 .. 11 ] characters ^[A-Z]{3}[0-9]{1,8}$
Example: MID15313

Title number

query Parameters
fas
required
string [ 4 .. 6 ] characters ^[0-9]{4,6}$
Example: fas=0877

FAS number for charging. Must be a ScotLIS FAS assigned to your organisation.

reference
string <= 75 characters
Example: reference=23/MACDONALD/114

Your search reference. Will appear on invoices.

Responses

Response samples

Content type
application/json
{
  • "list": {
    },
  • "charges": [
    ]
}

Title Document

Order title document

⚠️ Chargeable endpoint - Title data and plans (if requested), Title pending applications (if requested)

Prepares a title document for download, returning a link to download it. The body of the request should indicate which data is required within the document.

Returned document IDs are valid for use by the same API client until the end of the current day.

At present, only registered titles are supported.

Authorizations:
OAuth2.0-Client-Credentials
path Parameters
titleNumber
required
string [ 4 .. 11 ] characters ^[A-Z]{3}[0-9]{1,8}$
Example: MID15313

Title number

query Parameters
fas
required
string [ 4 .. 6 ] characters ^[0-9]{4,6}$
Example: fas=0877

FAS number for charging. Must be a ScotLIS FAS assigned to your organisation.

reference
string <= 75 characters
Example: reference=23/MACDONALD/114

Your search reference. Will appear on invoices.

Request Body schema: application/json
object
include
required
boolean
Example: true

Whether to include a title sheet in the document.

preambles
string
Default: "INLINE"
Enum: "INLINE" "UPFRONT" "ONLY"

Where to include burden preambles in the D section. Choices are - inline with the burden full texts, grouped upfront before burden full texts, or preambles only without full burden texts.

object
include
required
boolean
Example: true

Whether to include pending applications in the document.

Responses

Request samples

Content type
application/json
{
  • "titleSheet": {
    },
  • "applications": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "charges": [
    ]
}

Download title document

ℹ️ Free endpoint

Returns a title document PDF ordered using the order title document API.

A document ID is valid for use only by the same API client that ordered it, and expires at the end of the day it was ordered. The ID can be used to download the same document any number of times. If the document ID belongs to another API client or has expired, a 404 is returned with the DOCUMENT_NOT_FOUND error code.

Authorizations:
OAuth2.0-Client-Credentials
path Parameters
titleNumber
required
string [ 4 .. 11 ] characters ^[A-Z]{3}[0-9]{1,8}$
Example: MID15313

Title number

documentId
required
string
Example: c8b12ca9-544e-18bc-f303-29cd4f0a921c

Unique document ID

Responses

Response samples

Content type
application/json
{
  • "code": "INVALID_TITLE_NUMBER"
}

Title Plan

Order title plans

⚠️ Chargeable endpoint - Title data and plans

Purchases all title plans, supplementary plans and plan images for a title and returns the plan IDs needed to download them. Only registered titles are supported.

Returned plan IDs are valid for use by the same API client until the end of the current day.

This call is charged at the standard rate for title sheets and plans. Note some registered titles do not have a plan available to download via ScotLIS or this API. If this is the case, this endpoint will return a 200 status but with an empty list of plans, and no charge will be incurred.

Authorizations:
OAuth2.0-Client-Credentials
path Parameters
titleNumber
required
string [ 4 .. 11 ] characters ^[A-Z]{3}[0-9]{1,8}$
Example: MID15313

Title number

query Parameters
fas
required
string [ 4 .. 6 ] characters ^[0-9]{4,6}$
Example: fas=0877

FAS number for charging. Must be a ScotLIS FAS assigned to your organisation.

reference
string <= 75 characters
Example: reference=23/MACDONALD/114

Your search reference. Will appear on invoices.

Responses

Response samples

Content type
application/json
{
  • "plans": [
    ],
  • "charges": [
    ]
}

Download title plan

ℹ️ Free endpoint

Returns a title plan, supplementary plan or plan image. The plan ID to use should be fetched from the title summary endpoint.

A plan ID is valid for use only by the same API client that ordered it, and expires at the end of the day it was ordered. The ID can be used to download the same plan any number of times. If the plan ID belongs to another API client or has expired, a 404 is returned with the DOCUMENT_NOT_FOUND error code.

Authorizations:
OAuth2.0-Client-Credentials
path Parameters
titleNumber
required
string [ 4 .. 11 ] characters ^[A-Z]{3}[0-9]{1,8}$
Example: MID15313

Title number

planId
required
string
Example: c8b12ca9-544e-18bc-f303-29cd4f0a921c

Unique plan ID

Responses

Response samples

Content type
application/json
{
  • "code": "INVALID_TITLE_NUMBER"
}