API docs by Redocly

V2.0 'Submit an application to change the Land Register API' Schema (2.0.0)

Download OpenAPI specification:

V2.0 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 Deprecated

Submit an application API - Submit application creation requests for processing. Will be deprecated in favour of Submit an application API v2 on 6th April 2027

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

additional_provider_filter
string [ 0 .. 50 ] characters ^\w*$

A value that can be used to subsequently retrieve request responses based upon high level grouping

object

A map of address references to addresses

applicants
Array of strings[ items [ 1 .. 50 ] characters ^[A-Za-z0-9-?,_]+$ ]

The party or parties who the application is being submitted for.

required
object (ApplicationLodger)

Information about the person lodging the application (This is usually the conveyancer lodging on behalf of an individual)

customer_reference
required
string [ 0 .. 25 ] characters

A short name/reference a customer has given to the application

Array of objects (ValidationDisagreement)

A list of instances for which the user disagrees with validation errors

object

A map of document references to documents

jp1_reference
string = 7 characters ^([a-zA-Z0-9]*)$

The JP1 reference to use when removing a JP1 restriction

object

A map of party references to parties

submission_warning_understood
required
boolean

Setting this value to true notes you have understood the following:
WARNING
Section 77 of the Land Registration Act 2002 imposes a duty not to apply for the entry of a restriction without reasonable cause; anyone in breach of this duty may be liable in damages to anyone who suffers loss in consequence.
If you dishonestly enter information or make a statement that you know is, or might be, untrue or misleading, and intend by doing so to make a gain for yourself or another person, or to cause loss or the risk of loss to another person, you may commit the offence of fraud under section 1 of the Fraud Act 2006, the maximum penalty for which is 10 years’ imprisonment or an unlimited fine, or both.
Failure to complete this form with proper care may result in a loss of protection under the Land Registration Act 2002 if, as a result, a mistake is made in the register.
Under section 66 of the Land Registration Act 2002 most documents (including this form) kept by the registrar relating to an application to the registrar or referred to in the register are open to public inspection and copying. If you believe a document contains prejudicial information, you may apply for that part of the document to be made exempt using Form EX1, under rule 136 of the Land Registration Rules 2003.

required
object [ 1 .. 199 ] properties

A map of title references to titles

required
object non-empty

A map of transaction references to transactions

type
required
string
Enum: "REGISTER_UPDATE" "TRANSFER_OF_PART" "DISPOSITIONARY_FIRST_LEASE" "REMOVE_JP1"

The type of application to submit

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"
          },
        • "register_action": "AMEND",
        • "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"
          },
        • "register_action": "AMEND",
        • "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"
    }
}

Submit an application API V2

submit_an_application_to_change_the_register_v2

Accept substantive application creation requests for processing

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

The data required to capture an application

additional_provider_filter
string [ 0 .. 50 ] characters ^\w*$

A value that can be used to subsequently retrieve request responses based upon high level grouping

object

A map of address references to addresses

applicants
Array of strings[ items [ 1 .. 50 ] characters ^[A-Za-z0-9-?,_]+$ ]

The party or parties who the application is being submitted for.

required
object (ApplicationLodgerV2)

Information about the person lodging the application (This is usually the conveyancer lodging on behalf of an individual)

customer_reference
required
string [ 0 .. 25 ] characters

A short name/reference a customer has given to the application

Array of objects (ValidationDisagreement)

A list of instances for which the user disagrees with validation errors

object

A map of document references to documents

jp1_reference
string = 7 characters ^([a-zA-Z0-9]*)$

The JP1 reference to use when removing a JP1 restriction

object

A map of party references to parties

submission_warning_understood
required
boolean

Setting this value to true notes you have understood the following:
WARNING
Section 77 of the Land Registration Act 2002 imposes a duty not to apply for the entry of a restriction without reasonable cause; anyone in breach of this duty may be liable in damages to anyone who suffers loss in consequence.
If you dishonestly enter information or make a statement that you know is, or might be, untrue or misleading, and intend by doing so to make a gain for yourself or another person, or to cause loss or the risk of loss to another person, you may commit the offence of fraud under section 1 of the Fraud Act 2006, the maximum penalty for which is 10 years’ imprisonment or an unlimited fine, or both.
Failure to complete this form with proper care may result in a loss of protection under the Land Registration Act 2002 if, as a result, a mistake is made in the register.
Under section 66 of the Land Registration Act 2002 most documents (including this form) kept by the registrar relating to an application to the registrar or referred to in the register are open to public inspection and copying. If you believe a document contains prejudicial information, you may apply for that part of the document to be made exempt using Form EX1, under rule 136 of the Land Registration Rules 2003.

required
object [ 1 .. 199 ] properties

A map of title references to titles

required
object non-empty

A map of transaction references to transactions

