v4

latestOpenAPI 3.1.0raw.githubusercontent.com2024-01-1112852.1 KB
Official Search of Whole with Data

Submit an OS1 Official Search of Whole with Priority application

Official search with priority by a purchaser against the whole of a registered title or pending first registration application

post/v1/official-searches-of-whole

Request body

message_idstring required

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 request.

title_numberstring required

Provides the subject property title number which is the subject of the transaction, or on which a search is being prepared

Example request

{
  "message_id": "dfcacc5e-456e-4fd1-88e5-8070e43d6714",
  "title_number": "DN958744",
  "official_search_of_whole_with_priority": {
    "property_description": "28a Richmond Avenue, Basingstoke, RG38 8DJ",
    "search_from_date": "2022-02-12",
    "continue_application_if": [
      "NAME_MISMATCH_ON_REGISTER",
      "DEVELOPER_TITLE"
    ],
    "registered_proprietors_details_or_applicants_for_first_registration": "Smith",
    "applicant_party": "Acme Bank PLC"
  },
  "external_reference": {
    "reference": "GB000123Z",
    "allocated_by": "AAA Conveyancers",
    "description": "Reference description"
  },
  "customer_reference": {
    "reference": "GB000123Z",
    "allocated_by": "AAA Conveyancers",
    "description": "Reference description"
  },
  "expected_price": {
    "gross_price_amount": 3.75,
    "net_price_amount": 3,
    "vat_amount": 0.75,
    "currency_id": "GBP"
  },
  "contact": [
    {
      "name": "John Smith"
    }
  ]
}

Response

Official Search of Whole with Priority completed. Search result enclosed

Example response

{
  "data": {
    "id": "dfcacc5e-456e-4fd1-88e5-8070e43d6714",
    "hmlr_reference": "J111AAA",
    "external_reference": {
      "reference": "GB000123Z",
      "allocated_by": "AAA Conveyancers",
      "description": "Reference description"
    },
    "actual_price": {
      "gross_price_amount": 3.75,
      "net_price_amount": 3,
      "vat_amount": 0.75,
      "currency_id": "GBP"
    },
    "warning_message": "Result entries are not available as data. Please read the attached OS1 result.",
    "acknowledgement_message": "We have accepted your application for an official search with priority. Priority begins now and expires on 24 May 2022.",
    "official_search_data": {
      "official_search_number": "124-A0-B8",
      "title_number": "DN958744",
      "applicants": "John Smith and Jane Smith",
      "result_entries": {
        "advisory_entries": [
          {
            "name_mismatch": {
              "registered_proprietor_names": [
                "John Smith",
                "Jane Smith"
              ]
            },
            "commonhold_title": {
              "commonhold_title_number": "DN958744"
            },
            "warning_message": "Advisory entries are not available as data. Please read the attached OS1 result."
          }
        ]
      },
      "key_number": "1234567"
    }
  }
}