How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HM Land Registry V1.0 'Submit an application to change the Land Register API' Schema

HM Land Registry V1.0 'Submit an application to change the Land Register API' Schema from HM Land Registry — 10 path(s) described in OpenAPI.

HM Land Registry V1.0 ‘Submit an application to change the Land Register API’ Schema is one of 14 APIs that HM Land Registry publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 10 paths, organized into 7 resource areas, and defines 55 schemas. It is described by OpenAPI 3.1.0, at version 1.0.5.

Requests are made against 2 base URLs: https://businessgateway.landregistry.gov.uk/bg2/api, https://bgtest.landregistry.gov.uk/bg2test/api.

10 operations 10 paths 55 schemas 4 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.5
Base URL
https://landregistry.data.gov.uk/landregistry/query
Authentication
HTTP Basic
Resource Areas
7

Authentication & Security 1

HM Land Registry V1.0 'Submit an application to change the Land Register API' Schema declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 4 GET, 5 POST, 1 PUT. They span 7 resource areas: Submit an application API, Download a document API, Send a document API, Application information API, Attach a document, Attach a message, Notifications API. Each is listed below with its method, path, parameters, and response codes.

Submit an application API 1
POST
/v1/applications
Submit an application
submit_an_application_to_change_the_register_v1 1 param body → 202400401500
Download a document API 2
GET
/v1/documents/{document_id}
Obtain download link for an HMLR document
download_a_document_v1 1 param → 302400401403404429500
GET
Download a document
Download the document contents. Note: This URL, including hostname and path parameters is returned from the GET /documents/{documentid} URL endpoint via the location header and should be used unmodif…
Download a document → 200404
Send a document API 2
POST
/v1/documents/url
Request upload URL for your application attachments
send_a_document_v1 body → 200400401500
PUT
Upload a document
Upload a document - Upload the document contents. Note: This URL, including hostname and path parameters is returned from the create URL endpoint and should be used unmodified. The path and hostname…
Upload a document 2 params body → 200403
Application information API 1
GET
/v1/applications/{application_request_id}/information
Get application details
get_application_information_v1 1 param → 200400401404500
Attach a document 1
POST
/v1/applications/{application_request_id}/attachments
Attach a document to an existing application
attach_a_document_v1 1 param body → 202400401404500
Attach a message 1
POST
/v1/applications/{application_request_id}/messages
Attach a message to an existing application
attach_a_message_v1 1 param body → 202400401404500
Notifications API 2
GET
/v1/notifications
Receive notifications API - Get any unacknowledged notifications
get_notifications_v1 9 params → 200400401403404500
POST
/v1/notifications/acknowledge
Acknowledge notifications API - Acknowledge notifications that have been processed, so they are no longer returned when fetching
acknowledge_notifications_v1 body → 200400401403404500

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are SubstantiveApplicationData (13 properties), NotificationResponse (10 properties), Transaction (8 properties), ErrorResponse (7 properties). Each schema is shown below with its type and property counts.

