Skip to main content
Back

Application information API Technical guide

Use this service to get information about a specific application.

Warning These API endpoints are not currently live.

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 - HM Land Registry 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

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.

Example requests and responses

VALIDATING status

GET /v0/applications/{id}/information

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

VALIDATION_FAILED status

GET /v0/applications/{id}/information

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

ACCEPTED_AWAITING_PRIORITY status

GET /v0/applications/{id}/information

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

ACCEPTED_PRIORITY_PROTECTED status

GET /v0/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",
    "correspondence": [],
    "errors": [],
    "warnings": [
      "You must upload document X"
    ]
  }
}

Related APIs