Skip to main content
Back

Download a document API

Use this service to download documents created by HMLR

Version and Status

Overview

The Download a document API provides a way to download documents created by HMLR.

This API has one endpoint:

  • GET /v1/documents/{download_id} - get the binary content of the document.

You may obtain a download_id from any of the following:

  • Completion notifications
  • Cancellation notifications
  • Requisition correspondence notifications
  • The /correspondence array in an Application information API response

View the technical guide

Technical guide

View the API specification

Web version (opens in a new tab)

How the API works

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

This diagram demonstrates how the download a document API works.

A user may obtain a download_id from either the Notifications or Application information API.

The user can use that download_id in their request to GET /v1/documents/{download_id} to obtain the document binary.

How to test this API

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

View Download a document API test stubs

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.