Download a document API

Obtain download link for an HMLR document

Changed on Nov 7, 2025

Request the download link for a document. Currently only supports the download of documents HMLR despatches, i.e correspondence, cancellation and completion documents.

get/v1/documents/{document_id}

Request

Base URL
https://businessgateway.landregistry.gov.uk/bg2/api
Auth
HTTP basic
TypeScript
https://skmtc.dev/hm-land-registry/apis/v1-0-submit-an-application-to-change-the-land-register-api-s/docs/v1/documents/:document_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

document_idstring required

May also be referred to as the download_id by some services

Changes

Nov 7, 202504719f6cbb9c Revision changes
- info
  api operation id Get Download URL removed and replaced with download_a_document_v1
Oct 31, 20253a8f0dc06f13 Revision changes
- info
  the endpoint scheme security basic_auth was removed from the API

Operation history (4 revisions)