Skip to main content
Back

Submit an application API

Use this service to provide data to HMLR for updating the register.

Warning These API endpoints are not currently live.

Version and status


Overview

The Submit an application API will help users provide the necessary data to HMLR for updating the register. This API is asynchronous, returning a unique ID for the submission request which can be used when fetching the application status.

This API supports the following application types:

  • Register update
  • Transfer of part
  • Dipositionary first lease (includes new lease and lease extension)
  • Removing a default Form A restriction (JP1)

The data in the request content contains information about:

  • Addresses
  • Documents
  • Parties
  • Transactions
  • Titles

View the Technical guide

View the API specification

How the API works

A diagram showing how the Submit an application API works.

This diagram demonstrates how the Send a document API works to support users.

When a user submits information to update the register, the HMLR system will respond by sending a unique application ID. Users can use this ID to receive information about the status of their application.


How to test this API

HMLR has created a test environment for the Submit an application 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.