Skip to main content

Document Purchasing API

The Nimbus Document Purchasing API lets integrations check document availability and pricing for a title, purchase HMLR and property-related documents, receive webhook delivery events, and download purchased files.

Core Workflows

WorkflowStart here
Set up credentials and make a first requestGetting started
Compare authentication optionsAuthentication
Look up endpoint purposes and permissionsQuick reference
Implement document deliveryWebhooks
Copy request examplesExamples
Read the full implementation guideIntegration guide
Explore every endpointOpenAPI reference

Base URLs

EnvironmentURL
Productionhttps://api.nimbusmaps.co.uk/docs/v1
Pre-productionhttps://api-preprod.nimbusmaps.xyz/docs/v1

Main Steps

  1. Authenticate with either delegated user flow or application client credentials.
  2. Subscribe to webhook notifications.
  3. Call /check-availability for the title number or title ID.
  4. Call /purchase with the documents to buy.
  5. Receive document status events and download completed documents.