API docs by Redocly

V1.1 'Submit an application to change the Land Register API' Schema (1.1.0)

Download OpenAPI specification:

V1.1 of the set of APIs for the new 'Submit an application to change the Land Register API' Schema

Submit an application API

submit_an_application_to_change_the_register_v1

Submit an application API - Submit application creation requests for processing

Authorizations:
basic_auth
header Parameters
Idempotency-Key
required
string
Request Body schema: application/json
required
required
object (SubstantiveApplicationData)

The data required to capture an application

Responses

Request samples

Content type
application/json
{
  • "data": {
    • "additional_provider_filter": "string",
    • "addresses": {
      • "property1": {
        • "details": {
          • "type": "UK",
          • "care_of_name": "string",
          • "number": "string",
          • "service_number_rank": "string",
          • "unit_regiment": "string"
          }
        },
      • "property2": {
        • "details": {
          • "type": "UK",
          • "care_of_name": "string",
          • "number": "string",
          • "service_number_rank": "string",
          • "unit_regiment": "string"
          }
        }
      },
    • "applicants": [
      • "string"
      ],
    • "application_lodger": {
      • "email": "string",
      • "telephone": "string",
      • "type": "CONVEYANCER"
      },
    • "customer_reference": "string",
    • "disagree_with_validation_results": [
      • {
        • "comment": "string",
        • "reason": "DISAGREE_WITH_REGISTER",
        • "validation_pointer": "string",
        • "validation_type": "string"
        }
      ],
    • "documents": {
      • "property1": {
        • "document_id": "string",
        • "document_metadata": {
          • "certification_statement_type": "CERTIFIED",
          • "document_filename": "string"
          },
        • "type": "ABSTRACT",
        • "companies_house_certification": true
        },
      • "property2": {
        • "document_id": "string",
        • "document_metadata": {
          • "certification_statement_type": "CERTIFIED",
          • "document_filename": "string"
          },
        • "type": "ABSTRACT",
        • "companies_house_certification": true
        }
      },
    • "jp1_reference": "strings",
    • "parties": {
      • "property1": {
        • "address_for_service_option": "PROVIDED_ADDRESS",
        • "addresses": [
          • "string"
          ],
        • "details": {
          • "type": "PRIVATE_INDIVIDUAL",
          • "organisation_name": "string"
          },
        • "identity_evidence_type": "EVIDENCE",
        • "other_conveyancer": {
          • "address_reference": "string",
          • "conveyancer_reference": "string",
          • "full_name": "string"
          },
        • "representation_type": "LODGING_CONVEYANCER"
        },
      • "property2": {
        • "address_for_service_option": "PROVIDED_ADDRESS",
        • "addresses": [
          • "string"
          ],
        • "details": {
          • "type": "PRIVATE_INDIVIDUAL",
          • "organisation_name": "string"
          },
        • "identity_evidence_type": "EVIDENCE",
        • "other_conveyancer": {
          • "address_reference": "string",
          • "conveyancer_reference": "string",
          • "full_name": "string"
          },
        • "representation_type": "LODGING_CONVEYANCER"
        }
      },
    • "submission_warning_understood": true,
    • "titles": {
      • "property1": {
        • "disclosable_overriding_interests": true,
        • "property_address": {
          • "building_description": "string",
          • "care_of_name": "string",
          • "county": "string",
          • "department_name": "string",
          • "dependent_locality": "string",
          • "dependent_street": "string",
          • "double_dependent_locality": "string",
          • "organisation_name": "string",
          • "post_town": "string",
          • "postcode": "string",
          • "street": "string",
          • "sub_building_description": "string",
          • "type": "UK",
          • "uprn": 1
          },
        • "scope_details": {
          • "part_description": "string",
          • "scope": "WHOLE"
          },
        • "search_reference": "stringstr",
        • "title_number": "string",
        • "title_type": "REGISTER_TITLE"
        },
      • "property2": {
        • "disclosable_overriding_interests": true,
        • "property_address": {
          • "building_description": "string",
          • "care_of_name": "string",
          • "county": "string",
          • "department_name": "string",
          • "dependent_locality": "string",
          • "dependent_street": "string",
          • "double_dependent_locality": "string",
          • "organisation_name": "string",
          • "post_town": "string",
          • "postcode": "string",
          • "street": "string",
          • "sub_building_description": "string",
          • "type": "UK",
          • "uprn": 1
          },
        • "scope_details": {
          • "part_description": "string",
          • "scope": "WHOLE"
          },
        • "search_reference": "stringstr",
        • "title_number": "string",
        • "title_type": "REGISTER_TITLE"
        }
      },
    • "transactions": {
      • "property1": {
        • "details": {
          • "type": "string",
          • "full_value_of_property": 0,
          • "full_value_of_property_band": {
            • "lower_value_band": 0,
            • "upper_value_band": 100000
            },
          • "outstanding_charge": 0,
          • "value": 0,
          • "value_band": {
            • "lower_value_band": 0,
            • "upper_value_band": 100000
            }
          },
        • "documents": [
          • "string"
          ],
        • "fee_in_pence": 0,
        • "party_roles": [
          • {
            • "attorneys": [
              • "string"
              ],
            • "capacity": "REGISTERED_PROPRIETOR",
            • "party_reference": "string",
            • "role": "ATTORNEY"
            }
          ],
        • "priority": 1,
        • "relates_to_new_title": true,
        • "title_references": [
          • "string"
          ],
        • "type": "ADV1"
        },
      • "property2": {
        • "details": {
          • "type": "string",
          • "full_value_of_property": 0,
          • "full_value_of_property_band": {
            • "lower_value_band": 0,
            • "upper_value_band": 100000
            },
          • "outstanding_charge": 0,
          • "value": 0,
          • "value_band": {
            • "lower_value_band": 0,
            • "upper_value_band": 100000
            }
          },
        • "documents": [
          • "string"
          ],
        • "fee_in_pence": 0,
        • "party_roles": [
          • {
            • "attorneys": [
              • "string"
              ],
            • "capacity": "REGISTERED_PROPRIETOR",
            • "party_reference": "string",
            • "role": "ATTORNEY"
            }
          ],
        • "priority": 1,
        • "relates_to_new_title": true,
        • "title_references": [
          • "string"
          ],
        • "type": "ADV1"
        }
      },
    • "type": "REGISTER_UPDATE"
    }
}

