Back

Application information API technical guide

Use this service to get information about a specific application

Version and Status

How to use the Application information API

The Application information API is used to get detailed information about a specific application, using the application_request_id returned by the Submit an application API request.

The status of an application can currently be one of the following:

VALIDATING - HMLR is still processing the application, and it has not yet been added to the day list
VALIDATION_FAILED - The application has not been added to the day list due to errors during validation. The errors found are included in the errors section of the response
ACCEPTED_AWAITING_PRIORITY - The application has passed validation but has not yet been added to the day list as it is currently closed. The application will be added to the day list and moved to an ACCEPTED_PRIORITY_PROTECTED state when the day list reopens
ACCEPTED_PRIORITY_PROTECTED - The application has been accepted onto the day list, and has priority
SYSTEM_ERROR - The application has not been added to the day list due to an HMLR system error. The request should be retried, or the support team contacted
CANCELLED - The application has been cancelled. Futher information should be available in the correspondence documents.
COMPLETED - The application has been completed. Further information should be available in correspondence documents.

This API will always return an HTTP 200 response for a valid request, regardless of the status of the application.

Validation rules

There are no validation rules for implementing this API.

Search reference warning

The following warnings are displayed for information purposes, when a search reference is provided, but does not match our records for the reasons below:

Warning message	Reason
`SEARCH_REFERENCE_DOES_NOT_MATCH` “The search reference provided, at the time of submission, is not the highest priority search on the daylist."	A search reference is provided, but it doesn’t match the highest priority search on record
`SEARCH_REFERENCE_NOT_PROVIDED` “There are official searches found on the daylist.”	A search reference isn’t provided at all, but there is an active search on the daylist
`SEARCH_REFERENCE_NOT_REQUIRED` “The search reference provided, at the time of submission, is not a live search on the daylist.”	A search reference is provided, but there is no active search on the daylist

Digital mortgage validation

Digital mortgage submissions are currently limited to:

integrators who already use our digital mortgage service, and their customers
single title charge transactions with a title scope of WHOLE

For digital mortgage applications:

an e-MD reference is required
no documents need to be attached

Digital mortgage validation error types

Error type	Description
`TOO_MANY_TITLES`	Provide an e-MD reference for single title applications only
`INVALID_TRANSACTION_TYPE`	Provide an e-MD reference for charge transactions only
`INVALID_TITLE_SCOPE`	Title scope must be WHOLE for the title associated with a transaction containing an e-MD reference
`TOO_MANY_TRANSACTIONS_WITH_EMDREF`	Provide a maximum of one transaction that contains an e-MD reference

Example requests and responses

VALIDATING status

GET /v1/applications/{id}/information

{
  "data": {
    "status": "VALIDATING",
    "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715",
    "s": [],
    "errors": [],
    "warnings": []
  }
}

VALIDATION_FAILED status

GET /v1/applications/{id}/information

{
  "data": {
    "status": "VALIDATION_FAILED",
    "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715",
    "correspondences": [],
    "errors": [
      {
        "type": "OC018",
        "detail": "Failed to get document '00001'.",
        "pointer": null
      }
    ],
    "warnings": []
  }
}

SYSTEM ERROR status

GET /v1/applications/{id}/information

{
  "data": {
    "status": "SYSTEM_ERROR",
    "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715",
    "correspondences": [],
    "errors": [],
    "warnings": []
  }
}

ACCEPTED_AWAITING_PRIORITY status

GET /v1/applications/{id}/information

{
  "data": {
    "status": "ACCEPTED_AWAITING_PRIORITY",
    "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715",
    "correspondences": [],
    "errors": [],
    "warnings": []
  }
}

ACCEPTED_PRIORITY_PROTECTED status

GET /v1/applications/{id}/information

{
  "data": {
    "status": "ACCEPTED_PRIORITY_PROTECTED",
    "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715",
    "hmlr_reference": "AB123FC",
    "priority_timestamp": "2024-09-25T18:18:49.478Z",
    "correspondences": [],
    "errors": [],
    "warnings": [
      "You must upload document X"
    ]
  }
}

CANCELLED status

GET /v1/applications/{id}/information

{
  "data": {
    "status": "CANCELLED",
    "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715",
    "hmlr_reference": "AB123FC",
    "priority_timestamp": "2024-09-25T18:18:49.478Z",
    "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": []
  }
}

COMPLETED status

GET /v1/applications/{id}/information

{
  "data": {
    "status": "COMPLETED",
    "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715",
    "hmlr_reference": "AB123FC",
    "priority_timestamp": "2024-09-25T18:18:49.478Z",
    "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": []
  }
}

Related APIs