1. Home
  2. LR Application

Land Register Application schema
https://api.ros.gov.uk/v1/lr/application/schema.json

Overview

This document describes the schema of the main application object which is used in the Land Registry Application Form API. For more details of the API see:

The elements described in this document make extensive use of common schema components.

Read vs. write

This document describes the abstract application object, with all fields you could possibly fill out. In practice some fields are ignored, or are not valid to send when sending data to our services. For example the metadata validation field is only ever valid when read from the service, and is never provided by a consumer of the service.

In other locations when a general entity is used (like the agent's company) only a limited subset of the fields are actually expected. You are free to fill out additional fields as allowed by the schema, but they will be discarded.

There are two main versions of the application entity:

  • Application - The full data set. You should submit this to the end-points
  • Application core - A limited sub-set. You can expect to see this returned from end-points.

Dynamic requirements

The schema does not convey to totality of the requirements on an application. Some sections are only required depending on the values of certain fields. Therefore a data structure which is completely valid according to the schema is not necessarily valid according to the API.

Therefore you may receive extra validation errors in the metadata section that you cannot reproduce using a client side JSON schema validator. However your document must certainly conform to the provided schema before you can expect it to be accepted by the service.

Where are the main entities?

#/ - Land Register Application schema

This schema describes the entities used to store and communicate Land Register e-Forms Applications

This entity is a container only. You should send an application instead.

{
    "$schema": "http://json-schema.org/schema#",
    "id": "https://api.ros.gov.uk/v1/lr/application/schema.json",

    "title": "Land Register Application schema",
    "description": "This schema describes the entities used to store and communicate Land Register e-Forms Applications"
}

#/application

This schema describes the document format sent to the API

A stricter child of the core application

This schema is almost entirely described in (Application Core)[#/applicationCore]. The difference between the two is:

  • This schema is what we expect to be sent to the LR Application end-points
  • It is stricter than the core schema
  • The core schema is what you can expect from the end-points and contains less information

Agent

We do not require all of the fields it is possible to submit for an agent.

The following fields are automatically calculated based on the processingInstructions.payment.fasNumber:

  • company.address
  • company.name (we recommend not sending this field in the payload to avoid possible validation errors)

If you do not specify values for the following fields, they will be automatically calculated based on the username that granted you access to the API:

  • name
  • contact
{
    "name": "Land Register application",
    "description": "This schema describes the document format sent to the API",
    "allOf": [
        {"$ref": "#/applicationCore"},
        {

            "properties": {
                "agent": {
                    "required": ["contact"],
                    "properties": {
                        "contact": {
                            "required": ["phoneNumber"]
                        }
                    }
                },
                "declarations": {
                    "allOf": [
                        {"$ref": "#/definitions/declarations"},
                        {
                            "properties": {
                                "plans": {
                                    "required": ["isOnCadastralMap", "isInDeed"]
                                },
                                "extensionOfWarranty": {
                                    "anyOf": [
                                        {
                                            "properties": {
                                                "isApplicable": {"enum": [false]}
                                            }
                                        },
                                        {
                                            "properties": {
                                                "isApplicable": {"enum": [true]}
                                            },
                                            "required": ["legalSubsection"]
                                        }
                                    ]
                                }
                            },
                            "required": [
                                "plans",
                                "sharedPlots",
                                "registerOfInhibitionsSearch",
                                "landTax",
                                "restrictionOrLimitation",
                                "servitudes",
                                "securitiesSearch",
                                "burdens",
                                "extensionOfWarranty",
                                "additionalInformation",
                                "certification"
                            ]
                        }
                    ]
                }
            },
            "required": ["declarations"]
        }
    ]
}

References:

Used in:

{
    "type": {
        "code": "fr"
    },

    "deed": {
        "type": {
            "code": "11",
            "prettyPrint": "Disposition"
        },

        "subject": [
             {
                "address": {
                    "name" : "Grimley Manor",
                    "number" : "1F1",
                    "town" : "ABERDEEN",
                    "street" : "BRIGHTON PLACE",
                    "county": "Fife",
                    "country": {
                        "code": "GB"
                    },
                    "postcode" : "AB106RT",

                    "prettyPrint": "117 BRIGHTON PLACE, ABERDEEN, AB106RT"
                },
                "reference": {
                    "titleNumber": "FFE10",
                    "searchSheet": {
                        "county": {
                            "code": "ffe"
                        },
                        "number": "123"
                    },
                    "developmentPlanApproval": {
                        "number": "1234",
                        "plotNumber": "5678"
                    }
                },
                "date": {
                    "entry": "2000-12-01T00:00:00Z"
                },
                "details": "A bit of land next to the bog"
            }
        ],

        "granter": [
            {
                "type": {
                    "code": "non_natural_uk"
                },

                "name": {
                    "prefix": {
                        "code": "the"
                    },
                    "company": "Magic Co."
                },

                "address" : {
                    "name" : "A house",
                    "town": "Middleton",
                    "postcode" : "EH56 0QY"
                },

                "reference": {
                    "ukCompanyNumber": "97823475634"
                }

            }
        ]
    },

    "agent": {
        "type": {"code": "natural"},
        "name": {
            "prefix": {
                "code": "lady",
                "prettyPrint": "Lady"
            },
            "first": "Jane",
            "last": "Smith",
            "prettyPrint": "Lady Jane Smith"
        },

        "contact": {
            "phoneNumber": "0123 123 1111",
            "emailAddress": "bobb@bobo.bob"
        },

        "company": {
            "type": {
                "code": "non_natural_uk"
            },
            "name": {
                "company": "Test Organisation 1 other Direct Debit"
            },
            "address": {
                "name": "A house",
                "postcode": "EH56 0QY",
                "prettyPrint": "A house, 23, 3F1, West Bromlinton St., Edinburgh, INVERURIE, UK, EH56 0QY, Lothian"
            }
        },
        "prettyPrint": "Lady Jane Smith\nThe Solicitor Co.\nA house, 23, 3F1, West Bromlinton St., Edinburgh, INVERURIE, UK, EH56 0QY, Lothian"
    },

    "declarations": {
        "burdens": {
            "isGroundPlot": false,
            "isNotAffect": false
        },
        "extensionOfWarranty": {
            "isApplicable": true,
            "legalSubsection": "11.5 subsection b"
        },
        "landTax": {
            "isApplicable": true,
            "isSatisfactory": false
        },
        "landUse": {
            "type": {
                "code": "ag",
                "prettyPrint": "Agriculture"
            }
        },
        "plans": {
            "reportNumber": "298745667",
            "isOnCadastralMap": false,
            "advanceNoticeNumber": "16TST00001",
            "cadastralUnitNumber": "A string field",
            "isInDeed": true,
            "details": "Some details about the deed with the plans"
        },
        "registerOfInhibitionsSearch": {
            "isApplicable": false,
            "isPerformed": true,
            "date": {
                "searched": "1999-01-01T00:00:00Z"
            },
            "isRelevant": true,
            "details": "We found something relevant on page 34"
        },
        "restrictionOrLimitation": {
            "isApplicable": true,
            "details": "There is a restriction on the proprietor",
            "isSatisfactory": false,
            "isPrescribed": true
        },
        "securitiesSearch": {
            "isApplicable": true,
            "date": {
                "searched": "1999-01-01T00:00:00Z"
            },
            "isRelevant": false
        },
        "servitudes": {
            "isPlotRelatedServitudes": false,
            "creationType": false,
            "servitudeNoLongerBenefits": true,
            "servitudeNoLongerBenefitsDetails": "Some details"
        },
        "sharedPlots": {
            "isApplicable": true,
            "titleNumber": ["FFE90", "FFE91"],
            "isRegistered": false
        },

        "additionalInformation": {
            "isApplicable": true,
            "details": "Some extra things I couldn't include in the form"
        },

        "certification": {
            "isSatisfactory": true,
            "isUnregisteredPlot": true,
            "isDeedSatisfactory": true,

            "isComplete": true
        }
    },

    "supportingDeed": [
        {
            "type": {
                "code": "ex:1"
            },
            "has": {
                "burden": false,
                "security": false,
                "servitude": true,
                "plan": false
            },
            "isAttached": true,
            "details": "I'm a deed",
            "date": {
                "recording": "2000-12-01T00:00:00Z"
            }
        },
        {
            "type": {
                "code": "other",
                "prettyPrint": "A very important deed"
            },
            "has": {
                "burden": true,
                "security": false,
                "servitude": false,
                "plan": false
            },
            "isAttached": true,
            "details": "I'm another deed",
            "date": {
                "recording": "2002-12-01T00:00:00Z"
            }
        }
    ],

    "applicant": [
        {
            "type": {
                "code": "natural"
            },

            "name": {
                "prefix": {
                    "code": "sir"
                },
                "first": "John",
                "last": "Smith"
            },

            "address" : {
                "name" : "A house",
                "town": "Middleton",
                "postcode" : "EH56 0QY"
            }
        }
    ],

    "processingInstructions": {
        "payment": {
            "fasNumber": "1001",
            "method": {"code": "dd"},

            "fee": {
                "amount": 30.0,
                "basis": {
                    "consideration": {
                        "monetary": 50000,
                        "nonMonetary": {"code": "love_etc"},
                        "details": "Human description here"
                    },
                    "annualRent": 1200,
                    "monetaryValue": 250000
                }
            }
        },

        "notification": {
            "email": ["example@example.com", "example2@example.com"]
        }
    },

    "reference": {
        "agent": "MY-CASE-1234"
    }
}

#/applicationCore - Land Register Core Form

This schema describes the main document format returned by the API

A sub-set of the total form data

This schema defines the data you can expect from the end-points when retrieving data. It is considerably looser than the main Application, which has many more required fields.

  • If you have sent data via the API you can expect almost all of it to be returned
  • If you have sent data via the UI, a smaller sub-set is returned

Addresses

Wherever addresses are used in this API we do not require all of the fields it is possible to submit for an address.

You should fill out:

  • number
  • street
  • name
  • postcode
  • town
  • county
  • country.code

Information specified in other fields allowed under the common entity schema for a structured address (locality, subBuilding, reference and cmsAddenda) will be discarded.

Agent

We do not require any of the fields it is possible to submit for an agent. The following fields, if not provided, are auto-filled based on the FAS number specified in processingInstructions.payment.fasNumber:

  • agent.company.name
  • agent.company.address

The following fields are optional and cannot be auto-filled via the API:

  • agent.name
  • agent.contactDetails.phoneNumber
  • agent.contactDetails.emailAddress

Applicants and Granters

We do not require all of the fields it is possible to submit for an applicant or granter.

You should fill out:

  • type
  • name - See note about middle names below
  • address
  • reference.ukCompanyNumber - If a UK company
  • reference.allocatedNumber - If a Non-UK company

A note about middle names:

Currently the LR Application Form does not have a middle name field. Therefore any middle names added via the API will be appended to the first name field. This may cause issues if you submit a middle name in the middle name field and then read from the API and expect the same data back.

{
    "title": "Land Register Core Form",
    "description": "This schema describes the main document format returned by the API",

    "type": "object",
    "additionalProperties": false,

    "properties": {
        "id": {"type": "string"},

        "type": {
            "allOf": [
                {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/codedValue"},
                {"properties": {
                    "code": {"format": "ref:lr/application/type"}
                }}
            ]
        },

        "deed": {"$ref": "#/definitions/deed"},

        "supportingDeed": {
            "type": "array",
            "items": {"$ref": "#/definitions/supportingDeed"}
        },

        "agent": {
            "$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/agent"
        },

        "applicant": {
            "type": "array",
            "items": {"$ref": "#/definitions/party"},
            "minItems": 1
        },

        "declarations": {
            "$ref": "#/definitions/declarations"
        },

        "processingInstructions": {
            "type": "object",
            "additionalProperties": false,

            "properties": {
                "payment": {"$ref": "#/definitions/payment"},
                "notification": {
                    "type": "object",
                    "additionalProperties": false,

                    "properties": {
                        "email": {
                            "type": "array", 
                            "minItems": 1, 
                            "maxItems": 4,
                            "items": {"type": "string", "format": "email"}
                        }
                    },

                    "required": ["email"]
                }
            },
            "required": ["payment", "notification"]
        },

        "metadata": {"$ref": "#/definitions/metadata"},

        "reference": {
            "type": "object",
            "additionalProperties": false,

            "properties": {
                "agent": {"type": "string"}
            }
        }
    },

    "allOf": [
        {"$ref": "#/definitions/rules"},
        {"$ref": "#/definitions/declarations/rules"}
    ],

    "required": [
        "type", "deed", "applicant", "agent", "processingInstructions"]
}

References:

Used in:

{
    "type": {
        "code": "vr",
        "prettyPrint" : "Voluntary registration"
    },

    "deed": {
        "type": {
            "code": "11",
            "prettyPrint": "Disposition"
        },

        "subject": [
             {
                "address": {
                    "name" : "Grimley Manor",
                    "number" : "1F1",
                    "town" : "ABERDEEN",
                    "street" : "BRIGHTON PLACE",
                    "county": "Fife",
                    "country": {
                        "code": "GB"
                    },
                    "postcode" : "AB106RT",

                    "prettyPrint": "117 BRIGHTON PLACE, ABERDEEN, AB106RT"
                },
                "reference": {
                    "titleNumber": "FFE10",
                    "searchSheet": {
                        "county": {
                            "code": "ffe"
                        },
                        "number": "123"
                    },
                    "developmentPlanApproval": {
                        "number": "1234",
                        "plotNumber": "5678"
                    }
                },
                "date": {
                    "entry": "2000-12-01T00:00:00Z"
                },
                "details": "A bit of land next to the bog"
            }
        ],

        "granter": [
            {
                "type": {
                    "code": "non_natural_uk"
                },

                "name": {
                    "prefix": {
                        "code": "the"
                    },
                    "company": "Magic Co."
                },

                "address" : {
                    "name" : "A house",
                    "town": "Middleton",
                    "postcode" : "EH56 0QY"
                },

                "reference": {
                    "ukCompanyNumber": "97823475634"
                }

            }
        ]
    },

    "agent": {
        "type": {"code": "natural"},
        "name": {
            "prefix": {
                "code": "lady",
                "prettyPrint": "Lady"
            },
            "first": "Jane",
            "last": "Smith",
            "prettyPrint": "Lady Jane Smith"
        },

        "contact": {
            "phoneNumber": "0123 123 1111",
            "emailAddress": "bobb@bobo.bob"
        },

        "company": {
            "type": {
                "code": "non_natural_uk"
            },
            "name": {
                "company": "Test Organisation 1 other Direct Debit"
            },
            "address": {
                "name": "A house",
                "postcode": "EH56 0QY",
                "prettyPrint": "A house, 23, 3F1, West Bromlinton St., Edinburgh, INVERURIE, UK, EH56 0QY, Lothian"
            }
        },
        "prettyPrint": "Lady Jane Smith\nThe Solicitor Co.\nA house, 23, 3F1, West Bromlinton St., Edinburgh, INVERURIE, UK, EH56 0QY, Lothian"
    },

    "declarations": {
        "certification": {
            "isSatisfactory": true,
            "isUnregisteredPlot": true,
            "isComplete": true
        }
    },

    "applicant": [
        {
            "type": {
                "code": "natural"
            },

            "name": {
                "prefix": {
                    "code": "sir"
                },
                "first": "John",
                "last": "Smith"
            },

            "address" : {
                "name" : "A house",
                "town": "Middleton",
                "postcode" : "EH56 0QY"
            }
        }
    ],

    "processingInstructions": {
        "payment" : {
            "fasNumber" : "1001",
            "fee" : {
                "amount" : 45.0,
                "basis" : {
                    "monetaryValue" : 120.0,
                    "isVRSecurityDiscountApplicable" : false
                }
            },
            "method" : {
                "code" : "dd",
                "prettyPrint" : "Direct Debit"
            }
        },
        "notification": {
            "email": ["example@example.com", "example2@example.com"]
        }
    },

    "reference": {
        "agent": "MY-CASE-1234"
    }
}

#/definitions/applicationNumber - Application number

A Land Register application number.

This number is formed of three parts:

  • A two digit yearly running number (i.e. 16 for 2016)
  • A three digit county code (i.e. FFE for Fife)
  • A zero padded running number

Although the pattern states that any three letter code will do, only valid county codes are acceptable. In addition some valid patterns are not valid application numbers.

{
    "title": "Application number",
    "type": "string",
    "format": "lrApplicationNumber",
    "pattern": "^\\d{2}[A-Z]{3}\\d{5,}$"
}

References:

Used in:

"16FFE00123"

#/definitions/declarations - Declarations

The declarations are a large collection of assertions made by the applicant in regards to the application.

The declarations are divided into sections and questions. The schema includes a title field for both which shows the text presented to the user in the LR e-Forms user interface. The values should therefore be suitable for presenting to a user.

Dynamic content

The declaration section is one of the sections of the schema that changes the most depending on the answers to other questions.

  • Certain fields will be required for one application type, but not required for another
  • Most sections are still required, however you can set the isApplicable to false.
  • Some questions are only asked depending on the answers to previous questions

In the event that you submit details that are not appropriate for a given application / deed type combination, they will be disregarded and a sensible default will be chosen. For example, in cases where the landTax question is not appropriate, any set of answers will be accepted, but the isApplicable will be set to false after you submit the data.

Field notes

  • For some boolean fields there is only one acceptable value
  • This is as we require the user to have actively confirmed that the data is correct
  • Some fields which are available in the user interface are not available in the API. For example we ask some secondary "Are you sure?" confirmation questions in the UI which are not appropriate in the API.
{
    "title": "Declarations",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "plans": {
            "$ref": "#/definitions/declarations/plans"
        },
        "sharedPlots": {
            "$ref": "#/definitions/declarations/sharedPlots"
        },
        "registerOfInhibitionsSearch": {
            "$ref": "#/definitions/declarations/registerOfInhibitionsSearch"
        },
        "landTax": {
            "$ref": "#/definitions/declarations/landTax"
        },
        "restrictionOrLimitation": {
            "$ref": "#/definitions/declarations/restrictionOrLimitation"
        },
        "servitudes": {
            "$ref": "#/definitions/declarations/servitudes"
        },
        "securitiesSearch": {
            "$ref": "#/definitions/declarations/securitiesSearch"
        },
        "burdens": {
            "$ref": "#/definitions/declarations/burdens"
        },
        "extensionOfWarranty": {
            "$ref": "#/definitions/declarations/extensionOfWarranty"
        },
        "additionalInformation": {
            "$ref": "#/definitions/declarations/additionalInformation"
        },
        "landUse": {
            "$ref": "#/definitions/declarations/landUse"
        },
        "certification": {
            "$ref": "#/definitions/declarations/certification"
        }
    }
}

References:

Used in:

{
    "burdens": {
        "isGroundPlot": true,
        "details": "Some details",
        "isNotAffect": true,
        "notAffectDetails": "More details"
    },
    "extensionOfWarranty": {
        "isApplicable": true,
        "legalSubsection": "11.5 subsection b"
    },
    "landTax": {
        "isApplicable": true,
        "isSatisfactory": false
    },
    "landUse": {
        "type": {
            "code": "ag",
            "prettyPrint": "Agriculture"
        }
    },
    "plans": {
        "reportNumber": "298745667",
        "isOnCadastralMap": false,
        "advanceNoticeNumber": "16TST00001",
        "cadastralUnitNumber": "A string field",
        "isInDeed": true
    },
    "registerOfInhibitionsSearch": {
        "isApplicable": false,
        "isPerformed": true,
        "date": {
            "searched": "1999-01-01T00:00:00Z"
        },
        "isRelevant": true,
        "details": "We found something relevant on page 34"
    },
    "restrictionOrLimitation": {
        "isApplicable": true,
        "details": "There is a restriction on the proprietor",
        "isSatisfactory": false,
        "isPrescribed": true
    },
    "securitiesSearch": {
        "isApplicable": true,
        "date": {
            "searched": "1999-01-01T00:00:00Z"
        },
        "isRelevant": false
    },
    "servitudes": {
        "isPlotRelatedServitudes": false,
        "creationType": false,
        "servitudeNoLongerBenefits": true,
        "servitudeNoLongerBenefitsDetails": "Some details"
    },
    "sharedPlots": {
        "isApplicable": true,
        "titleNumber": ["TST123", "TST124"],
        "isRegistered": false
    },

    "additionalInformation": {
        "isApplicable": false,
        "details": "Some extra things I couldn't include in the form"
    },

    "certification": {
        "isSatisfactory": true,
        "isUnregisteredPlot": true,
        "isDeedSatisfactory": true,

        "isComplete": true
    }
}

#/definitions/declarations/additionalInformation - Further Information 

{
    "title": "Further Information",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "isApplicable": {
            "type": "boolean",
            "title": "Is there any other information material to the application to register the deed which has not already been disclosed in the application or its accompanying documents?"
        },
        "details": {
            "type": "string",
            "title": "Please provide details",
            "pattern": "\\S+",
            "minLength": 1
        }
    },

    "anyOf": [
        {
            "properties": {
                "isApplicable": {"enum": [false]}
            }
        },
        {
            "properties": {
                "isApplicable": {"enum": [true]}
            },
            "required": ["details"]
        }
    ],

    "required": ["isApplicable"]
}

References:

Used in:

{
    "isApplicable": false,
    "details": "Some extra things I couldn't include in the form"
}

#/definitions/declarations/burdens - Burdens 

{
    "title": "Burdens",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "isGroundPlot": {
            "type": "boolean",
            "title": "Are there any encumbrances that are not referred to or narrated in the deed to which this application relates (for example in a split-off/break-off deed)?"
        },
        "details": {
            "title": "Provide details of the encumbrance(s)",
            "type": "string",
            "pattern": "\\S+",
            "minLength": 1
        },
        "isNotAffect": {
            "type": "boolean",
            "title": "Are there any encumbrances referred to or narrated in the deed to which this application relates that no longer affect?"
        },
        "notAffectDetails": {
            "title": "Provide details of encumbrances that no longer affect",
            "type": "string",
            "pattern": "\\S+",
            "minLength": 1,
            "maxLength": 5000
        }
    },
    "oneOf": [
        {
            "properties": {
                "isNotAffect": {
                    "enum": [
                        false
                    ]
                }
            }
        },
        {
            "properties": {
                "isNotAffect": {
                    "enum": [
                        true
                    ]
                }
            },
            "required": [
                "notAffectDetails"
            ]
        }
    ],
    "required": [
        "isGroundPlot",
        "isNotAffect"
    ]
}