Response samples

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

Download a document API

download_a_document_v1

Request the download link for a document. Currently only supports the download of documents HMLR despatches, i.e correspondence, cancellation and completion documents.

Authorizations:
basic_auth
path Parameters
document_id
required
string

May also be referred to as the download_id by some services

Responses

Response samples

Content type
{
  • "type": "about:blank",
  • "title": "Server Error",
  • "detail": "There was a problem with your request, try again soon.",
  • "instance": "https://api.example.com/path/you/called",
  • "status": 500,
  • "errors": [
    • {
      • "detail": "Date must be in the past",
      • "pointer": "#/data/name",
      • "header": "Idempotency-Key",
      • "parameter": "occurred_before"
      }
    ]
}

Send a document API

send_a_document_v1

Create an upload URL - Retrieve a generated document upload URL. For more details see our Technical Guide

Authorizations:
basic_auth
Request Body schema: application/json
required
required
object (DocumentUploadUrlData)

Responses

Request samples

Content type
application/json
{
  • "data": {
    • "document_type": "ABSTRACT",
    • "additional_provider_filter": "string",
    • "file_length": 1,
    • "file_sha256": ""
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "upload_url": "about:blank",
    • "document_id": "12345678-1234-1234-1234-1234-123456789abc"
    }
}

Application information API

get_application_information_v1

Can return status, fees and correspondence documents for an application

Authorizations:
basic_auth
path Parameters
application_request_id
required
string

The ID returned by Application Creation to track submission requests

Responses

Response samples

