Skip to main content
Back

Attach a document API

Use this service to attach a document to a submitted application

Version and Status

Overview

The Attach a document API allows users to attach additional documents to an existing application. The Notifications API can then be used to understand if the document has been successfully attached to the application.

If users want to attach a message to an application, they will need to use the Attach a message API.

View the technical guide

Technical guide

View the API specification

Web version (opens in new tab)

How the API works

A diagram showing the interaction of the Attach a document API.

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

When a user submits a document, the HMLR system will initially respond with an empty ‘202 Accepted’ response. Users will then receive a notification stating whether the attachment has been successful or not.

How to test this API

HMLR has created a test environment for the Attach a document 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.