References:

Used in:

{
    "isNotAffect": false,
    "isGroundPlot": false
}

#/definitions/declarations/certification - Declaration 

{
    "title": "Declaration",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "isDeedSatisfactory": {
            "type": "boolean",
            "title": "I/We apply for registration of the deed identified in Part A and certify that this application complies with the general application conditions in section 22, and the particular conditions mentioned in section 21(2). Where the certification above is made in relation to an application to register a deed, the validity of which is dependent on the registration of a related deed, please provide details of the related deed.",
            "enum": [true]
        },
        "isSatisfactory": {
            "type": "boolean",
            "title": "I/We certify that this application complies with the requirements of sections 27 and 28",
            "enum": [true]
        },
        "isUnregisteredPlot": {
            "type": "boolean",
            "title": "I/We apply for the registration of an unregistered plot of land",
            "enum": [true]
        },
        "isComplete": {
            "type": "boolean",
            "title": "I/We certify that the information given in this form and the answers to the above questions are complete and correct to the best of my/our knowledge and belief.",
            "enum": [true]
        }
    },

    "required": ["isComplete"]
}

References:

Used in:

{
    "isSatisfactory": true,
    "isUnregisteredPlot": true,
    "isComplete": true
}

#/definitions/declarations/extensionOfWarranty - Extension of Warranty 