type
required
string
Enum: "REGISTER_UPDATE" "TRANSFER_OF_PART" "DISPOSITIONARY_FIRST_LEASE" "REMOVE_JP1"

The type of application to submit

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"
          },
        • "register_action": "AMEND",
        • "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"
          },
        • "register_action": "AMEND",
        • "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",
          • "contractual_control_right_affects_transaction": "NOT_RELATED_TO_CCR"
          },
        • "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",
          • "contractual_control_right_affects_transaction": "NOT_RELATED_TO_CCR"
          },
        • "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
{
  • "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 Headers
location
string

URL to the document resource for download

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)
document_type
required
string
Enum: "ABSTRACT" "ACKAPU" "ADJAR" "ADJREVU" "ADMIN_LTRS" "ADV1" "ADV2" "AGREEMENT" "AMS1" "AN1" "AP1" "APPL_FRM" "APPOINTMENT_OF_TRUSTEE" "AS1" "AS2" "AS3" "ASSENT" "ASSIGNMENT" "BANKRUPTCY_COURT_ORDER" "BCA_TRUST" "BIRTH_CERT" "BOUND_PLAN" "CC" "CCD" "CERT_CON_CH" "CERT_DEATH" "CERT_RED_EX" "CERT_REG_CH" "CERT_S89" "CH1" "CH2" "CH3" "CHARG_ORD" "CHARGE" "CIVIL_CERT" "CM2" "CM5" "CM6" "CN1" "CNFRM_DTMN_LTA_LGHA" "CNFRM_NO_DEED_SUR" "CNFRM_NO_LTA_LGHA" "CNSNT_ADMIN_COURT" "COMP_DOC" "CONSENT" "CONST_COMP" "CONTR_RES" "CONV_CERT" "CONV_CERT_DEATH" "CONVEYANCE" "COR_CERT" "CORRES" "COSR" "COURT_ORD" "CRALIQ" "CRED_DEC" "CRED_RES" "CRT_FORM_7" "CRWALIQ" "DB" "DEATH_CERT" "DEBENTURE" "DEC_AB_NULL_MARR" "DEED" "DEED_POLL" "DEED_REG_DIS" "DEED_SUR" "DISCHARGE" "DJP" "DL" "DOP" "DRIVING_LICENCE" "DS1" "DS2" "DS3" "DS3_SHORT" "EOB" "EOL" "EVD_NO_RENEW" "EVIDENCE" "EV_OV_NAME_CHANGE" "EX1" "EX1A" "EX3" "FORM_600" "FORM_600CH" "FORM_DI" "FORM_JO" "FR1" "GENDER_CERT" "GVD" "HR1" "HR2" "HR4" "ID1" "ID2" "ID3" "ID4" "ID5" "ID_EV" "ID_FRM" "INDENTURE" "JP1" "K17_OR_K18" "K20" "K22" "K3" "K4" "LEASE" "LICENCE" "LIQ_CERT_1" "LIQ_CERT_2" "LIQ_CERT_3" "LIQ01" "LNDLD_CNSNT" "LONP" "LR_CORRES" "LTT" "MARR_CERT" "MEMO" "MORD" "MRTG_DEED" "NOD" "NOTICE_OF_APPOINTMENT" "ORD_DISS_NULL_CP" "OR_CERT_BE" "PASSPORT" "PLAN" "POA" "PROBATE" "PSS1" "REVERS_INT" "RN" "RX1" "RX2" "RX3" "RX4" "RXC" "RXCD" "SC" "SDLT" "SEV" "SHRF_RTN" "SIDE_LTR" "SOT" "SSALIQ" "SSA_TRUST" "STAT_DEC" "SUB_CHARGE" "TIB_CERT_BE" "TP1" "TP2" "TRUSTEE_COURT_ORDER" "TR1" "TR2" "TR4" "TR5" "TRANSFER" "TRUSTEE_RESOLUTION" "UN1" "UN2" "UN3" "UN4" "UT1" "VAR_CHARGE" "VAR_COV" "VAR_EAS" "VAR_LEASE" "VESTING_ORDER" "WCT" "WINDING_UP" "WIT_STATE"
additional_provider_filter
string [ 1 .. 300 ] characters

A value that can be used to subsequently retrieve request responses based upon high level grouping

file_length
required
integer <int64> [ 1 .. 41943040 ]

The file contents length in bytes

file_sha256
required
string = 44 characters
Default: ""

The checksum of file contents, as a base64 encoded string of the SHA-256 binary digest of the file, which should be 44 characters long. See the Business Gateway developer pack for detailed information on generating the correct SHA-256 hash

Responses

Response Schema: application/json
required
object (DocumentUploadUrlResponse)
upload_url
string

The URL used to upload the document. The request must be a PUT HTTP request, where the body of the request is the document that will be uploaded. This URL should only be used once

