Skip to main content
Back

Application information API

Use this service to get information about a specific application

Version and Status

Overview

The Application information API is used to get detailed information about a specific application. This includes:

  • the status of an application
  • 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, including VALIDATION_FAILED
  • any warnings that did not prevent submission but need to be addressed before a caseworker can process the application (otherwise a requisition may occur)
  • a list of correspondence records associated with the application including:
    • completion documents
    • cancellation documents
    • requisition documents

This API can be used to get more information after receiving a notification indicating the application has changed. For information about which notifications are available, visit the Notifications API documentation.

View the technical guide

Technical guide

View the API specification

Web version (opens in new tab)

How the API works

Interaction

A diagram showing the interaction of the Application Information API.

This diagram demonstrates how the Application information API works to support users.

Using their unique application ID (provided via the Submit an application API), a user can request information about a specific application. Examples of the type of information are listed in the overview section.

The HMLR system will respond with the relevant information. The system may also respond by informing users that their application has been accepted onto the day list or if it has failed validation.

State diagram

A diagram showing how the Application Information API works.

The state diagram demonstrates how the validation process works once an application has been submitted.

When the system starts the validation process, there are several potential outcomes which can each trigger a different response. A response may include:

  • informing the user that an application has passed validation and has been added to the day list
  • informing the user that an application has passed validation but is awaiting priority as the day list is closed. Once the day list reopens, the application will be added
  • informing the user that an application has not passed validation. In this case, the system will indicate whether a validation or system error has occurred. The user must correct the error and resubmit the application

How to test this API

HMLR has created a test environment for the Application information API. We’ve also provided example code to demonstrate what you should expect when developing your own services.

Please note there are also plans to release a sandbox test environment for developers in the future. The exact release date is to be confirmed.

For general testing guidance, visit our guide to testing.