{
    "title": "Extension of Warranty",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "isApplicable": {
            "type": "boolean",
            "title": "Are you applying for an extension of warranty under section 75(1)?"
        },
        "legalSubsection": {
            "type": "string",
            "title": "Please indicate the relevant subsection of section 73(2) in respect of which you are applying",
            "maxLength": 5000,
            "pattern": "\\S+",
            "minLength": 1
        }
    },

    "required": ["isApplicable"]
}

References:

Used in:

{
    "isApplicable": true,
    "legalSubsection": "11.5 subsection b"
}

#/definitions/declarations/landTax - Land and Buildings Transaction Tax 

{
    "title": "Land and Buildings Transaction Tax",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "isApplicable": {
            "type": "boolean",
            "title": "Is the transaction to which this application relates a notifiable transaction in terms of section 30 of the Land and Buildings Transaction Tax (Scotland) Act 2013?"
        },
        "isSatisfactory": {
            "type": "boolean",
            "title": "Has a land transaction return been made, and have arrangements satisfactory to the tax authority been made for the payment of any tax payable in respect of the transaction?"
        }
    },

    "anyOf": [
        {
            "properties": {
                "isApplicable": {"enum": [false]}
            }
        },
        {
            "properties": {
                "isApplicable": {"enum": [true]}
            },
            "required": ["isSatisfactory"]
        }
    ],

    "required": ["isApplicable"]
}

