Application Information API test stubs
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
Note: all application request ids used in this are modifiable, you only need the last 3 letters to match the provided values.
Note: all hmlr references used in this are modifiable, you only need the last 3 letters to match the provided values.
Scenario 1: Information of application that is validating
Request
Method: GET
Endpoint: /v1/applications/abababab-abab-abab-abab-ababababavng/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababavng",
"hmlr_reference": null,
"priority_timestamp": null,
"status": "VALIDATING",
"correspondences": null,
"errors": [],
"warnings": []
}
}
Scenario 2: Information of application that has failed validation
Request
Method: GET
Endpoint: /v1/applications/abababab-abab-abab-abab-ababababavlf/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababavlf",
"hmlr_reference": null,
"priority_timestamp": null,
"status": "VALIDATION_FAILED",
"correspondences": null,
"errors": [{
"type": "mdref-on-record",
"detail": "MD Ref MD123A does not exist on record"
},{
"type": "lender-name-matches-records",
"detail": "MD Ref MD123A not found on record"
},{
"type": "all-mandatory-documents-provided",
"detail": "Mandatory documents missing for transactions of type [T]"
},{
"type": "transferee-has-representation-type",
"detail": "Transferee must have a representation type"
}],
"warnings": [
"Please ensure any relevant evidence is attached."
]
}
}
Scenario 3: Information of application that system errored
Request
Method: GET
Endpoint: /v1/applications/abababab-abab-abab-abab-ababababasye/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababasye",
"hmlr_reference": null,
"priority_timestamp": null,
"status": "SYSTEM_ERROR",
"correspondences": null,
"errors": [],
"warnings": []
}
}
Scenario 4: Information of application is accepted awaiting priority
Request
Method: GET
Endpoint: /v1/applications/abababab-abab-abab-abab-ababababaaap/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababaaap",
"hmlr_reference": "BABAAAP",
"priority_timestamp": null,
"status": "ACCEPTED_AWAITING_PRIORITY",
"correspondences": [],
"errors": [],
"warnings": []
}
}
Scenario 5: Information of application is accepted priority protected
Request
Method: GET
Endpoint: /v1/applications/abababab-abab-abab-abab-ababababaapp/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababaapp",
"hmlr_reference": "BABAAPP",
"priority_timestamp": "2025-08-27T14:40:35.23071Z",
"status": "ACCEPTED_PRIORITY_PROTECTED",
"correspondences": [
{
"record_id": "2025-09-05T08:15:01.259Z",
"documents": [
{
"created_at": "2025-09-05T08:15:01.281Z",
"download_id": "ltr_6a1756a68fbe29c58fe75e9c7a261dd416692f8a0d916ac63aead8111549",
"type": {
"code": "LTR",
"name": "LETTER"
}
}
]
}
],
"errors": [],
"warnings": []
}
}
Scenario 6: Information of application is cancelled
Request
Method: GET
Endpoint: /v1/applications/abababab-abab-abab-abab-ababababacan/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababacan",
"hmlr_reference": "BABACAN",
"priority_timestamp": "2025-08-27T14:40:35.23071Z",
"status": "CANCELLED",
"correspondences": [
{
"record_id": "2025-09-05T08:20:03.996Z",
"documents": [
{
"created_at": "2025-09-05T08:20:04.050Z",
"download_id": "can_62523897b09f9a3f380eefd878e7205aac78781cc68383ba79c3b7d42385",
"type": {
"code": "CAN",
"name": "CANCELLATION LETTER"
}
}
]
}
],
"errors": [],
"warnings": []
}
}
Scenario 7: Information of application is completed
Request
Method: GET
Endpoint: /v1/applications/abababab-abab-abab-abab-ababababacmp/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababacmp",
"hmlr_reference": "BABACMP",
"priority_timestamp": "2025-08-27T14:40:35.23071Z",
"status": "COMPLETED",
"correspondences": [
{
"record_id": "2025-09-05T08:15:01.259Z",
"documents": [
{
"created_at": "2025-09-05T08:15:01.281Z",
"download_id": "ltr_6a1756a68fbe29c58fe75e9c7a261dd416692f8a0d916ac63aead8111549",
"type": {
"code": "LTR",
"name": "LETTER"
}
},
{
"created_at": "2025-09-05T08:15:01.319Z",
"download_id": "rcs_efc428e900f2d1501c156e9ec664f2a740749b6689afe61b6bf95440a31a",
"type": {
"code": "RCS",
"name": "REGISTRATION COMPLETION SHEET"
}
},
{
"created_at": "2025-09-05T08:15:01.343Z",
"download_id": "reg_7ea12372179f1ae9d80fefec38cb7ff6b42672c49a0c292827434c848038",
"type": {
"code": "REG",
"name": "COPY OF UPDATED REGISTER"
}
}
]
}
],
"errors": [],
"warnings": []
}
}
Scenario 8: Information of application is accepted awaiting priority using hmlr reference
Request
Method: GET
Endpoint: /v1/applications/BABAAAP/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababaaap",
"hmlr_reference": "BABAAAP",
"priority_timestamp": null,
"status": "ACCEPTED_AWAITING_PRIORITY",
"correspondences": [],
"errors": [],
"warnings": []
}
}
Scenario 9: Information of application is accepted priority protected using hmlr reference
Request
Method: GET
Endpoint: /v1/applications/BABAAPP/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababaapp",
"hmlr_reference": "BABAAPP",
"priority_timestamp": "2025-08-27T14:40:35.23071Z",
"status": "ACCEPTED_PRIORITY_PROTECTED",
"correspondences": [
{
"record_id": "2025-09-05T08:15:01.259Z",
"documents": [
{
"created_at": "2025-09-05T08:15:01.281Z",
"download_id": "ltr_6a1756a68fbe29c58fe75e9c7a261dd416692f8a0d916ac63aead8111549",
"type": {
"code": "LTR",
"name": "LETTER"
}
}
]
}
],
"errors": [],
"warnings": []
}
}
Scenario 10: Information of application is cancelled using hmlr reference
Request
Method: GET
Endpoint: /v1/applications/BABACAN/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababacan",
"hmlr_reference": "BABACAN",
"priority_timestamp": "2025-08-27T14:40:35.23071Z",
"status": "CANCELLED",
"correspondences": [
{
"record_id": "2025-09-05T08:20:03.996Z",
"documents": [
{
"created_at": "2025-09-05T08:20:04.050Z",
"download_id": "can_62523897b09f9a3f380eefd878e7205aac78781cc68383ba79c3b7d42385",
"type": {
"code": "CAN",
"name": "CANCELLATION LETTER"
}
}
]
}
],
"errors": [],
"warnings": []
}
}
Scenario 11: Information of application is completed using hmlr reference
Request
Method: GET
Endpoint: /v1/applications/BABACMP/information
Headers: Authorization: <any-value>
Response
Status: 200
{
"data": {
"application_request_id": "abababab-abab-abab-abab-ababababacmp",
"hmlr_reference": "BABACMP",
"priority_timestamp": "2025-08-27T14:40:35.23071Z",
"status": "COMPLETED",
"correspondences": [
{
"record_id": "2025-09-05T08:15:01.259Z",
"documents": [
{
"created_at": "2025-09-05T08:15:01.281Z",
"download_id": "ltr_6a1756a68fbe29c58fe75e9c7a261dd416692f8a0d916ac63aead8111549",
"type": {
"code": "LTR",
"name": "LETTER"
}
},
{
"created_at": "2025-09-05T08:15:01.319Z",
"download_id": "rcs_efc428e900f2d1501c156e9ec664f2a740749b6689afe61b6bf95440a31a",
"type": {
"code": "RCS",
"name": "REGISTRATION COMPLETION SHEET"
}
},
{
"created_at": "2025-09-05T08:15:01.343Z",
"download_id": "reg_7ea12372179f1ae9d80fefec38cb7ff6b42672c49a0c292827434c848038",
"type": {
"code": "REG",
"name": "COPY OF UPDATED REGISTER"
}
}
]
}
],
"errors": [],
"warnings": []
}
}