How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HM Land Registry Official Search of Whole with Data

HM Land Registry Official Search of Whole with Data from HM Land Registry — 1 path(s) described in OpenAPI.

HM Land Registry Official Search of Whole with Data is one of 14 APIs that HM Land Registry publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 28 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://bgtest.landregistry.gov.uk/bg2test/api, https://businessgateway.landregistry.gov.uk/bg2/api.

1 operations 1 paths 28 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://landregistry.data.gov.uk/landregistry/query
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Official Search of Whole with Data 1
POST
/v1/official-searches-of-whole
Submit an OS1 Official Search of Whole with Priority application
submitOfficialSearchOfWholeWithPriority body → 2012024XX5XX

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are OfficialSearchData (12 properties), OfficialSearchCreatedResponseData (8 properties), OfficialSearchRequest (7 properties), OfficialSearchOfWholeWithPriority (6 properties). Each schema is shown below with its type and property counts.

OfficialSearchRequest
object
7 properties 6 required
OfficialSearchCreatedResponseData
object
This is the Business Gateway confirmation response to the External System for applications that generate an automatic response including a result PDF
8 properties 4 required
OfficialSearchAcceptedResponseData
object
This is the the Business Gateway confirmation response to the External System for applications that did not generate a successful completion response
5 properties 2 required
ErrorResponse
object
A response for an unsuccessful result.
1 property
Error
object
An error response for an unsuccessful request.
6 properties 2 required
AcknowledgementMessage
string
An acknowledgement in support of the status of the submitted Official Search
AdvisoryEntries
array
Advisory entries as shown on the OS1R result
AdvisoryEntry
object
An individual advisory entry with unstructured data
4 properties 1 required
Certificate
object
Object holding either link or byte string of the certificate. If type is 'link' there will be a ling to download the certificate . If the type is 'attachment'…
3 properties 2 required
CertificateTimestamp
string
The certificate date and time of a pending official search of whole
CommonholdTitle
object
Provided if the searched for title number is part of a commonhold title
1 property 1 required
Contact
object
The information relevant to a person or organization that acts as a point of contact with another person or organization
2 properties 2 required
CurrencyCode
string
The currency code to be used inline with standard ISO 4217 code identifying a currency.
HMLRReference
string
A unique reference given to identify a particular request, order or instruction in the system of the organisation allocating it
NameMismatch
object
Provided if the value of request object registeredproprietorsdetailsorapplicantsforfirstregistration does not match with Land Registry's proprietorship register
1 property 1 required
OfficialCopyTimestamp
string
The date and time of an official copy of a register
OfficialSearchData
object
12 properties 3 required
OfficialSearchId
string
A unique character string, (i.e. a finite set of characters) generally in the form of words of a language, used by end user to get the status update of their r…
OfficialSearchOfWholeWithPriority
object
6 properties 5 required
PendingOfficialSearchesOfWhole
object
3 properties 3 required
PhoneNumber
string
Contact phone number
Price
object
Information about price
4 properties
PriorityType
string
The disposition that the search is intended to protect, namely, purchase, lease or charge
Reference
object
A unique reference given to identify a particular request, order or instruction in the system of the organisation allocating it with the ability to associate t…
3 properties 1 required
RegisterStatusEntry
object
Entry that describes the status of the register as shown in the OS1R result
2 properties 1 required
ResultEntries
object
The Result section of the OS1R document
2 properties 1 required
Source
object
An object containing references to the primary source of the error.
3 properties
TitleNumber
string
Provides the subject property title number which is the subject of the transaction, or on which a search is being prepared

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hm-land-registry-official-search-of-whole-with-data-openapi.yml Raw ↑

Other APIs HM Land Registry publishes across the network.

HM Land Registry Open Data SPARQL API
HM Land Registry Price Paid Data Linked Data API
UK House Price Index Linked Data API
Land Register API
HM Land Registry Estimate Completion Date API
HM Land Registry HMLR Business Gateway (Hm Land Registry Official Copy Document Availability V1 Customer Test)
HM Land Registry Official Copy Document Availability Service (Hm Land Registry Official Copy Document Availability V1)
HM Land Registry HMLR Business Gateway (Hm Land Registry Official Copy Document Availability V2 Customer Test)
HM Land Registry Official Copy Document Availability Service (Hm Land Registry Official Copy Document Availability V2)
HM Land Registry Registered Proprietor Names Service
HM Land Registry V0.3 'Submit an application to change the Land Register API' Schema
HM Land Registry V1.0 'Submit an application to change the Land Register API' Schema
Where this information came from

This is an independent, third-party profile of HM Land Registry Official Search of Whole with Data, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.