References:

Used in:

{
    "isApplicable": true,
    "isSatisfactory": false
}

#/definitions/declarations/landUse - Land Use 

{
    "title": "Land Use",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "type": {
            "title": "Please indicate the primary use of the plot of land",
            "allOf": [
                {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/codedValue"},
                {
                    "properties": {
                        "code": {"format": "ref:lr/application/land-use"}
                    }
                }
            ]
        }
    },
    "required": ["type"]
}

References:

Used in:

{
    "type": {
        "code": "ag",
        "prettyPrint": "Agriculture"
    }
}

#/definitions/declarations/plans - Plans Details 

{
    "title": "Plans Details",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "reportNumber": {
            "type": "string",
            "title": "Registers of Scotland plans pre-registration report number (if available)",
            "maxLength": 5000
        },
        "isOnCadastralMap": {
            "type": "boolean",
            "title": "Has all or part of the plot of ground been delineated on the cadastral map?"
        },
        "cadastralUnitNumber": {
            "type": "string",
            "title": "Cadastral unit number or title number",
            "maxLength": 5000
        },
        "advanceNoticeNumber": {
            "$ref": "#/definitions/applicationNumber",
            "title": "Advance notice application number (if available)",
            "maxLength": 5000
        },
        "isInDeed": {
            "type": "boolean",
            "title": "Do the deeds submitted in support of this application include a plan or full bounding description identifying the extent of the plot to be registered?"
        },
        "details": {
            "title": "Details of Deed",
            "type": "string",
            "pattern": "\\S+",
            "minLength": 1
        }
    },

    "anyOf": [
        {
            "properties": {
                "isOnCadastralMap": {"enum": [false]}
            }
        },
        {
            "properties": {
                "isOnCadastralMap": {"enum": [true]}
            },
            "required": ["cadastralUnitNumber"]
        }
    ]
}

References:

Used in:

{
    "reportNumber": "298745667",
    "isInDeed": true,
    "isOnCadastralMap": false,
    "cadastralUnitNumber": "A string field",
    "advanceNoticeNumber": "16TST00001"
}

#/definitions/declarations/registerOfInhibitionsSearch - Register of Inhibitions 

