Download a document API test stubs
Version and Status
HMLR does not currently provide a test environment for integrators using our Business Gateway APIs. Instead, we’ve provided example code for different scenarios to demonstrate what you should expect to see when developing your own services.
Base URL: https://bgtest.landregistry.gov.uk/bg2test/api
Scenario 1: Download a cancellation document
Request
Method: GET
Endpoint: /v1/documents/can_62523897b09f9a3f380eefd878e7205aac78781cc68383ba79c3b7d42385
Headers: Authorization: <any-value>
Response
Contents
Status: 200
Body: Document binary
Status: 302
Headers: Location: <download url>
Scenario 2: Download a letter
Request
Method: GET
Endpoint: /v1/documents/ltr_6a1756a68fbe29c58fe75e9c7a261dd416692f8a0d916ac63aead8111549
Headers: Authorization: <any-value>
Response
Contents
Status: 200
Body: Document binary
Status: 302
Headers: Location: <download url>
Scenario 3: Download a register completion sheet
Request
Method: GET
Endpoint: /v1/documents/rcs_efc428e900f2d1501c156e9ec664f2a740749b6689afe61b6bf95440a31a
Headers: Authorization: <any-value>
Response
Contents
Status: 200
Body: Document binary
Status: 302
Headers: Location: <download url>
Scenario 4: Scenario 4: Download a copy of the register
Request
Method: GET
Endpoint: /v1/documents/reg_7ea12372179f1ae9d80fefec38cb7ff6b42672c49a0c292827434c848038
Headers: Authorization: <any-value>
Response
Contents
Status: 200
Body: Document binary
Status: 302
Headers: Location: <download url>