Guidance

Business Gateway developer pack: Official Search of Whole

Technical documents for software developers to integrate Official Search of Whole with Priority OS(W) service data into their systems.

Protects the register for the applicant for a period of 28 days.

Process flow

Input

Request an official search by sending the following parameters:

  • login details
  • external reference number
  • title number
  • search start date
  • registered proprietors
  • customer reference
  • applicant name
  • priority type
  • contact details
  • property description
  • alternative despatch details

The following parameters will also be necessary if there are any complications, and may be supplied to keep transaction calls and processing times to a minimum.

  • continue despite name mismatch?
  • continue if developing or part?
  • continue if fee confirmation exceeds fee amount?
  • fee confirmation?

Validation

Validation diagram details the validation that the request undergoes.

Validation diagram

This file may not be suitable for users of assistive technology. Request an accessible format.

If you use assistive technology (eg a screen reader) and need a version of this document in a more accessible format, please email customersupport@landregistry.gov.uk. Please tell us what format you need. It will help us if you say what assistive technology you use.

Output

Where manual investigation is required, search despite name mismatch is requested, the system sends an acknowledgement in response to the CMS.

Schemas

RequestOfficialSearchofWholeWithPriorityV2_1.xsd

This file may not be suitable for users of assistive technology. Request an accessible format.

If you use assistive technology (eg a screen reader) and need a version of this document in a more accessible format, please email customersupport@landregistry.gov.uk. Please tell us what format you need. It will help us if you say what assistive technology you use.

This schema provides sample XML for the service.

Schema: RequestOfficialSearchofWholeWithPriorityV2_1Example.xml

This file may not be suitable for users of assistive technology. Request an accessible format.

If you use assistive technology (eg a screen reader) and need a version of this document in a more accessible format, please email customersupport@landregistry.gov.uk. Please tell us what format you need. It will help us if you say what assistive technology you use.

Schema explain describes the request schema for the Request Official Search of Whole priority service.

Schema explain (Request Official Search of Whole with Priority)

This file may not be suitable for users of assistive technology. Request an accessible format.

If you use assistive technology (eg a screen reader) and need a version of this document in a more accessible format, please email customersupport@landregistry.gov.uk. Please tell us what format you need. It will help us if you say what assistive technology you use.

ResponseOfficialSearchOfWholeWithPriorityV2_0.xsd

This file may not be suitable for users of assistive technology. Request an accessible format.

If you use assistive technology (eg a screen reader) and need a version of this document in a more accessible format, please email customersupport@landregistry.gov.uk. Please tell us what format you need. It will help us if you say what assistive technology you use.

Vendor testing

This documents the data for testing the service

Vendor test data

This file may not be suitable for users of assistive technology. Request an accessible format.

If you use assistive technology (eg a screen reader) and need a version of this document in a more accessible format, please email customersupport@landregistry.gov.uk. Please tell us what format you need. It will help us if you say what assistive technology you use.