A Developer Guide to the REST Services
Introduction
This document provides technical information about the Business Gateway REST services.
Business Gateway provides an interface for interoperability between your systems and our services through a suite of REST APIs.
To integrate using SOAP/XML visit A Developer Guide to the SOAP Services
Services
The Business Gateway REST services are comprised of:
- Official Search of Whole (with Priority) with Data
- Official Copy Document Availability
- Registered Proprietor Names
Authentication
Access to our API endpoints requires: a valid SSL certificate and an active Business Gateway user account.
SSL certificate
A valid SSL certificate, issued by Business Gateway, is required. This certificate is used to enable mutual SSL authentication and must be installed on the consumer (your) system.
You should;
- Install SSL certificates issued by HM Land Registry as trusted root
- Install client digital certificate issued by HM Land Registry into client key store
Basic authentication
An active Business Gateway user account is required. Access to our API endpoints is granted via successful authorization using Basic authentication.
You should:
- Provide your username and password as Basic authentication
Design Considerations
Where applicable, a message_id is supplied by the client to identify a request made to a service endpoint.
A generated message_id must be unique and is used when a result cannot be returned immediately.
i.e. When a request is made out of hours or manual processing is required, the message_id should be used with the Poll Request Service to retrieve the result at a later date.
Environments
Business Gateway provides both a test and production environment.
| Environment | Endpoint |
|---|---|
| Test | https://bgtest.landregistry.gov.uk/bg2test |
| Production | https://businessgateway.landregistry.gov.uk/bg2 |
Endpoints
Official Search of Whole (with Priority) with Data
POST /api/v1/official-searches-of-whole
Official search with priority by a purchaser against the whole of a registered title or pending first registration application.
Official Copy Document Availability
GET /s1/v1/titles/{title_number}/official-copies/availability
Returns the OC1 document availability (title register and title plan) and a collection of OC2 document availability (referred to in the register) for the provided title number.
Registered Proprietor Names
GET /s2/v1/titles/{title_number}/registered-proprietor-names
Returns the registered proprietor names for the provided title number.