AddressReference
string
Unique identifier for addresses, used to reference addresses from elsewhere in the spec
PartyReference
string
Unique identifier for parties, used to reference parties from elsewhere in the spec
DocumentReference
string
Unique identifier for documents, used to reference documents from elsewhere in the spec
AddressDetails
object
The details captured for a specific address. Details differ depending on type
1 property 1 required
AddressForServiceOption
string
PROVIDEDADDRESS - The address for service has been provided alongside this option NOTREQUIRED - The address for service is not required for the party
AmountDetails
object
A type of TransactionDetails that captures the value of the transaction
Charge
object
A TransactionDetails object to capture information about a charge
2 required
ValidationDisagreement
object
Fields to describe which validation results are contested and why
4 properties 4 required
CorrespondenceDocumentType
object
2 properties
CorrespondenceRecordDocumentItemWithDownloadId
object
List of documents in the correspondence record
3 properties 1 required
CorrespondenceRecordInApplicationInformation
object
Representation of a correspondence record
2 properties 2 required
Discharge
object
A TransactionDetails object to capture information about a discharge
1 required
DocumentMetadata
object
Metadata about the document that was uploaded
2 properties 2 required
DocumentUploadUrlDataResponse
object
The response object containing information needed for uploading a document
1 property
DocumentUploadUrlResponse
object
The response object containing information needed for uploading a document
2 properties
DocumentUploadUrlData
object
The data needed to generate a URL to upload a document
4 properties 3 required
DocumentUploadUrlRequest
object
The request to send to the endpoint to request an upload URL
1 property 1 required
ErrorResponse
object
Wrapper for any error responses
7 properties
ProblemDetails
object
Detailed information about an error
3 properties 2 required
ProblemDetail
object
6 properties 1 required
ErrorDescription
object
4 properties 1 required
ApplicationCreationDataResponse
object
The response wrapper from the application submission request
1 property
ApplicationCreationResponse
object
The response from the application submission endpoint
1 property
ApplicationInformationDataResponse
object
Data wrapper for the status response
1 property
ApplicationInformationResponse
object
The response object for the application status endpoint
7 properties
ApplicationLodger
object
Information about the person lodging the application (This is usually the conveyancer lodging on behalf of an individual)
3 properties 2 required
OtherConveyancer
object
Information about another conveyancer (who is not the lodging conveyancer) representing a party on the application
3 properties 3 required
SubstantiveApplicationData
object
The data required to capture an application
13 properties 6 required
SubstantiveApplication
object
The request to submit an application to HM Land Registry
1 property 1 required
TitleDetails
object
Information about a HM Land Registry title
4 properties 4 required
TitleScopeDetails
object
The scope of the title that is being updated
2 properties 1 required
TransactionDetails
object
Details of the transaction that apply to all transaction types
1 property 1 required
Transfer
object
Details about a transfer transaction
4 required
ValueBand
object
A range the value of the transaction falls between. Valid bands are: 0 - 100000 100001 - 200000 200001 - 500000 500001 - 1000000 1000001 +
2 properties 1 required
Address
object
An object containing an address, where the address details may be one of multiple types
1 property 1 required
DocumentDetails
object
The details about an uploaded document
4 properties 3 required
Party
object
A person or entity that has a role in an transaction
7 properties 3 required
PartyRole
object
Information about the roles and capacities for a specific party
4 properties 2 required
PrivateIndividual
object
A party object to capture infomation about a private individual
2 required
Transaction
object
The object representing a transaction to apply to specific titles on the application
8 properties 3 required
UKCompany
object
A party object to capture infomation about an UK company
1 required
OverseasCompany
object
A party object to capture infomation about an overseas company
4 required
OtherOrganisation
object
A party object to capture infomation about an other organisation
1 required
UnknownParty
object
A party object to capture infomation about an unknown party
2 required
PartyDetails
object
Details of the party that apply to all party types
1 property 1 required
BfpoAddress
object
A British Forces Post Office address
3 required
DxAddress
object
A document exchange address
2 required
EmailAddress
object
An object containing the email address of the customer
1 required
OverseasAddress
object
The address of a premise outside the UK
1 required
PoBoxAddress
object
An address of a PO Box
3 required
UkAddress
object
A UK postal address
3 required
NotificationResponse
object
10 properties
BulkAcknowledgeResult
object
2 properties
AttachADocumentRequest
object
The request to send to the endpoint to request an upload URL
1 property 1 required
AttachAMessageRequest
object
The request to send to the endpoint to request an upload URL
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hm-land-registry-submit-application-to-change-the-register-v1.0-openapi.json Raw ↑

Other APIs HM Land Registry publishes across the network.

HM Land Registry Open Data SPARQL API
HM Land Registry Price Paid Data Linked Data API
UK House Price Index Linked Data API
Land Register API
HM Land Registry Estimate Completion Date API
HM Land Registry HMLR Business Gateway (Hm Land Registry Official Copy Document Availability V1 Customer Test)
HM Land Registry Official Copy Document Availability Service (Hm Land Registry Official Copy Document Availability V1)
HM Land Registry HMLR Business Gateway (Hm Land Registry Official Copy Document Availability V2 Customer Test)
HM Land Registry Official Copy Document Availability Service (Hm Land Registry Official Copy Document Availability V2)
HM Land Registry Official Search of Whole with Data
HM Land Registry Registered Proprietor Names Service
HM Land Registry V0.3 'Submit an application to change the Land Register API' Schema
Where this information came from

This is an independent, third-party profile of HM Land Registry V1.0 'Submit an application to change the Land Register API' Schema, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.