Content type
application/json
{
  • "data": {
    • "application_request_id": "string",
    • "correspondences": [
      • {
        • "documents": [
          • {
            • "created_at": "string",
            • "download_id": "string",
            • "type": {
              • "code": "string",
              • "name": "string"
              }
            }
          ],
        • "hmlr_reference": "string",
        • "record_id": "1234567",
        • "title_no": "string"
        }
      ],
    • "errors": [
      • {
        • "type": "L2_MDREF_ERROR",
        • "detail": "The MDref included in the request does not exist",
        • "pointer": "/data/transaction/t1/mdref"
        }
      ],
    • "hmlr_reference": "string",
    • "priority_timestamp": "2019-08-24T14:15:22Z",
    • "status": "string",
    • "warnings": [
      • "string"
      ]
    }
}

Attach a document

attach_a_document_v1

Attach a document from Send a Document to an existing application

Authorizations:
basic_auth
path Parameters
application_request_id
required
string

The ID returned by Application Creation to track submission requests

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    • "certification_statement_type": "CERTIFIED",
    • "document_id": "12345678-1234-1234-1234-123456789abc"
    }
}

Response samples

Content type
application/json
{
  • "type": "about:blank",
  • "title": "Server Error",
  • "detail": "There was a problem with your request, try again soon.",
  • "instance": "https://api.example.com/path/you/called",
  • "status": 500,
  • "errors": [
    • {
      • "detail": "Date must be in the past",
      • "pointer": "#/data/name",
      • "header": "Idempotency-Key",
      • "parameter": "occurred_before"
      }
    ]
}

Attach a message

attach_a_message_v1

Application information API - Get the information about an application

Authorizations:
basic_auth
path Parameters
application_request_id
required
string

The ID returned by Application Creation to track submission requests

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "about:blank",
  • "title": "Server Error",
  • "detail": "There was a problem with your request, try again soon.",
  • "instance": "https://api.example.com/path/you/called",
  • "status": 500,
  • "errors": [
    • {
      • "detail": "Date must be in the past",
      • "pointer": "#/data/name",
      • "header": "Idempotency-Key",
      • "parameter": "occurred_before"
      }
    ]
}

Notifications API

get_notifications_v1

Receive notifications API - Get any unacknowledged notifications

Authorizations:
basic_auth
query Parameters
status
string
Enum: "NEW" "ACKNOWLEDGED"

Status of the notifications - Either NEW or ACKNOWLEDGED. Default is NEW

additional_provider_filter
string or null [ 1 .. 50 ] characters

The Additional Provider filter used by the Provider

subject
string [ 0 .. 128 ] characters ^[A-Za-z0-9._@ -]*$

The Subject of the notification - this is currently the application_request_id

subject_type
string [ 0 .. 64 ] characters ^[A-Za-z0-9._@ -]*$
Default: ""

The type of Subject for the notification - currently only APPLICATION is available

notification_type
string [ 0 .. 255 ] characters ^[A-Za-z0-9._@ -]*$

The type of notification to search for

created_after
string <date-time>

Search for notifications with a created_timestamp after this date and time

created_before
string <date-time>

Search for notifications with a created_timestamp before this date and time

occurred_after
string <date-time>

Search for notifications with an event_timestamp after this date and time

occurred_before
string <date-time>

Search for notifications with an event_timestamp before this date and time

limit
integer <int32>

The maximum number of notifications to return in a single response

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    • {
      • "notification_id": "0d265b8c-bcff-4677-b6c3-81b1010c21bc",
      • "created_datetime": "2026-04-16T10:22:30.753Z",
      • "event_datetime": "2026-04-16T10:22:30.715Z",
      • "payload_schema": "https://landregistry.github.io/bgtechdoc/schemas/v1/application/accepted-priority-pending.json",
      • "notification_type": "application.accepted-priority-pending",
      • "subject_type": "APPLICATION",
      • "subject": "373e569c-a5bf-4319-9c02-2309529461cf",
      • "additional_provider_filter": "null",
      • "status": "NEW",
      • "payload": {
        • "data": {
          • "status": "ACCEPTED_AWAITING_PRIORITY"
          }
        }
      }
    ]
}

acknowledge_notifications_v1

Acknowledge notifications API - Acknowledge notifications that have been processed, so they are no longer returned when fetching

Authorizations:
basic_auth
Request Body schema: application/json
required
data
required
Array of strings <uuid> [ 1 .. 100 ] items [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "data": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    • "data": {
      • "acknowledged": [
        • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
      • "not_found": [
        • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ]
      }
    }
}