{
    "title": "Register of Inhibitions",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "isApplicable": {
            "type": "boolean",
            "title": "Is the validity of the deed to which this application relates capable of being affected by an entry in the Register of Inhibitions and Adjudications ('the RoI')?"
        },
        "isPerformed": {
            "type": "boolean",
            "title": "Has a search of the RoI been carried out on the granter of the deed and any party whose right has vested in the granter by virtue of any unregistered mid-couple or link in title?"
        },
        "date": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "searched": {
                    "type": "string" ,
                    "format": "date-time",
                    "title": "Date to which the search was certified"
                }
            }
        },
        "isRelevant": {
            "type": "boolean",
            "title": "Did the search disclose an entry in the RoI which might affect the validity of the deed to which this application relates?"
        },
        "details": {
            "type": "string",
            "title": "Please provide details",
            "maxLength": 5000,
            "pattern": "\\S+",
            "minLength": 1
        }
    },

    "required": ["isApplicable"],

    "allOf": [
        {
            "anyOf": [
                {
                    "properties": {
                        "isApplicable": {"enum": [false]}
                    }
                },
                {
                    "properties": {
                        "isApplicable": {"enum": [true]}
                    },
                    "required": ["isPerformed", "isRelevant"]
                }
            ]
        },

        {
            "anyOf": [
                {
                    "properties": {
                        "isPerformed": {"enum": [false]}
                    }
                },
                {
                    "properties": {
                        "isPerformed": {"enum": [true]},
                        "date": {
                            "required": ["searched"]
                        }
                    },
                    "required": ["date"]
                }
            ]
        },
        {
            "anyOf": [
                {
                    "properties": {
                        "isRelevant": {"enum": [false]}
                    }
                },
                {
                    "properties": {
                        "isRelevant": {"enum": [true]}
                    },
                    "required": ["details"]
                }
            ]
        }
    ]
}

References:

Used in:

{
    "isApplicable": false,

    "isPerformed": true,
    "date": {
        "searched": "1999-01-01"
    },

    "isRelevant": false,
    "details": "We found something relevant on page 34"
}

#/definitions/declarations/restrictionOrLimitation - Title Information 

{
    "title": "Title Information",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "isApplicable": {
            "type": "boolean",
            "title": "Has there been any limitation or restriction on the examination of title?"
        },
        "details": {
            "title": "Please provide further information which may be of relevance to this application",
            "type": "string",
            "pattern": "\\S+",
            "minLength": 1,
            "maxLength": 5000
        },
        "isSatisfactory": {
            "type": "boolean",
            "title": "Does the application relate to a prescriptive claimant?"
        },
        "isPrescribed": {
            "type": "boolean",
            "title": "Have the conditions of section 43 (prescriptive claimants) been met?"
        }
    },
    "allOf": [
        {
            "oneOf": [
                {
                    "properties": {
                        "isApplicable": {
                            "enum": [
                                false
                            ]
                        }
                    }
                },
                {
                    "properties": {
                        "isApplicable": {
                            "enum": [
                                true
                            ]
                        }
                    },
                    "required": [
                        "details"
                    ]
                }
            ]
        },
        {
            "oneOf": [
                {
                    "properties": {
                        "isSatisfactory": {
                            "enum": [
                                false
                            ]
                        }
                    }
                },
                {
                    "properties": {
                        "isSatisfactory": {
                            "enum": [
                                true
                            ]
                        }
                    },
                    "required": [
                        "isPrescribed"
                    ]
                }
            ]
        }
    ],
    "required": [
        "isApplicable",
        "isSatisfactory"
    ]
}

References:

Used in:

{
    "isApplicable": true,
    "details": "There is a restriction on the proprietor",
    "isSatisfactory": false,
    "isPrescribed": true
}

#/definitions/declarations/rules - Declaration field data dependencies

This schema attempts to explain some of the dependent fields in the declaration section. It is intended to be interpreted in the context of an application entity.

This is not intended to be used as a stand alone entity

{
    "title": "Declaration field data dependencies",
    "allOf": [
        {
            "title": "Certification requirements",
            "anyOf": [
                {
                    "properties": {
                        "type": {"properties": {
                            "code": {"enum": ["vr"]}
                        }},

                        "declarations": {"properties": {
                            "certification": {
                                "required": ["isSatisfactory", "isUnregisteredPlot"]
                            }}
                        }
                    }
                },
                {
                    "properties": {
                        "type": {"properties": {
                            "code": {"not": {"enum": ["vr"]}}
                        }},

                        "declarations": {"properties": {
                            "certification": {
                                "required": ["isDeedSatisfactory"]
                            }
                        }}
                    }
                }
            ]
        }
    ]
}

References:

Used in:


#/definitions/declarations/securitiesSearch - Heritable Securities 

{
    "title": "Heritable Securities",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "isApplicable": {
            "type": "boolean",
            "title": "Has a search been carried out in the General Register of Sasines to determine if there are any outstanding heritable securities affecting the plot of land?"
        },
        "date": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "searched": {
                    "type": "string" ,
                    "format": "date-time",
                    "title": "Please provide the date to which the last search was certified"
                }
            }
        },
        "isRelevant": {
            "type": "boolean",
            "title": "Is the plot of ground affected by an outstanding heritable security?"
        },
        "details": {
            "title": "Details of Deed",
            "type": "string",
            "pattern": "\\S+",
            "minLength": 1
        }
    },

    "anyOf": [
        {
            "properties": {
                "isApplicable": {"enum": [false]}
            }
        },
        {
            "properties": {
                "isApplicable": {"enum": [true]},
                "date": {
                    "required": ["searched"]
                }
            },
            "required": ["isRelevant", "date"]
        }
    ],

    "required": ["isApplicable"]
}

References:

Used in:

{
    "isApplicable": true,
    "date": {
        "searched": "1999-01-01"
    },
    "isRelevant": false
}

#/definitions/declarations/servitudes - Servitudes 

{
    "title": "Servitudes",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "isPlotRelatedServitudes": {
            "type": "boolean",
            "title": "Are there any servitude rights created in deeds, which benefit the plot of ground, that are not referred to or narrated in the deed to which this application relates (for example in a split-off/break-off-deed)?"
        },
        "details": {
            "title": "Provide details of the servitude right(s)",
            "type": "string",
            "pattern": "\\S+",
            "minLength": 1
        },
        "creationType": {
            "type": "boolean",
            "title": "Are there any servitude rights referred to or narrated in the deed to which this application relates, that no longer benefit the plot of ground?"
        },
        "creationTypeDetails": {
            "title": "Provide details of which servitude right(s) no longer benefits the plot of ground",
            "type": "string",
            "pattern": "\\S+",
            "minLength": 1,
            "maxLength": 5000
        },
        "servitudeNoLongerBenefits": {
            "type": "boolean",
            "title": "Have any servitude rights which benefit the plot of ground been created by prescription?"
        },
        "servitudeNoLongerBenefitsDetails": {
            "title": "Provide details of the prescriptive servitude(s)",
            "type": "string",
            "pattern": "\\S+",
            "minLength": 1,
            "maxLength": 5000
        }
    },
    "allOf": [
        {
            "oneOf": [
                {
                    "properties": {
                        "creationType": {
                            "enum": [
                                false
                            ]
                        }
                    }
                },
                {
                    "properties": {
                        "creationType": {
                            "enum": [
                                true
                            ]
                        }
                    },
                    "required": [
                        "creationTypeDetails"
                    ]
                }
            ]
        },
        {
            "oneOf": [
                {
                    "properties": {
                        "servitudeNoLongerBenefits": {
                            "enum": [
                                false
                            ]
                        }
                    }
                },
                {
                    "properties": {
                        "servitudeNoLongerBenefits": {
                            "enum": [
                                true
                            ]
                        }
                    },
                    "required": [
                        "servitudeNoLongerBenefitsDetails"
                    ]
                }
            ]
        }
    ],
    "required": [
        "isPlotRelatedServitudes",
        "creationType",
        "servitudeNoLongerBenefits"
    ]
}

