Skip to main content
Back to Overview Back to Home

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 are still processing the application, and it has not yet been added to the day list
  • REJECTED - 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
  • VALIDATED (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 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 HM Land Registry system error. The request should be retried, or the support team contacted

The Application information API also includes other information about the application, including:

  • fees that were deducted from the VDD account number setup with the submitting users HM Land Registry account. This will be confirmation of the fees entered into the request payload until automatic fee calculation is enabled
  • the application_request_id used in the request
  • an ID for the accepted application, hmlr_reference, once accepted (previously known as ABR)
  • the priority of the application, priority_timestamp, once accepted
  • any errors that prevented application submission
  • any warnings that did not prevent submission, but need to be addressed before a caseworker can process the application, otherwise a requisition may occur

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

API Specification

See the API Specification here

Diagrams

Interaction

State diagram

Examples

GET /v1/applications/{id}/status - VALIDATING status

{ 
  "status": "VALIDATING", 
  "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715" 
}

GET /v1/applications/{id}/status - ACCEPTED status

{ 
  "status": "ACCEPTED", 
  "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715", 
  "hmlr_reference": "AB1234", 
  "priority_timestamp": "2024-09-25T18:18:49.478Z",
  "warnings": [
    "You must upload document X"
  ],
  "calculated_fees": { 
    "total_fee": 45, 
    "per_transaction": [ 
      { 
        "transaction_reference": "transfer-1", 
        "fee": 45 
      } 
    ] 
  } 
}

GET /v1/applications/{id}/status - REJECTED status

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

GET /v1/applications/{id}/status - VALIDATED status

{ 
  "status": "VALIDATED", 
  "application_request_id": "3e4f6da2-ada7-4081-957c-b23542466715" 
}

See more