--- title: "Submit an OS1 Official Search of Whole with Priority application" method: POST path: "/v1/official-searches-of-whole" tags: ["Official Search of Whole with Data"] --- # Submit an OS1 Official Search of Whole with Priority application `POST /v1/official-searches-of-whole` Official search with priority by a purchaser against the whole of a registered title or pending first registration application ## Request body - OfficialSearchRequest - `message_id` string, 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_number` string, required — Provides the subject property title number which is the subject of the transaction, or on which a search is being prepared - `official_search_of_whole_with_priority` OfficialSearchOfWholeWithPriority, required - `priority_type` 'Purchase' | 'Lease' | 'Charge', required — The disposition that the search is intended to protect, namely, purchase, lease or charge - `property_description` string, required — This will be used if the proprietor names do not match and the CMS System wants to continue with manual investigation without warning. This will also be used if Title is not computerised and the CMS System wants to continue with manual investigation without warning - `search_from_date` string, date — If the Is First Registration = FALSE the Search From Date is mandatory and is the date falling within the defintition of search from date in rule 131 of the Land Registration rules 2003. Search From Date restricts dates prior to 1800-01-01. - `continue_application_if` string[], required - `registered_proprietors_details_or_applicants_for_first_registration` string, required — Name(s) of the registered proprietor(s) as on the register required for OS1 OR the person who is applying for first registration, e.g. the owner (NOT the conveyancer sending the application) - `applicant_party` string, required — The full name(s) of the registered proprietor(s) of the registered estate in the title, or the person(s) applying for first registration of the property. If there are more than two, enter the first two only - `external_reference` Reference, required — 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 the name of the Company that has allocated it - `reference` string, required — A unique reference given to identify a particular request, order or instruction in the system of the organisation allocating it. - `allocated_by` string — The name of the organisation that has allocated the Reference - `description` string — This field can be used to provide reference description - `customer_reference` Reference, required — 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 the name of the Company that has allocated it - `reference` string, required — A unique reference given to identify a particular request, order or instruction in the system of the organisation allocating it. - `allocated_by` string — The name of the organisation that has allocated the Reference - `description` string — This field can be used to provide reference description - `expected_price` Price — Information about price - `gross_price_amount` number — The gross price is the price including the VAT. If the VAT is zero then the Gross and Net Price will be the same - `net_price_amount` number — The Net Price is the amount before the VAT is added on. If the VAT is zero then the Gross and Net Price will be the same - `vat_amount` number — This is the amount of the VAT - `currency_id` string — The currency code to be used inline with standard ISO 4217 code identifying a currency. - `contact` Contact[], required - `name` string, required — The name of this contact person or department - `telephone_number` string, required — Contact phone number ## Response `201` Official Search of Whole with Priority completed. Search result enclosed - object - `data` OfficialSearchCreatedResponseData, required — This is the Business Gateway confirmation response to the External System for applications that generate an automatic response including a result PDF - `id` 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 request. - `hmlr_reference` string, required — A unique reference given to identify a particular request, order or instruction in the system of the organisation allocating it - `external_reference` Reference, required — 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 the name of the Company that has allocated it - `reference` string, required — A unique reference given to identify a particular request, order or instruction in the system of the organisation allocating it. - `allocated_by` string — The name of the organisation that has allocated the Reference - `description` string — This field can be used to provide reference description - `actual_price` Price, required — Information about price - `gross_price_amount` number — The gross price is the price including the VAT. If the VAT is zero then the Gross and Net Price will be the same - `net_price_amount` number — The Net Price is the amount before the VAT is added on. If the VAT is zero then the Gross and Net Price will be the same - `vat_amount` number — This is the amount of the VAT - `currency_id` string — The currency code to be used inline with standard ISO 4217 code identifying a currency. - `certificate` Certificate, required — 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' there will be a base64 encoded string which has the contents of the certificate. - `type` 'LINK' | 'ATTACHMENT', required - `link` string — S3 link to download pdf certificate - `attachment` string, byte, required — Base64-encoded contents of the pdf certificate - `warning_message` string — The search has been lodged, but supplementary data may not be available. - `acknowledgement_message` string — An acknowledgement in support of the status of the submitted Official Search - `official_search_data` OfficialSearchData - `search_from_date` string, date, required — The date falling within the definition of search from date in rule 131 of the Land Registration Rules 2003 - `has_register_changed` boolean — Indicates if the register has changed since the Search from date supplied in the request - `has_advisory_entries` boolean — Indicates if the response has any advisory entries - `proprietor_names` string[] — Provided if the value of request object registered_proprietors_details_or_applicants_for_first_registration does not match with Land Registry's proprietorship register - `official_search_number` string — The Official Search Number, also known as Certificate Number, as shown in the result PDF certificate - `certificate_timestamp` string, date-time — The certificate date and time of a pending official search of whole - `priority_period_expiry_date` string, date — The date at which the priority period ends as defined in rule 131 of the Land Registration Rules 2003 - `title_number` string, required — Provides the subject property title number which is the subject of the transaction, or on which a search is being prepared - `applicants` string, required — The full name(s) of the registered proprietor(s) of the registered estate in the title, or the person(s) applying for first registration of the property - `result_entries` ResultEntries — The Result section of the OS1R document - `register_status_entry` RegisterStatusEntry, required — Entry that describes the status of the register as shown in the OS1R result - `entry_text` string, required — The text of the entry as it appears in the official search certificate - `official_copy_timestamp` string, date-time — The date and time of an official copy of a register - `advisory_entries` AdvisoryEntry[] — Advisory entries as shown on the OS1R result - `entry_text` string, required - `name_mismatch` NameMismatch — Provided if the value of request object registered_proprietors_details_or_applicants_for_first_registration does not match with Land Registry's proprietorship register - `registered_proprietor_names` string[], required - `commonhold_title` CommonholdTitle — Provided if the searched for title number is part of a commonhold title - `commonhold_title_number` string, required — Provides the subject property title number which is the subject of the transaction, or on which a search is being prepared - `warning_message` string — The search has been lodged, but supplementary data may not be available. - `pending_official_searches_of_whole` PendingOfficialSearchesOfWhole[] - `certificate_timestamp` string, date-time, required — The certificate date and time of a pending official search of whole - `priority_type` 'Purchase' | 'Lease' | 'Charge', required — The disposition that the search is intended to protect, namely, purchase, lease or charge - `applicant` string, required — The name of the applicants from the applicant_pending_search - `key_number` string — A unique identifier for a user account ## Other responses - `202` — Official Search of Whole with Priority accepted however not completed because manual processing is required - `4XX` - `5XX` — An error has occurred. --- [API](https://skmtc.net/hm-land-registry/apis/official-search-of-whole-with-data.md) · [All operations](https://skmtc.net/hm-land-registry/apis/official-search-of-whole-with-data/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hm-land-registry/official-search-of-whole-with-data/revisions/50575b59f926/schema)