References:

Used in:

{
    "isPlotRelatedServitudes": false,
    "creationType": false,
    "servitudeNoLongerBenefits": true,
    "servitudeNoLongerBenefitsDetails": "Some details"
}

#/definitions/declarations/sharedPlots - Common Areas 

{
    "title": "Common Areas",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "isApplicable": {
            "type": "boolean",
            "title": "Does the deed being registered transfer any area of ground that is owned in common with another person or other persons?"
        },
        "isRegistered": {
            "type": "boolean",
            "title": "Has the area of ground been included in any registered title(s)?"
        },
        "titleNumber": {
            "type": "array",
            "minItems": 1,
            "maxItems": 500,
            "items": {"$ref": "#/definitions/titleNumber"},
            "title": "Please provide the title number(s)"
        }
    },

    "anyOf": [
        {
            "properties": {
                "isApplicable": {"enum": [false]}
            }
        },
        {
            "properties": {
                "isApplicable": {"enum": [true]},
                "isRegistered": {"enum": [false]}
            },

            "required": ["isRegistered"]
        },
        {
            "properties": {
                "isApplicable": {"enum": [true]},
                "isRegistered": {"enum": [true]}
            },

            "required": ["isRegistered", "titleNumber"]
        }
    ],

    "required": ["isApplicable"]
}

References:

Used in:

{
    "titleNumber": ["TST123", "TST124"],
    "isApplicable": true,
    "isRegistered": true
}

#/definitions/deed - Primary Deed

The deed section describes the main document that is being submitted with this application. This is the deed you want to register.

Other deeds which accompany the main deed are detailed as supporting deeds.

The main entities of interest are:

  • The type - The type of deed being registered (ignored for Voluntary Registrations). Certain deed types are only allowed for some application types (as listed by the metadata.applicationTypes field in the detailed picklist)
  • The subjects - A description of the plots of land affected by the registration.
  • The granters - The person granting the application; usually the seller (ignored for Voluntary Registrations).

The applicants (usually buyers) are attached to the main application entity.

Deed types

The deed types reference the lr/application/deed/type reference list which you can obtain from the Reference List service.

If you retrieve the detailed version of this list the metadata for each item lists which types of application the deed is valid for. This can be useful when presenting lists to users to prevent them from picking invalid combinations.

Granters

We do not require all of the fields it is possible to submit for a granter. For more guidance see required fields for Applicants and Granters.

{
    "title": "Primary Deed",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "type": {
            "allOf": [
                {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/codedValueOrOther"},
                {"properties": {
                    "code": {"format": "ref:lr/application/deed/type"}
                }}
            ]
        },
        "granter": {
            "type": "array",
            "minItems": 1,
            "items": {"$ref": "#/definitions/party"}
        },
        "subject": {
            "type": "array",
            "minItems": 1,
            "items": {"$ref": "#/definitions/subject"}
        }
    },

    "required": ["type", "subject"]
}

References:

Used in:

{
    "type": {
        "code": "26",
        "prettyPrint": "Assignation of Standard Security"
    },

    "subject": [
         {
            "address": {
                "name" : "Grimley Manor",
                "number" : "1F1",
                "town" : "ABERDEEN",
                "street" : "BRIGHTON PLACE",
                "county": "Fife",
                "country": {
                    "code": "GB"
                },
                "postcode" : "AB106RT",

                "prettyPrint": "117 BRIGHTON PLACE, ABERDEEN, AB106RT"
            },
            "reference": {
                "titleNumber": "FFE123",
                "searchSheet": {
                    "number": "123",
                    "county": {
                        "code": "ffe"
                    }
                },
                "developmentPlanApproval": {
                    "number": "1234",
                    "plotNumber": "5678"
                }
            },
            "date": {
                "entry": "2000-12-01T00:00:00Z"
            },
            "details": "A bit of land next to the bog"
        }
    ],

    "granter": [
        {
            "type": {
                "code": "non_natural"
            },

            "name": {
                "prefix": {
                    "code": "the",
                    "prettyPrint": "The"
                },
                "company": "Magic Co.",
                "prettyPrint": "The Magic Co."
            },

            "address" : {
                "name" : "A house",
                "postcode" : "EH56 0QY",
                "town": "Edinburgh",
                "prettyPrint": "A house, 23, 3F1, West Bromlinton St., Edinburgh, INVERURIE, UK, EH56 0QY, Lothian"
            },

            "reference": {
                "allocatedNumber": "97823475634"
            },

            "prettyPrint": "The Magic Co.\nA house, 23, 3F1, West Bromlinton St., Edinburgh, INVERURIE, UK, EH56 0QY, Lothian"
        }
    ]
}

#/definitions/metadata - Application metadata

The metadata contains most of the feedback about the status of an application.

The main fields are:

  • status - Is the application in valid, invalid or finalised (ready for submission, and no longer editable)
  • source - Shows whether the last update to the application was through the API or the user interface
  • validation.isValid - Is the application valid according to the schema and rules? If not errors will be displayed

Finalizing an application

