HM Land Registry Official Copy Document Availability

Plugin for checking which register referred documents are available for immediate download from HM Land Registry using the Official Copy Document Availability API.

Setup

1. Copy .env.example to .env:

   cp .env.example .env

2. Get your API credentials from HM Land Registry Business Gateway

3. Add your credentials to .env:

   LAND_REGISTRY_API_KEY=your_base64_encoded_credentials

Getting Your API Key

The API uses Basic Authentication. You need to provide a base64-encoded string of your username:password:

echo -n "username:password" | base64

Test Environment

To use the test environment instead of production, set:

LAND_REGISTRY_HOST=https://bgtest.landregistry.gov.uk/bg2test/api/v2

Usage

Test Connection

opencode run "test land-registry connection"

Check Document Availability

opencode run "check document availability for title number DT501578"

Available Tools

• land-registry-test-connection - Test API connection and credentials
• land-registry-get-official-copies-availability - Get document availability for a title number

Title Number Examples

The API documentation provides test title numbers:

• DT501578 - Title with various document availability states
• GR514441 - Open title with documents available immediately
• GR514442 - Title with register and title plan available
• GR514443 - Title with pending status

Environment Variables

| Variable | Required | Description | |----------|----------|-------------| | LAND_REGISTRY_API_KEY | Yes | Base64-encoded Basic Auth credentials | | LAND_REGISTRY_HOST | No | API host override (defaults to production) | | LAND_REGISTRY_LOAD_SECONDARY_TOOLS | No | Enable secondary tools (defaults to true) |

API Documentation

• Official Copy Document Availability V2