Skip to main content

Official Copy Document Availability V2


For V1 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 an additional plan_only flag to the Referred Document Availability items, which if true states the document only contains a plan, not the complete document.
    • Added to new server url for bg2/api only.
  • Updated rate limiting method.
    • Added response header x-ratelimit-remaining to identify remaining limit.
  • Updated error codes to align with other newer services for consistancy.

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, their availability for download and whether or not these documents are only the plan.
  • availability of Title Register and Title Plan documents

Process flow diagram

Official Copy Document Availability Service version 2 flow diagram

Service Working Hours

This service is available 24/7.


Rate limiting

See Rest Rate Limiting


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/v2/titles/<title_number>/official-copies/availability

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

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.


Schemas

A Generic document thumbnail image

OpenAPI Schema

JSON
This file may not be suitable for users of assistive technology.

Download


Vendor testing

Sample JSON files.

A Generic document thumbnail image

OpenAPI- Cust Test

JSON
This file may not be suitable for users of assistive technology.

Download

A Generic document thumbnail image

DT501578

JSON
This file may not be suitable for users of assistive technology.

Download

A Generic document thumbnail image

GR514441

JSON
This file may not be suitable for users of assistive technology.

Download

A Generic document thumbnail image

GR514442

JSON
This file may not be suitable for users of assistive technology.

Download

A Generic document thumbnail image

GR514443

JSON
This file may not be suitable for users of assistive technology.

Download

A Generic document thumbnail image

GR519468

JSON
This file may not be suitable for users of assistive technology.

Download