In order to prepare a form to be printed and posted to Registers of Scotland, it must be finalised so that no more editing is possible. This is to give us confidence that the paper copy and the electronic copy are the same.

  • You do this by setting the metadata.status.code to finalised when sending data to the service
  • You cannot set any other fields in the metadata
  • You can only finalise a valid application
  • If you attempt to finalise an invalid application: You will get an application status error if your application is invalid You will not be able to see the validation messages ** These messages can still be retrieved using the GET method
{
    "title": "Application metadata",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "status": {
            "allOf": [
                {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#codedValue"},
                {"properties": {
                    "code": {"enum": ["valid", "invalid", "finalised"]}
                }}
            ]
        },

        "source": {
            "allOf": [
                {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#codedValue"},
                {"properties": {
                    "code": {"enum": ["ui", "api"]}
                }}
            ]
        },

        "validation": {
            "type": "object",
            "additionalProperties": false,

            "properties": {
                "isValid": {"type": "boolean"},
                "error": {
                    "type": "array",
                    "items": {"$ref": "#/definitions/validationError"}
                }
            },
            "required": ["isValid"]
        }
    }
}

References:

Used in:

{
    "status": {
        "code": "invalid",
        "prettyPrint": "Invalid"
    },

    "source": {
        "code": "ui",
        "prettyPrint": "UI"
    },

    "validation": {
        "isValid": false,
        "error": [
            {
                "field": "deed.type.code",
                "message": "Field is not an acceptable value"
            }
        ]
    }
}

#/definitions/party - Application Party

A Land Register application party.

{
    "title": "Application Party",
    "allOf": [
        {
            "$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/party"
        },
        {
            "required": ["address"],
            "properties": {
                "address": {
                    "properties": {
                         "town": {
                             "minLength": 1,
                             "pattern": "\\S+"
                         }
                    },
                    "required": ["town"]
                }
            }
        },
        {
            "anyOf": [
                {
                    "properties": {
                        "type": {
                            "properties": {
                                "code": {
                                    "enum": ["non_natural"]
                                }
                            }
                        }
                    }
                },
                {
                    "properties": {
                        "type": {
                            "properties": {
                                "code": {
                                    "enum": ["non_natural_uk"]
                                }
                            }
                        },
                        "reference": {
                            "required": ["ukCompanyNumber"]
                        }
                    },
                    "required": ["reference"]
                },
                {
                    "properties": {
                        "type": {
                            "properties": {
                                "code": {
                                    "enum": ["natural"]
                                }
                            }
                        },
                        "name": {
                            "properties": {
                                "first": {
                                    "minLength": 1,
                                    "pattern": "\\S+"
                                }
                            },
                            "required": ["first", "last"]
                        }
                    },
                    "required": ["name"]
                }
            ]
        }
    ]
}

References:

Used in:

{
    "type": {
        "code": "non_natural"
    },
    "name": {
        "prefix": {
            "code": "the",
            "prettyPrint": "The"
        },
        "company": "Magic Co.",
        "prettyPrint": "The Magic Co."
    },
    "address": {
        "town": "My Town"
    }
}

#/definitions/payment - Payment Instructions

The payment section gives details of how you will be paying for the registration.

  • fasNumber is required. If it does not allow payments for the specified method, a ValidationError will be returned.
  • fee.amount should not be submitted; it will be automatically calculated from the fee.basis.
  • fee.basis and children are generally required for conveyance deeds (for example dispositions or leases), and first and voluntary registrations. It is not required for deeds which attract a fixed-fee per subject. The rules governing this are not expressed in this schema, but processed by an internal validation engine. For further information, see the Test pack (file features/api/application/processing_instructions/payment/fee.feature).
{
    "title": "Payment Instructions",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "fasNumber": {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/fasNumber"},
        "method": {"allOf": [
            {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/codedValue"},
            {"properties": {
                "code": {
                    "enum": ["dd", "ch"],
                    "format": "ref:payment/method"
                }
            }}
        ]},

        "fee": {
            "type": "object",
            "additionalProperties": false,

            "properties": {
                "amount": {"type": "number"},
                "basis": {
                    "type": "object",
                    "additionalProperties": false,

                    "properties": {
                        "consideration": {
                            "type": "object",
                            "properties": {
                                "monetary": {
                                    "type": "number",
                                    "minimum": 0.01
                                },
                                "nonMonetary": {"allOf": [
                                    {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/codedValueOrOther"},
                                    {"properties": {
                                        "code": {"format": "ref:lr/application/fee/basis/consideration/non-monetary"}
                                    }}
                                ]}
                            }
                        },
                        "annualRent": {"type": "number"},
                        "monetaryValue": {"type": "number"},
                        "isVRSecurityDiscountApplicable": {
                            "type": "boolean",
                            "title": "Are you also submitting an application for a Standard Security affecting the same extent as the plot for which voluntary registration is sought?"

                        }
                    }
                }
            }

        }
    },
    "required": ["fasNumber", "method"]
}

References:

Used in:

{
    "fasNumber": "1145",
    "method": {"code": "dd"},

    "fee": {
        "amount": 30.0,
        "basis": {
            "consideration": {
                "monetary": 50000,
                "nonMonetary": {"code": "love_etc"}
            },
            "annualRent": 1200,
            "monetaryValue": 250000,
            "isVRSecurityDiscountApplicable": false
        }
    }
}

#/definitions/rules - Data dependencies

This schema attempts to explain some of the dependent fields. It is intended to be interpreted in the context of an application entity.

This is not intended to be used as a stand alone entity

{
    "title": "Data dependencies",
    "allOf": [
        {
            "title": "Voluntary registration payment discount",
            "oneOf": [
                {
                    "properties": {
                        "type": { "properties": {
                               "code": {"not": {"enum": ["vr"]}}
                        }}
                    }
                },
                {
                    "properties": {
                        "type": { "properties": {
                            "code": {"enum": ["vr"]}
                        }},

                        "processingInstructions": { "properties": {
                            "payment": { "properties": {
                                "fee": { "properties": {
                                    "basis": {
                                        "required": ["isVRSecurityDiscountApplicable"]}
                                }}
                            }}
                        }}
                    }
                }
            ]
        },
        {
            "title": "Voluntary registration granter not required",
            "oneOf": [
                {
                    "properties": {
                        "type": { "properties": {
                               "code": {"not": {"enum": ["vr"]}}
                        }},

                        "deed": {
                            "required": ["granter"]
                        }
                    }
                },
                {
                    "properties": {
                        "type": { "properties": {
                            "code": {"enum": ["vr"]}
                        }}
                    }
                }
            ]
        },
        {
            "title": "Registered / unregistered title dependencies",
            "oneOf": [
                {
                    "properties": {
                        "type": { "properties": {
                            "code": {"enum": ["dw"]}
                        }}
                    }
                },
                {
                    "properties": {
                        "type": { "properties": {
                               "code": {"enum": ["tp"]}
                        }},
                        "deed": { "properties": {
                            "subject": { "items": { "properties": {
                                "reference": { "required": ["titleNumber"] }
                            }}}
                        }}
                    }
                },
                {
                    "properties": {
                        "type": { "properties": {
                            "code": {"enum": ["apr", "fr", "vr"]}
                        }},
                        "deed": { "properties": {
                            "subject": { "items": { "properties": {
                                "reference": { "required": ["searchSheet"] }
                            }}}
                        }}
                    }
                }
            ]
        }
    ]
}

References:

Used in:


#/definitions/subject - Subject

The subject describes a plot of land. Ideally this will be a title that has already been registered, but in other cases a textual description may be necessary.

Field notes

  • details - If the plot has no title or address yet, then a textual description can be provided. In certain cases this may need to be provided to describe a specific part of an existing title.

  • reference.titleNumber - An LR title number, if available:

    • it must be supplied if the application type is TP (Deed over part of a registered plot)
    • it should be supplied if the application type is DW (Deed over the whole of a registered plot), unless the plot is undergoing registration and has not yet been allocated a title number. In this event, you must supply the full postal address of the plot (see field address below)

  • reference.searchSheet.county and reference.searchSheet.number - A Sasines search sheet county and number (mostly for First and Voluntary Registrations)

  • reference.developmentPlanApproval.number and reference.developmentPlanApproval.plotNumber - Development Plan Approval numbers, used when property developers register plots which have been pre-approved with RoS
  • address - This is always required unless reference.titleNumber is supplied and the application type is a DW (Dealing on the whole of a registered plot). In this specific case, if address is not supplied, we attempt to pre-populate the field with the registered title address
{
    "title": "Subject",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "address": {
            "allOf": [
                {
                    "$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/structuredAddress"
                },
                {
                    "properties": {
                         "town": {
                             "minLength": 1,
                             "pattern": "\\S+"
                         }
                    },
                    "required": ["town"]
                }
            ]
        },

        "reference": {
            "type": "object",
            "additionalProperties": false,

            "properties": {
                "titleNumber": {"$ref": "#/definitions/titleNumber"},

                "searchSheet": {
                    "type": "object",
                    "additionalProperties": false,

                    "properties": {
                        "county": {
                            "allOf": [
                                {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/codedValue"},
                                {"properties": {
                                    "code": {"format": "ref:lr/county"}
                                }}
                            ]
                        },
                        "number": {"type": "string"}
                    },

                    "required": ["county"]
                },

                "developmentPlanApproval": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "number": {"type": "string"},
                        "plotNumber": {"type": "string"}
                    },
                    "required": ["number", "plotNumber"]
                }
            }
        },

        "date": {
            "type": "object",
            "additionalProperties": false,

            "properties": {
                "entry": {"type": "string", "format": "date-time"}
            }
        },

        "details": {"type": "string"}
    },
    "required": ["address"]
}

References:

Used in:

 {
    "address": {
        "name" : "Grimley Manor",
        "number" : "1F1",
        "town" : "ABERDEEN",
        "street" : "BRIGHTON PLACE",
        "county": "Fife",
        "country": {
            "code": "GB"
        },
        "postcode" : "AB106RT",

        "prettyPrint": "117 BRIGHTON PLACE, ABERDEEN, AB106RT"
    },
    "reference": {
        "titleNumber": "FFE123",
        "searchSheet": {
            "number": "123",
            "county": {
                "code": "ffe"
            }
        },
        "developmentPlanApproval": {
            "number": "1234",
            "plotNumber": "5678"
        }
    },
    "date": {
        "entry": "2000-12-01T00:00:00Z"
    },
    "details": "A bit of land next to the bog"
}

#/definitions/supportingDeed - Supporting Deed

A supporting deed indicates another document which is either:

  • Attached and posted in along with the main deed
  • Or can be sufficiently well described to allow RoS staff to find it

Each supporting deed should be providing evidence for a particular piece of information. This is indicated in the has section. For example if a supporting deed includes a plan, then the has.plan field should be completed.

Grantees

We do not require all of the fields it is possible to submit for a grantee.

Although there are potentially many grantees for a deed, at present we only inspect the first, and only to get the name

You should fill out:

  • grantee:0.type
  • grantee:0.name

Field notes

  • The has* fields indicate why this deed was included
  • isAttached indicates that the document will be posted in along side the other documents
  • If isAttached is false, this means RoS already has the document. In this case the user is expected to provide sufficient information for RoS staff to locate the deed
{
    "title": "Supporting Deed",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "isAttached": {"type": "boolean"},
        "details": {
            "type": "string",
            "pattern": "\\S+",
            "minLength": 1
        },

        "type": {
            "allOf": [
                {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/codedValueOrOther"},
                {"properties": {
                    "code": {
                        "anyOf": [
                            {"format": "ref:lr/application/deed/type"},
                            {"format": "ref:lr/application/deed/type/extended"}
                        ]
                    }
                }}
            ]
        },

        "has": {
            "type": "object",
            "additionalProperties": false,

            "properties": {
                "burden": {"type": "boolean"},
                "security": {"type": "boolean"},
                "servitude": {"type": "boolean"},
                "plan": {"type": "boolean"}
            }
        },

        "date": {
            "type": "object",
            "additionalProperties": false,

            "properties": {
                "recording": {"type": "string", "format": "date-time"}
            }
        },

        "grantee": {
            "type": "array",
            "items": {"$ref": "http://developers.ros.gov.uk/schema/common/schema.json#/party"}
        }
    },

    "oneOf": [
        {
            "properties": {
                "isAttached": {"enum": [true]}
            }
        },
        {
            "properties": {
                "isAttached": {"enum": [false]}
            },
            "required": ["details"]
        }
    ],

    "required": ["has", "isAttached", "type"]
}

References:

Used in:

{
    "type": {
        "code": "38",
        "prettyPrint": "SDLT certificate"
    },
    "has": {
        "burden": false,
        "security": false,
        "servitude": true,
        "plan": false
    },
    "isAttached": false,
    "details": "I'm a deed",
    "date": {
        "recording": "2000-12-01T00:00:00Z"
    },
    "grantee": [
        {
            "type": {"code": "natural"},
            "name": {
                "prefix": {
                    "code": "sir",
                    "prettyPrint": "Sir"
                },
                "first": "Very",
                "last": "Example"
            },
            "prettyPrint": "Sir Very Example"
        }
    ]
}

#/definitions/titleNumber - Title number

A Land Register title number.

This number is formed of two parts:

  • A three digit county code (i.e. FFE for Fife)
  • A running number

Although the pattern states that any three letter code will do, only valid county codes are acceptable. In addition some valid patterns are not valid title numbers.

{
    "title": "Title number",
    "type": "string",
    "format": "lrTitleNumber",
    "pattern": "^[A-Z]{3}\\d+$"
}

References:

Used in:

"FFE1223"

#/definitions/validationError - Validation error

An entity representing an error in the data submitted. This can be from:

  • Examples where the schema hasn't been followed
  • Items where data that only the service can check is incorrect
  • Items where the schema has been followed, but logical errors remain
  • Other rules and checks provided by the service

Validation codes

Currently there are several different types of errors generated:

  • SchemaError - Violations of the JSON schema. These errors will include a field value that maps to the data sent to us. The messages from this system are typically useful.
  • ValidationError - Additional validation errors not expressible in the JSON schema. For example, some fields are mandatory based on the values chosen in other fields.
  • LegacyValidationError - Secondary checks performed on a transformed structure. As a result of the transform the field returned is indicative, but not directly related to the schema. The messages from this system are typically not useful.
  • AutoPopulationError - Due to a structural error, some fields which are normally provided by the service have not been filled in. You may see additional errors relating to these fields which you are not expected to provide
{
    "title": "Validation error",
    "type": "object",
    "additionalProperties": false,

    "properties": {
        "field": {"type": "string"},
        "code": {"type": "string"},
        "message": {"type": "string"},
        "schema": {"type": "object"},
        "schemaPath": {"type": "string"}
    },

    "required": ["message"]
}

References:

Used in:

{
    "field": "deed.type.code",
    "message": "Field is not an acceptable value"
}


Is there anything wrong with this page?