Official Copy Document Availability V1

For V2 of the official copy document availability click here.

Overview

Check which register referred documents are available for immediate download. Use a title number to find out the Official Copy Document Availability status via a RESTful API. When you know what is available, you can order using the Official Copy Title Known service.

Release notes

30th November 2023

Added new server url bg2/api.
- Existing bg2/s1 integration will remain.
Added new test server URL bg2test/api.
- Existing bg2test/s1 will be made unavailable soon.
Updated error codes to align with other newer services on bg2/api.
Updated rate limiting method on bg2/api.
- Added response header x-ratelimit-remaining to identify remaining limit.

26th January 2024

Existing bg2/s1 integration will be internally redirected to bg2/api.
- Updated rate limiting applied.
- Updated error handling applied.
- Removed bg2test/s1 test stub URL.
  - Replaced by /bg2test/api.

Error Code Changes

Status Code	Old Error Code	New Error Code	Explanation
401	BG40003	BG40004	Unauthorised
403	BG40003	BG40005	Forbidden
404	BG40006	BG40002	Title not found
429	BG40002	BG40006	Too many requests, please wait and try again
503	BG50004	BG50003	Service unavailable
504	-	BG50004	Internal service timeout

Known Issues

Rate limiting will return a 429 but will not return a response body.

Process flow

To request the availability of a document, you will need to input the title number into your Case Management Software:

Input

login details
title number

Output

a list of register referred documents and their availability for download
availability of Title Register and Title Plan documents

Process flow diagram

Official Copy Document Availability Service version 1 flow diagram

Service Working Hours

The Business Gateway service is available between 6.30am and 11pm. Please note that you may find that the service processes your requests outside of these hours, but no support is available.

Rate limiting

This service will be subject to rate limiting to ensure it performs well for all users. This is currently set at 75 requests per customer per minute which is subject to change at any time. Please contact us at channelpartners@landregistry.gov.uk (clicking this link will open a new window).

Rate limit Headers:

Burst:	X-RateLimit-Burst-Capacity
Replenish:	X-RateLimit-Replenish-Rate
Request:	X-RateLimit-Requested-Tokens
Remain:	X-RateLimit-Remaining

Access control

To use this service you will need to be an existing Business Gateway user. If you have an active user account, you will be able to access the new service using your existing credentials. If you would like to sign up to our service you can request access at https://www.gov.uk/guidance/apply-for-hm-land-registry-business-e-services.

Customer testing

Below, you will find the OpenAPI spec for the customer test environment and five stubs which you may build against. The test environment can be accessed at:
https://bgtest.landregistry.gov.uk/bg2test/api/v1/titles/<title_number>/official-copies/availability

Where <title_number> is replaced by the title number you need to use.

The previous test environment url has been deprecated: ~~https://bgtest.landregistry.gov.uk/bg2test/s1/v1/titles//official-copies/availability~~

See openapi.json

Please find scenarios mapped to the test stubs as follows:

Example Title Number- DT501578

Title	Closed or Cancelled
Register	No
Title Plan	No
Documents Referred- Available Immediately	1
Documents Referred- Requiring Further Investigation	7 different docs (some filed under other Title Numbers)
Documents Referred- Not Available	4 different docs

See DT501578.json

Example Title Number- GR514441

Title	Open
Register	Yes
Title Plan	No
Documents Referred- Available Immediately	6 different docs (some filed under other Title Numbers)
Documents Referred- Requiring Further Investigation	4 (some filed under other Title Numbers)
Documents Referred- Not Available	0

See GR514441.json

Example Title Number GR514442

Title	Open
Register	Yes
Title Plan	Yes
Documents Referred- Available Immediately	12 different docs
Documents Referred- Requiring Further Investigation	0 docs
Documents Referred- Not Available	0 docs

See GR514442.json

Example Title Number GR514443

Title	Open
Register	Yes (Pending)
Title Plan	Yes (Pending)
Documents Referred- Available Immediately	1 doc
Documents Referred- Requiring Further Investigation	7 different docs (some filed under other Title Numbers)
Documents Referred- Not Available	4 different docs

See GR514443.json

Example Title Number GR519468

Title	Closed and Continued- Provide new Title Number
Register	No
Title Plan	No
Documents Referred- Available Immediately	0
Documents Referred- Requiring Further Investigation	0
Documents Referred- Not Available	0

See GR519468.json

Status codes

Status Code	Error Code	Explanation
400	BG40001	Malformed invalid schema. Title is invalid
401	BG40004	Unauthorised
403	BG40005	Forbidden
404	BG40002	Title not found. This may be due to the title number being inputted incorrectly- please check and try again. Alternatively, the title number you have entered may not have been used historically or has not yet been allocated.
429	BG40006	Too many requests, please wait and try again
500	BG50001	Internal server error
500	BG50002	Internal server error
503	BG50003	Service unavailable
504	BG50004	Internal service timeout

When developing against the above, please use the status code. Error codes are currently in place but are subject to future change or may disappear in the future – you may not want to build against these.