Application Information API test stubs
Warning
These API endpoints are not currently live.
Version and Status
HMLR does not currently provide a test environment for integrators using our Business Gateway APIs. Instead, we’ve provided example code for different scenarios to demonstrate what you should expect to see when developing your own services.
Base URL: https://bgtest.landregistry.gov.uk/bg2test/api
Scenario 1: Information of applicaiton with single charge
Request
Method: GET
Endpoint: /v0/applications/b3ac19be-2b6d-4b8a-971c-e758b0e8e790/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "b3ac19be-2b6d-4b8a-971c-e758b0e8e790",
"status": "ACCEPTED_PRIORITY_PROTECTED",
"priority_timestamp": "2024-09-25T18:18:49Z",
"hmlr_reference": "A123AAA",
"warnings": [],
"errors": []
}
}
Scenario 2: Information of application with single transfer
Request
Method: GET
Endpoint: /v0/applications/2563940e-ae95-4e7e-9b33-49a6571abdf6/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "2563940e-ae95-4e7e-9b33-49a6571abdf6",
"status": "ACCEPTED_PRIORITY_PROTECTED",
"priority_timestamp": "2024-09-25T18:18:49Z",
"hmlr_reference": "B123BBB",
"warnings": [],
"errors": []
}
}
Scenario 3: Information of application with level 2 validation errors
Request
Method: GET
Endpoint: /v0/applications/3be62ad3-c542-452d-975e-6cd18d77196f/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"status": "VALIDATION_FAILED",
"hmlr_reference": null,
"priority_timestamp": null,
"errors": [{
"type": "mdref-on-record",
"detail": "MD Ref MD007A does not exist on record",
"pointer": null
}, {
"type": "lender-name-matches-records",
"detail": "MD Ref MD007A not found on record",
"pointer": null
}, {
"type": "all-mandatory-documents-provided",
"detail": "Mandatory documents missing for transactions of type [T]",
"pointer": null
}, {
"type": "transferee-has-representation-type",
"detail": "Transferee Transferee must have a representation type",
"pointer": null
}],
"warnings": [],
"application_request_id": "3be62ad3-c542-452d-975e-6cd18d77196f"
}
}