document_id
string

A unique id for this document, which should be used in the application submission request

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 Schema: application/json
object (ApplicationInformation)

Representation of an application with its details

Array of objects (CorrespondenceRecordInApplicationInformation)

A list of correspondence records on the application

Array of objects (ProblemDetails)

A list of errors that caused the application to not be accepted

hmlr_reference
string

The reference used by HM Land Registry to identify the application

priority_timestamp
string <date-time>

The priority date and time of when the application was accepted onto the day list

application_request_id
string

The ID of the application submission request

status
string
Enum: "VALIDATING" "SYSTEM_ERROR" "VALIDATION_FAILED" "ACCEPTED_AWAITING_PRIORITY" "ACCEPTED_PRIORITY_PROTECTED"
  • VALIDATING - The application is currently being processed.
  • SYSTEM_ERROR - There was an error creating the application, please retry the submission.
  • VALIDATION_FAILED - We have not accepted the application due to validation errors
  • ACCEPTED_AWAITING_PRIORITY - The application has passed validation, and will be accepted onto the day list when it reopens
  • ACCEPTED_PRIORITY_PROTECTED - The application has been accepted onto the day list
warnings
Array of strings

Warnings that need to be actioned before the application is processed by a caseworker, otherwise a requisition may be issued.

Response samples

Content type
application/json
{
  • "data": {
    • "application_request_id": "string",
    • "completion_data": {
      • "status": "PENDING",
      • "title_summary_data": [
        • {
          • "oc_summary_data": {
            • "charge": {
              • "charge_entry": [
                • {
                  • "charge_date": "string",
                  • "charge_id": "string",
                  • "charge_proprietor": {
                    },
                  • "registered_charge": {
                    }
                  }
                ]
              },
            • "document_details": {
              • "document": [
                • {
                  • "document_date": "string",
                  • "document_type": "string",
                  • "entry_number": [
                    ],
                  • "plan_only_indicator": "string",
                  • "register_description": "string"
                  }
                ]
              },
            • "price_paid_entry": {
              • "entry_details": {
                • "entry_text": "string"
                }
              },
            • "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
                }
              ],
            • "proprietorship": {
              • "cautioner_party": [
                • {
                  • "address": [
                    ],
                  • "organization": {
                    },
                  • "private_individual": {
                    }
                  }
                ],
              • "current_proprietorship_date": "string",
              • "registered_proprietor_party": [
                • {
                  • "address": [
                    ],
                  • "organization": {
                    },
                  • "private_individual": {
                    }
                  }
                ]
              },
            • "restriction_details": {
              • "restriction_entry": [
                • {
                  • "charge_related_restriction": {
                    },
                  • "charge_restriction": {
                    },
                  • "non_charge_restriction": {
                    }
                  }
                ]
              }
            },
          • "title_number": "string",
          • "xml_register_data": {
            • "property_register": [
              • {
                • "register_entry": [
                  • {
                    }
                  ]
                }
              ]
            }
          }
        ]
      },
    • "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"
      ]
    },
  • "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": "A123BCD",
  • "priority_timestamp": "2019-08-24T14:15:22Z",
  • "application_request_id": "12345678-1234-1234-1234-123546789abc",
  • "status": "VALIDATING",
  • "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
certification_statement_type
required
string
Enum: "CERTIFIED" "CERTIFIED_BY_ANOTHER" "NOT_CERTIFIED"
  • CERTIFIED - I/we certify this is a true copy of an original document
  • CERTIFIED_BY_ANOTHER - I/we certify this document is a true copy of an original document which is certified by a conveyancer to be a true copy of the original
  • NOT_CERTIFIED - This document is an uncertified copy
document_id
required
string

The id of the document from the document upload request

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
message_text
required
string [ 0 .. 4034 ] characters

The content of the message to be attached

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._@ -]*$

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 Schema: application/json
Array of objects (NotificationResponse)
Array
notification_id
required
string <uuid>

The unique identifier of the notification

created_datetime
required
string <date-time>

Date and time the notification was created

event_datetime
required
string <date-time>

Date and time the event occurred

payload_schema
required
string <uri>

A link to a resource that describes the schema of the payload, this could be a JSON schema or documentation for example

notification_type
required
string

The type of notification, required to distiguish notification types that share a schema

subject_type
required
string

An indicator for the type of the subject

subject
required
string

Unique reference to the subject of the notification

additional_provider_filter
string

Provides additional filtering for larger integrators

status
required
string
Enum: "NEW" "ACKNOWLEDGED"
required
object

The payload of the notification

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

Response Schema: application/json
object (AcknowledgeOut)
acknowledged
required
Array of strings <uuid> [ items <uuid > ]
not_found
Array of strings <uuid> [ items <uuid > ]

Request samples

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

Response samples

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