{"swagger":"2.0","info":{"version":"v1","title":"ACS Title Expert"},"host":"www.titleexpert.co.uk","schemes":["https"],"paths":{"/api/{clientid}/addressmatch/normalise":{"post":{"tags":["Address Normalisation and Matching"],"summary":"Normalise an address by concatenating lines, singling multiple spaces, removing punctuation and doing things like replacing \"Road\" by \"Rd\".","operationId":"AddressMatch_Normalise","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"Address","in":"body","description":"The address to be normalised.","required":true,"schema":{"$ref":"#/definitions/RawAddress"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Address"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"}},"security":[{"basic":[]}]}},"/api/{clientid}/addressmatch/match":{"post":{"tags":["Address Normalisation and Matching"],"summary":"Compares two addresses on a \"logical first line and postcode\" basis.","operationId":"AddressMatch_Match","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"Addresses","in":"body","description":"The addresses to be compared.","required":true,"schema":{"$ref":"#/definitions/AddressMatchRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddressMatchResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"}},"security":[{"basic":[]}]}},"/api/{client}/edrs":{"post":{"tags":["Application to Change Register (eDRS)"],"summary":"Starts a new Application to Change Register comprising one or more individual application entries, the priority of which are implied by their order. Supporting Documents must be attached separately. The Application is not sent to the Land Registry until submit is called.","operationId":"Edrs_ApplicationBegin","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/EdrsRequest"}},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicationStatus"}}},"security":[{"basic":[]}]}},"/api/{client}/edrs/{application}":{"get":{"tags":["Application to Change Register (eDRS)"],"summary":"Obtains the current status of an eDRS Application, related Attachments and Requisitions.","operationId":"Edrs_ApplicationStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"application","in":"path","required":true,"type":"string","format":"uuid"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicationStatus"}},"404":{"description":"Identified eDRS request does not exist"}},"security":[{"basic":[]}]}},"/api/{client}/edrs/search/ref/{mode}/{reference}":{"get":{"tags":["Application to Change Register (eDRS)"],"summary":"Searches for eDRS Applications by reference provided in original request.","operationId":"Edrs_ApplicationsByReference","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"mode","in":"path","required":true,"type":"string","enum":["begins","contains","exactly"]},{"name":"reference","in":"path","required":true,"type":"string"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ApplicationSummary"}}}},"security":[{"basic":[]}]}},"/api/{client}/edrs/{application}/submit":{"post":{"tags":["Application to Change Register (eDRS)"],"summary":"Begins the process of sending an Application to Change Register to the Land Registry with attached documents.","operationId":"Edrs_ApplicationSubmit","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"application","in":"path","required":true,"type":"string","format":"uuid"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Application has been successfully submitted and will be conveyed to Land Registry"},"400":{"description":"Application or Attachment/s are not in an appropriate state for Submission"},"404":{"description":"Identified eDRS request does not exist"}},"security":[{"basic":[]}]}},"/api/{client}/edrs/next-complete":{"get":{"tags":["Application to Change Register (eDRS)"],"summary":"Obtain the next unacknowledged notification that an Application to Change Register has completed. The event name may be Complete (see Subject status) or EarlyComplete. A returned event must be acknowledged (within nominal time window) to prevent repeat notification.","operationId":"Edrs_ApplicationNextComplete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"An Event was dequeued and must be acknoewledged when processing is complete"},"204":{"description":"There was no event to dequeue"}},"security":[{"basic":[]}]}},"/api/{client}/edrs/{application}/attachment":{"post":{"tags":["Application to Change Register (eDRS)"],"summary":"Appends a Supporting Document to an Application to Change Register. Document content must be uploaded separately.","operationId":"Edrs_AttachmentAppend","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"application","in":"path","required":true,"type":"string","format":"uuid"},{"name":"attachment","in":"body","required":true,"schema":{"$ref":"#/definitions/AppendAttachment"}},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AttachmentAppended"}},"400":{"description":"Application is already completed or is otherwise not in an appropriate state"},"404":{"description":"Application does not exist"}},"security":[{"basic":[]}]}},"/api/{client}/edrs/{application}/notes":{"post":{"tags":["Application to Change Register (eDRS)"],"summary":"Appends textual notes to an Application to Change Register as a Supporting Document.","operationId":"Edrs_AttachmentAppendNotes","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"application","in":"path","required":true,"type":"string","format":"uuid"},{"name":"notes","in":"body","required":true,"schema":{"$ref":"#/definitions/AppendNotes"}},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AttachmentAppended"}},"400":{"description":"Application is already completed or is otherwise not in an appropriate state"},"404":{"description":"Application does not exist"}},"security":[{"basic":[]}]}},"/api/{client}/edrs/attachment/{attachment}":{"get":{"tags":["Application to Change Register (eDRS)"],"summary":"Downloads the content of a previously uploaded Attachment.","operationId":"Edrs_AttachmentDownload","consumes":[],"produces":["application/octet-stream","application/json","text/json"],"parameters":[{"name":"attachment","in":"path","description":"","required":true,"type":"string","format":"uuid"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"400":{"description":"Attachment is not in an appropriate state (content has not been received)"},"404":{"description":"The attachment does not exist"}},"security":[{"basic":[]}]},"put":{"tags":["Application to Change Register (eDRS)"],"summary":"Establishes the content of a Primary or Supporting Document against an Application to Change Register.","operationId":"Edrs_AttachmentUpload","consumes":["application/octet-stream"],"produces":["application/json","text/json"],"parameters":[{"name":"attachment","in":"path","required":true,"type":"string","format":"uuid"},{"name":"client","in":"path","required":true,"type":"string"},{"name":"body","in":"body","schema":{"format":"binary","type":"string"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"basic":[]}]}},"/api/{client}/edrs/attachment/next-event":{"get":{"tags":["Application to Change Register (eDRS)"],"summary":"Obtain the next unacknowledged notification that an attachment has been accepted or rejected by the Land Registry. A returned event must be acknowledged (within nominal time window) to prevent repeat notification. Rejected attachments may be replaced by subsequent upload of new content.","operationId":"Edrs_AttachmentNextComplete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"An Event was dequeued and must be acknoewledged when processing is complete"},"204":{"description":"There was no Event to dequeue"}},"security":[{"basic":[]}]}},"/api/{client}/edrs/requisition/next-ready":{"get":{"tags":["Application to Change Register (eDRS)"],"summary":"Obtain the next unacknowledged notification that a piece of correspondence (Requisition) is available from the Land Registry. A returned event must be acknowledged (within nominal time window) to prevent repeat notification.","operationId":"Edrs_RequisitionNextReady","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"An Event was dequeued and must be acknowledged when processing is complete"},"204":{"description":"There was no Event to dequeue"}},"security":[{"basic":[]}]}},"/api/{client}/edrs/requisition/{requisition}":{"get":{"tags":["Application to Change Register (eDRS)"],"summary":"Obtains the identified correpondence document.","operationId":"Edrs_RequisitionDownload","consumes":[],"produces":["application/octet-stream","application/json","text/json"],"parameters":[{"name":"requisition","in":"path","required":true,"type":"string","format":"uuid"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"400":{"description":"The requisition is not in an appropriate state for download"},"404":{"description":"The requisition does not exist"}},"security":[{"basic":[]}]}},"/api/{client}/edrs/result/{result}":{"get":{"tags":["Application to Change Register (eDRS)"],"summary":"Obtains a result document; typically PDF or Register Extract XML.","operationId":"Edrs_ResultDownload","consumes":[],"produces":["application/octet-stream","application/json","text/json"],"parameters":[{"name":"result","in":"path","required":true,"type":"string","format":"uuid"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"400":{"description":"Application has not completed"},"404":{"description":"Identified eDRS request or result document does not exist"}},"security":[{"basic":[]}]}},"/api/{clientid}/bankruptcysearches":{"get":{"tags":["Bankruptcy Search (K16)"],"summary":"Search for Bankruptcy Search requests meeting the specified criteria.","operationId":"BankruptcySearch_Search","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"status","in":"query","description":"Optional. Values allowed are: pending, complete, failed, cancelled, expired. Prepend ! to invert.","required":false,"type":"string"},{"name":"statussince","in":"query","description":"Optional. Searches for requests whose status last changed at/after the specified UTC date/time (ISO8601/like format yyyy-MM-dd HH:mm:ss).","required":false,"type":"string"},{"name":"acknowledged","in":"query","description":"Optional. Whether to search for requests that have (1, y, yes, true) or have not (0, n, no, false) been Acknowledged.","required":false,"type":"string"},{"name":"clientref","in":"query","description":"Optional reference provided when request was submitted.","required":false,"type":"string"},{"name":"order","in":"query","description":"Optional. Order by date request started; values allowed are: oldestfirst (default), newestfirst.","required":false,"type":"string"},{"name":"maxentries","in":"query","description":"Optional. Limits the number of requests returned.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BankruptcyResponse"}}},"400":{"description":"Invalid search criteria","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"No requests were found that meet the provided criteria"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]},"post":{"tags":["Bankruptcy Search (K16)"],"summary":"Issue a K16 request, Bankruptcy Search. This will incur a charge.","operationId":"BankruptcySearch_CreateRequest","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"BankruptcySearchRequest","in":"body","description":"Details of the name(s) to check for bankruptcy.","required":true,"schema":{"$ref":"#/definitions/BankruptcyRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/BankruptcyResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"402":{"description":"The request limit has been reached"},"403":{"description":"You are not permitted to submit new requests for this service"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/bankruptcysearches/{requestid}":{"get":{"tags":["Bankruptcy Search (K16)"],"summary":"Get the current status of a Bankruptcy Search request.","operationId":"BankruptcySearch_GetRequest","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BankruptcyResponse"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/bankruptcysearches/{requestid}/{documentid}":{"get":{"tags":["Bankruptcy Search (K16)"],"summary":"Get one of the documents returned by a Bankruptcy Search request.","operationId":"BankruptcySearch_GetDocument","consumes":[],"produces":["application/octet-stream","application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"},{"name":"documentid","in":"path","description":"The id of the particular document.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid or documentid is invalid or does not refer to an available document"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/bankruptcysearches/get-next-ready":{"post":{"tags":["Bankruptcy Search (K16)"],"summary":"Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.","operationId":"BankruptcySearch_DequeueNextReadyForAck","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitleDataResponse"}},"204":{"description":"There are no requests awaiting acknowledgement at the moment"},"401":{"description":"Invalid or missing user name or password"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/bankruptcysearches/{requestid}/ack-next-ready":{"post":{"tags":["Bankruptcy Search (K16)"],"summary":"Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.","operationId":"BankruptcySearch_AcknowledgeDequeued","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/bankruptcysearches/{requestid}/ack":{"post":{"tags":["Bankruptcy Search (K16)"],"summary":"(DEPRECATED) Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.","operationId":"BankruptcySearch_AcknowledgeRequest","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"deprecated":true,"security":[{"basic":[]}]}},"/api/{clientid}/customcheck/BorrowerNameMatch":{"get":{"tags":["Borrower Name Match"],"summary":"Search for Borrower Name Match requests meeting the specified criteria.","operationId":"BorrowerNameMatch_SearchRequests","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"status","in":"query","description":"Optional. Values allowed are: pending, complete, failed, cancelled, expired. Prepend ! to invert.","required":false,"type":"string"},{"name":"statussince","in":"query","description":"Optional. Searches for requests whose status last changed at/after the specified UTC date/time (ISO8601/like format yyyy-MM-dd HH:mm:ss).","required":false,"type":"string"},{"name":"acknowledged","in":"query","description":"Optional. Whether to search for requests that have (1, y, yes, true) or have not (0, n, no, false) been Acknowledged.","required":false,"type":"string"},{"name":"clientref","in":"query","description":"Optional reference provided when request was submitted.","required":false,"type":"string"},{"name":"titledataid","in":"query","description":"Optional id of the TitleData request that was used as the source data for Custom Check/s.","required":false,"type":"string"},{"name":"order","in":"query","description":"Optional. Order by date request started; values allowed are: oldestfirst (default), newestfirst.","required":false,"type":"string"},{"name":"maxentries","in":"query","description":"Optional. Limits the number of requests returned.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BorrowerNameMatchResponse"}}},"400":{"description":"Invalid search criteria","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"No requests were found that meet the provided criteria"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]},"post":{"tags":["Borrower Name Match"],"summary":"Check the supplied set of borrower names against the registered proprietors in the identified TitleData request.","operationId":"BorrowerNameMatch_CreateRequest","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"BorrowerNameMatchRequest","in":"body","description":"Details of the check to be performed.","required":true,"schema":{"$ref":"#/definitions/BorrowerNameMatchRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/BorrowerNameMatchResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/customcheck/BorrowerNameMatch/{requestid}":{"get":{"tags":["Borrower Name Match"],"summary":"Retrieve the results of a Borrower Name Match.","operationId":"BorrowerNameMatch_GetRequest","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the check whose status/results are to be retrieved.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BorrowerNameMatchResponse"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The checkid parameter is invalid or does not refer to a proper request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/customcheck/BorrowerNameMatch/get-next-ready":{"post":{"tags":["Borrower Name Match"],"summary":"Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.","operationId":"BorrowerNameMatch_DequeueNextReadyForAck","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BorrowerNameMatchResponse"}},"204":{"description":"There are no requests awaiting acknowledgement at the moment"},"401":{"description":"Invalid or missing user name or password"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/customcheck/BorrowerNameMatch/{requestid}/ack-next-ready":{"post":{"tags":["Borrower Name Match"],"summary":"Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.","operationId":"BorrowerNameMatch_AcknowledgeDequeued","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/customcheck/BorrowerNameMatch/{requestid}/ack":{"post":{"tags":["Borrower Name Match"],"summary":"(DEPRECATED) Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.","operationId":"BorrowerNameMatch_AcknowledgeRequest","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"deprecated":true,"security":[{"basic":[]}]}},"/api/{client}/event/{event}/ack":{"post":{"tags":["Event"],"summary":"Acknowledges the receipt of an Event relating to some request, such as after having processed the results. This prevents repeat notifications of the Event.","operationId":"Event_AcknowledgeEvent","consumes":[],"produces":[],"parameters":[{"name":"event","in":"path","required":true,"type":"string","format":"uuid"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"200":{"description":"Event has been acknowledged and subsequent notification will not occur"},"400":{"description":"Event is not in an appropriate state to be Acknowledged"},"404":{"description":"Event was not found"},"500":{"description":"InternalServerError"}},"security":[{"basic":[]}]}},"/api/{clientid}/searchesofwhole":{"get":{"tags":["Official Search of Whole with Priority (OS1)"],"summary":"Search for Official Search requests meeting the specified criteria.","operationId":"SearchOfWhole_Search","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"status","in":"query","description":"Optional. Values allowed are: pending, complete, failed, cancelled, expired. Prepend ! to invert.","required":false,"type":"string"},{"name":"statussince","in":"query","description":"Optional. Searches for requests whose status last changed at/after the specified UTC date/time (ISO8601/like format yyyy-MM-dd HH:mm:ss).","required":false,"type":"string"},{"name":"acknowledged","in":"query","description":"Optional. Whether to search for requests that have (1, y, yes, true) or have not (0, n, no, false) been Acknowledged.","required":false,"type":"string"},{"name":"clientref","in":"query","description":"Optional reference provided when request was submitted.","required":false,"type":"string"},{"name":"title","in":"query","description":"Optional title number.","required":false,"type":"string"},{"name":"order","in":"query","description":"Optional. Order by date request started; values allowed are: oldestfirst (default), newestfirst.","required":false,"type":"string"},{"name":"maxentries","in":"query","description":"Optional. Limits the number of requests returned.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/OfficialSearchResponse"}}},"400":{"description":"Invalid search criteria","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"No requests were found that meet the provided criteria"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]},"post":{"tags":["Official Search of Whole with Priority (OS1)"],"summary":"Issue an OS1 request, Official Search of Whole with Priority. This will incur a charge.","operationId":"SearchOfWhole_CreateRequest","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"OfficialSearchRequest","in":"body","description":"Details of the Official Search being requested.","required":true,"schema":{"$ref":"#/definitions/OfficialSearchRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/OfficialSearchResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"402":{"description":"The request limit has been reached"},"403":{"description":"You are not permitted to submit new requests for this service"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/searchesofwhole/{requestid}":{"get":{"tags":["Official Search of Whole with Priority (OS1)"],"summary":"Get the current status of an Official Search request.","operationId":"SearchOfWhole_GetRequest","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OfficialSearchResponse"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/searchesofwhole/{requestid}/{documentid}":{"get":{"tags":["Official Search of Whole with Priority (OS1)"],"summary":"Get one of the documents returned by an Official Search request.","operationId":"SearchOfWhole_GetDocument","consumes":[],"produces":["application/octet-stream","application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"},{"name":"documentid","in":"path","description":"The id of the particular document.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid or documentid is invalid or does not refer to an available document"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/searchesofwhole/get-next-ready":{"post":{"tags":["Official Search of Whole with Priority (OS1)"],"summary":"Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.","operationId":"SearchOfWhole_DequeueNextReadyForAck","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitleDataResponse"}},"204":{"description":"There are no requests awaiting acknowledgement at the moment"},"401":{"description":"Invalid or missing user name or password"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/searchesofwhole/{requestid}/ack-next-ready":{"post":{"tags":["Official Search of Whole with Priority (OS1)"],"summary":"Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.","operationId":"SearchOfWhole_AcknowledgeDequeued","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/searchesofwhole/{requestid}/ack":{"post":{"tags":["Official Search of Whole with Priority (OS1)"],"summary":"(DEPRECATED) Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.","operationId":"SearchOfWhole_AcknowledgeRequest","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"deprecated":true,"security":[{"basic":[]}]}},"/api/{clientid}/ownershipverify":{"get":{"tags":["Online Ownership Verification (OOV)"],"summary":"Search for Online Ownership Verification requests meeting the specified criteria.","operationId":"OwnershipVerification_SearchRequests","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"status","in":"query","description":"Optional. Values allowed are: pending, complete, failed, cancelled, expired. Prepend ! to invert.","required":false,"type":"string"},{"name":"statussince","in":"query","description":"Optional. Searches for requests whose status last changed at/after the specified UTC date/time (ISO8601/like format yyyy-MM-dd HH:mm:ss).","required":false,"type":"string"},{"name":"acknowledged","in":"query","description":"Optional. Whether to search for requests that have (1, y, yes, true) or have not (0, n, no, false) been Acknowledged.","required":false,"type":"string"},{"name":"clientref","in":"query","description":"Optional reference provided when request was submitted.","required":false,"type":"string"},{"name":"title","in":"query","description":"Optional title number.","required":false,"type":"string"},{"name":"order","in":"query","description":"Optional. Order by date request started; values allowed are: oldestfirst (default), newestfirst.","required":false,"type":"string"},{"name":"maxentries","in":"query","description":"Optional. Limits the number of requests returned.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/OwnerVerifyResponse"}}},"400":{"description":"Invalid search criteria","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"No requests were found that meet the provided criteria"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/ownershipverify/title":{"post":{"tags":["Online Ownership Verification (OOV)"],"summary":"Issue a request for Online Ownership Verification against a known Title Number. This will incur a charge.","operationId":"OwnershipVerification_VerifyByTitle","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"VerifyRequest","in":"body","description":"Details of the Ownership Verification request.","required":true,"schema":{"$ref":"#/definitions/OwnerVerifyByTitleRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/OwnerVerifyResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"402":{"description":"The request limit has been reached"},"403":{"description":"You are not permitted to submit new requests for this service"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/ownershipverify/address":{"post":{"tags":["Online Ownership Verification (OOV)"],"summary":"Issue a request for Online Ownership Verification against a property address. This will incur a charge.","operationId":"OwnershipVerification_VerifyByAddress","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"VerifyRequest","in":"body","description":"Details of the Ownership Verification request.","required":true,"schema":{"$ref":"#/definitions/OwnerVerifyByAddressRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/OwnerVerifyResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"402":{"description":"The request limit has been reached"},"403":{"description":"You are not permitted to submit new requests for this service"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/ownershipverify/{requestid}":{"get":{"tags":["Online Ownership Verification (OOV)"],"summary":"Get the current status of an Online Ownership Verification request.","operationId":"OwnershipVerification_GetResponse","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OwnerVerifyResponse"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to an Online Ownership Verification request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/ownershipverify/{requestid}/results":{"get":{"tags":["Online Ownership Verification (OOV)"],"summary":"Get the results of a complete Online Ownership Verification request.","operationId":"OwnershipVerification_GetResults","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OwnerVerifyResult"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"Either the requestid parameter is invalid or the results are otherwise unavailable"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/ownershipverify/get-next-ready":{"post":{"tags":["Online Ownership Verification (OOV)"],"summary":"Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.","operationId":"OwnershipVerification_DequeueNextReadyForAck","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitleDataResponse"}},"204":{"description":"There are no requests awaiting acknowledgement at the moment"},"401":{"description":"Invalid or missing user name or password"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/ownershipverify/{requestid}/ack-next-ready":{"post":{"tags":["Online Ownership Verification (OOV)"],"summary":"Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.","operationId":"OwnershipVerification_AcknowledgeDequeued","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/ownershipverify/{requestid}/ack":{"post":{"tags":["Online Ownership Verification (OOV)"],"summary":"(DEPRECATED) Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.","operationId":"OwnershipVerification_AcknowledgeRequest","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"deprecated":true,"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/repeat":{"post":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Issue a Request for Title Check based on title data obtained in a previous Request.","operationId":"TitleCheck_CreateCheckRequest","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"request","in":"body","description":"Details of the Title Data request.","required":true,"schema":{"$ref":"#/definitions/TitleCheckRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TitleDataResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"402":{"description":"The request limit has been reached"},"403":{"description":"You are not permitted to submit new requests for this service"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks":{"get":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Search for Title Data requests meeting the specified criteria.","operationId":"TitleCheck_Search","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"status","in":"query","description":"Optional. Values allowed are: pending, complete, failed, cancelled, expired. Prepend ! to invert.","required":false,"type":"string"},{"name":"statussince","in":"query","description":"Optional. Searches for requests whose status last changed at/after the specified UTC date/time (ISO8601/like format yyyy-MM-dd HH:mm:ss).","required":false,"type":"string"},{"name":"acknowledged","in":"query","description":"Optional. Whether to search for requests that have (1, y, yes, true) or have not (0, n, no, false) been Acknowledged.","required":false,"type":"string"},{"name":"clientref","in":"query","description":"Optional reference provided when request was submitted.","required":false,"type":"string"},{"name":"title","in":"query","description":"Optional title number.","required":false,"type":"string"},{"name":"order","in":"query","description":"Optional. Order by date request started; values allowed are: oldestfirst (default), newestfirst.","required":false,"type":"string"},{"name":"maxentries","in":"query","description":"Optional. Limits the number of requests returned.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TitleDataResponse"}}},"400":{"description":"Invalid search criteria","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"No requests were found that meet the provided criteria"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]},"post":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Issue a request for Title Data and perform title checks. This will incur a charge.","operationId":"TitleCheck_CreateDataRequest","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"TitleDataRequest","in":"body","description":"Details of the Title Data request.","required":true,"schema":{"$ref":"#/definitions/TitleDataRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TitleDataResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"402":{"description":"The request limit has been reached"},"403":{"description":"You are not permitted to submit new requests for this service"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/xml":{"post":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Issue a request for Title Checking of user-supplied Title Data and optional Documents.","operationId":"TitleCheck_CreateCheckXmlRequest","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"TitleCheckRequest","in":"body","description":"Details of the Title Check request.","required":true,"schema":{"$ref":"#/definitions/TitleCheckXmlRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TitleDataResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"402":{"description":"The request limit has been reached"},"403":{"description":"You are not permitted to submit new requests for this service"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/{requestid}":{"get":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Get the current status of a Title Data request.","operationId":"TitleCheck_GetRequest","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitleDataResponse"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a Title Data request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/{requestid}/{documentid}":{"get":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Get one of the documents for a Title Data request.","operationId":"TitleCheck_GetDocument","consumes":[],"produces":["application/octet-stream","application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"},{"name":"documentid","in":"path","description":"The id of the particular document.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"Either the requestid or the documentid parameter is invalid or does not refer to an available document"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/{requestid}/resdocument":{"get":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Get the raw Registry Extract Service data for a Title Data request as an XML document.","operationId":"TitleCheck_GetRESDocument","consumes":[],"produces":["application/octet-stream","application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"Either the requestid parameter is invalid or no RES data is available"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/{requestid}/resdata":{"get":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"(DEPRECATED) Get the raw Registry Extract Service data for a Title Data request as an object.","operationId":"TitleCheck_GetRESData","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SavedRESData"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"Either the requestid parameter is invalid or no RES data is available"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"deprecated":true,"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/{requestid}/checkresults":{"get":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Get the massaged data extract and list of issues resulting from a Title Data request.","operationId":"TitleCheck_GetCheckResults","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitleCheckResults"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"Either the requestid parameter is invalid or no results are available"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/{requestid}/checkoutputs":{"get":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Get the check data outputs resulting from a Title Data request.","operationId":"TitleCheck_GetCheckOutputs","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"Either the requestid parameter is invalid or no results are available"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/get-next-ready":{"post":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.","operationId":"TitleCheck_DequeueNextReadyForAck","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitleDataResponse"}},"204":{"description":"There are no requests awaiting acknowledgement at the moment"},"401":{"description":"Invalid or missing user name or password"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/{requestid}/ack-next-ready":{"post":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.","operationId":"TitleCheck_AcknowledgeDequeued","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titlechecks/{requestid}/ack":{"post":{"tags":["Title Data + Checks (RES, Official Copy with Summary)"],"summary":"(DEPRECATED) Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.","operationId":"TitleCheck_AcknowledgeRequest","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"deprecated":true,"security":[{"basic":[]}]}},"/api/{clientid}/documents":{"get":{"tags":["Title Documents (OC2)"],"summary":"Search for Title Documents requests meeting the specified criteria.","operationId":"TitleDocuments_Search","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"status","in":"query","description":"Optional. Values allowed are: pending, complete, failed, cancelled, expired. Prepend ! to invert.","required":false,"type":"string"},{"name":"statussince","in":"query","description":"Optional. Searches for requests whose status last changed at/after the specified UTC date/time (ISO8601/like format yyyy-MM-dd HH:mm:ss).","required":false,"type":"string"},{"name":"acknowledged","in":"query","description":"Optional. Whether to search for requests that have (1, y, yes, true) or have not (0, n, no, false) been Acknowledged.","required":false,"type":"string"},{"name":"clientref","in":"query","description":"Optional reference provided when request was submitted.","required":false,"type":"string"},{"name":"title","in":"query","description":"Optional title number.","required":false,"type":"string"},{"name":"order","in":"query","description":"Optional. Order by date request started; values allowed are: oldestfirst (default), newestfirst.","required":false,"type":"string"},{"name":"maxentries","in":"query","description":"Optional. Limits the number of requests returned.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DocumentsResponse"}}},"400":{"description":"Invalid search criteria","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"No requests were found that meet the provided criteria"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]},"post":{"tags":["Title Documents (OC2)"],"summary":"Issue a request for Title Documents (OC2). Will continue if applications are pending against the Title (returning back-dated) or if closed and continued (under the new Title number). This will incur a charge.","operationId":"TitleDocuments_CreateRequest","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"DocsRequest","in":"body","description":"Details of the documents to be requested.","required":true,"schema":{"$ref":"#/definitions/DocumentsRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/DocumentsResponse"}},"400":{"description":"The request could not be accepted due to one or more issues with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"402":{"description":"The request limit has been reached"},"403":{"description":"You are not permitted to submit new requests for this service"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/documents/{requestid}":{"get":{"tags":["Title Documents (OC2)"],"summary":"Get the current status of a Title Documents request.","operationId":"TitleDocuments_GetRequest","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DocumentsResponse"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/documents/{requestid}/{documentid}":{"get":{"tags":["Title Documents (OC2)"],"summary":"Get one of the documents returned by a Title Documents request.","operationId":"TitleDocuments_GetDocument","consumes":[],"produces":["application/octet-stream","application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"},{"name":"documentid","in":"path","description":"The id of the particular document.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid or documentid is invalid or does not refer to an available document"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/documents/get-next-ready":{"post":{"tags":["Title Documents (OC2)"],"summary":"Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.","operationId":"TitleDocuments_DequeueNextReadyForAck","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitleDataResponse"}},"204":{"description":"There are no requests awaiting acknowledgement at the moment"},"401":{"description":"Invalid or missing user name or password"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/documents/{requestid}/ack-next-ready":{"post":{"tags":["Title Documents (OC2)"],"summary":"Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.","operationId":"TitleDocuments_AcknowledgeDequeued","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/documents/{requestid}/ack":{"post":{"tags":["Title Documents (OC2)"],"summary":"(DEPRECATED) Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.","operationId":"TitleDocuments_AcknowledgeRequest","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"deprecated":true,"security":[{"basic":[]}]}},"/api/{clientid}/titlenumbers":{"get":{"tags":["Title Numbers (ePD, Enquiry by Property Description)"],"summary":"Search for the title number(s) for an address (ePD, Enquiry by Property Description).","operationId":"TitleNumbers_Search","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"bname","in":"query","description":"Building name (max 50 chars). Always specify at least one of this and bno.","required":false,"type":"string"},{"name":"bno","in":"query","description":"Building number (max 5 chars). Always specify at least one of this and bname.","required":false,"type":"string"},{"name":"street","in":"query","description":"Street (max 80 chars). If postcode is not specified then specify both street and city.","required":false,"type":"string"},{"name":"city","in":"query","description":"Town or city (max 35 chars). If postcode is not specified then specify both street and city.","required":false,"type":"string"},{"name":"postcode","in":"query","description":"Full postcode, including a space separating the two parts.","required":false,"type":"string","pattern":"^[A-Z]{1,2}[0-9R][0-9A-Z]? [0-9][A-Z-[CIKMOV]]{2}$"},{"name":"tenure","in":"query","description":"Optional comma-separated list of tenure types to filter results. Values allowed are: other, freehold, leasehold, commonhold, feuhold, mixed, unknown, unavailable, caution_against_first_registration, rent_charge, franchise, profit_a_prendre_in_gross, manor.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitleNumbersResult"}},"400":{"description":"Bad query String parameters","schema":{"$ref":"#/definitions/LrbgItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"No matching title numbers found"},"409":{"description":"Too many title numbers found","schema":{"$ref":"#/definitions/LrbgApiError"}},"500":{"description":"Other error","schema":{"$ref":"#/definitions/LrbgApiError"}},"503":{"description":"LRBG ePD service returned \"try again later\""}},"security":[{"basic":[]}]}},"/api/{clientid}/titleplan":{"get":{"tags":["Title Plan (OC1)"],"summary":"Search for Title Plan requests meeting the specified criteria.","operationId":"TitlePlan_Search","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"status","in":"query","description":"Optional. Values allowed are: pending, complete, failed, cancelled, expired. Prepend ! to invert.","required":false,"type":"string"},{"name":"statussince","in":"query","description":"Optional. Searches for requests whose status last changed at/after the specified UTC date/time (ISO8601/like format yyyy-MM-dd HH:mm:ss).","required":false,"type":"string"},{"name":"acknowledged","in":"query","description":"Optional. Whether to search for requests that have (1, y, yes, true) or have not (0, n, no, false) been Acknowledged.","required":false,"type":"string"},{"name":"clientref","in":"query","description":"Optional client reference.","required":false,"type":"string"},{"name":"title","in":"query","description":"Optional title number.","required":false,"type":"string"},{"name":"order","in":"query","description":"Optional. Order by date request started; values allowed are: oldestfirst (default), newestfirst.","required":false,"type":"string"},{"name":"maxentries","in":"query","description":"Optional. Limits the number of requests returned.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TitlePlanResponse"}}},"400":{"description":"Invalid search criteria","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"No matching documents requests were found"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]},"post":{"tags":["Title Plan (OC1)"],"summary":"Issue a request for a Title Plan (OC1). Will continue if applications are pending against the Title (returning back-dated) or if closed and continued (under the new Title number). This will incur a charge.","operationId":"TitlePlan_SubmitRequest","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"TitlePlanRequest","in":"body","description":"Information identifying the plan being requested.","required":true,"schema":{"$ref":"#/definitions/TitlePlanRequest"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TitlePlanResponse"}},"400":{"description":"Something is wrong with the request body","schema":{"$ref":"#/definitions/ItemDetailsApiError"}},"401":{"description":"Invalid or missing user name or password"},"402":{"description":"The request limit has been reached"},"403":{"description":"You are not permitted to submit new requests for this service"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titleplan/{requestid}":{"get":{"tags":["Title Plan (OC1)"],"summary":"Get the current status of a Title Plan request.","operationId":"TitlePlan_GetResult","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitlePlanResponse"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titleplan/{requestid}/{documentid}":{"get":{"tags":["Title Plan (OC1)"],"summary":"Gets the Title Plan PDF.","operationId":"TitlePlan_GetDocument","consumes":[],"produces":["application/octet-stream","application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"},{"name":"documentid","in":"path","description":"The id of the particular document.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"Either the requestid or the documentid parameter is invalid or does not refer to an available document"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titleplan/get-next-ready":{"post":{"tags":["Title Plan (OC1)"],"summary":"Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.","operationId":"TitlePlan_DequeueNextReadyForAck","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TitleDataResponse"}},"204":{"description":"There are no requests awaiting acknowledgement at the moment"},"401":{"description":"Invalid or missing user name or password"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titleplan/{requestid}/ack-next-ready":{"post":{"tags":["Title Plan (OC1)"],"summary":"Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.","operationId":"TitlePlan_AcknowledgeDequeued","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"basic":[]}]}},"/api/{clientid}/titleplan/{requestid}/ack":{"post":{"tags":["Title Plan (OC1)"],"summary":"(DEPRECATED) Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.","operationId":"TitlePlan_AcknowledgeRequest","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientid","in":"path","description":"Your client id.","required":true,"type":"string"},{"name":"requestid","in":"path","description":"The id of the request.","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Success. The Request has been marked as Acknowledged"},"400":{"description":"The Request is not in an appropriate state to be Acknowledged"},"401":{"description":"Invalid or missing user name or password"},"404":{"description":"The requestid parameter is invalid or does not refer to a proper Request"},"500":{"description":"Other error","schema":{"$ref":"#/definitions/ApiError"}}},"deprecated":true,"security":[{"basic":[]}]}},"/api/{client}/users":{"get":{"tags":["Users"],"operationId":"Users_ListUsers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TeUser"}}}},"security":[{"basic":[]}]},"post":{"tags":["Users"],"operationId":"Users_AddUser","consumes":["text/plain"],"produces":["application/json","text/json"],"parameters":[{"name":"body","in":"body","required":true,"schema":{"format":"binary","type":"string"}},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TeUser"}}},"security":[{"basic":[]}]}},"/api/{client}/users/roles":{"get":{"tags":["Users"],"operationId":"Users_ListRoles","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"basic":[]}]}},"/api/{client}/user/{user}/roles":{"get":{"tags":["Users"],"operationId":"User_ListUserRoles","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"user","in":"path","required":true,"type":"string"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"basic":[]}]},"post":{"tags":["Users"],"operationId":"User_AddUserRole","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"user","in":"path","required":true,"type":"string"},{"name":"role","in":"query","required":true,"type":"string"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"basic":[]}]}},"/api/{client}/user/{user}":{"get":{"tags":["Users"],"operationId":"User_GetUser","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"user","in":"path","required":true,"type":"string"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TeUser"}}},"security":[{"basic":[]}]},"delete":{"tags":["Users"],"operationId":"User_DeleteUser","consumes":[],"produces":[],"parameters":[{"name":"user","in":"path","required":true,"type":"string"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"security":[{"basic":[]}]}},"/api/{client}/user/{user}/disable":{"post":{"tags":["Users"],"operationId":"User_DisableUser","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"user","in":"path","required":true,"type":"string"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TeUser"}}},"security":[{"basic":[]}]}},"/api/{client}/user/{user}/enable":{"post":{"tags":["Users"],"operationId":"User_EnableUser","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"user","in":"path","required":true,"type":"string"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TeUser"}}},"security":[{"basic":[]}]}},"/api/{client}/user/{user}/role/{role}":{"delete":{"tags":["Users"],"operationId":"User_RemoveUserRole","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"user","in":"path","required":true,"type":"string"},{"name":"role","in":"path","required":true,"type":"string"},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"basic":[]}]}},"/api/{client}/user/{user}/lrbg":{"put":{"tags":["Users"],"operationId":"User_SetLrbgCredentials","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"user","in":"path","required":true,"type":"string"},{"name":"lrbg","in":"body","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TeUser"}}},"security":[{"basic":[]}]}},"/api/{client}/user/{user}/password":{"put":{"tags":["Users"],"operationId":"User_SetPassword","consumes":["text/plain"],"produces":[],"parameters":[{"name":"user","in":"path","required":true,"type":"string"},{"name":"body","in":"body","required":true,"schema":{"format":"binary","type":"string"}},{"name":"client","in":"path","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"security":[{"basic":[]}]}}},"definitions":{"RawAddress":{"description":"An address as supplied to the Address Matching service","required":["Lines"],"type":"object","properties":{"Lines":{"description":"0 or more address lines, excluding the postcode. Lines may be empty or null. There is no significance in the way the address is split into lines. The array must be present, even if it is empty.","type":"array","items":{"type":"string"}},"Postcode":{"description":"The optional postcode, including the space between the two parts.","pattern":"^[A-Z]{1,2}[0-9R][0-9A-Z]? [0-9][A-Z-[CIKMOV]]{2}$","type":"string"}}},"Address":{"description":"Represents an address extracted from the RES data","required":["Lines","SingleLine","Normalised","NormalisedNoCounty","LogicalFirstLine"],"type":"object","properties":{"Lines":{"description":"Individual lines of the address excluding the postcode and with blank/empty lines removed. If there are no lines then this is an empty array rather than null.","type":"array","items":{"type":"string"}},"Postcode":{"type":"string"},"SingleLine":{"description":"A single-line version of the address obtained by concatenating all the lines and the postcode using space (not comma) as a separator.","type":"string"},"Normalised":{"description":"A normalised version of the address (without the postcode) useful for comparing addresses while ignoring insignificant differences, such as using \"Rd\"/\"Road\".","type":"string"},"NormalisedNoCounty":{"description":"A normalised version of the address but with the county (if any) and postcode removed (useful for comparing addresses where counties are sometimes omitted).","type":"string"},"LogicalFirstLine":{"description":"A normalised version of the \"first line\" of the address, where the \"first line\" is basically the property name and/or number and the street, which is NOT necessarily the same as Lines[0]. Useful for comparing addresses based on \"first line and postcode\". The algorithm used to extract the \"first line\" uses various heuristics and is not guaranteed to always give a correct result, but it errs in including too much of the address rather than too little.","type":"string"}}},"ItemDetailsApiError":{"description":"Information about an error that has occurred","required":["ItemDetails"],"type":"object","properties":{"ItemDetails":{"description":"Contains details of errors and associated items","type":"array","items":{"$ref":"#/definitions/ErrorItemDetails"}},"ErrorMessage":{"description":"A message describing the error. May be null.","type":"string"}}},"ErrorItemDetails":{"description":"Contains details of an errors associated with an identified item","required":["Item","Details"],"type":"object","properties":{"Item":{"description":"The identifier of the item with an error","type":"string"},"Details":{"description":"The details of the error for the identified item","type":"string"}}},"AddressMatchRequest":{"description":"The two addresses to be compared on a \"logical first line and postcode\" basis","required":["Address1","Address2"],"type":"object","properties":{"Address1":{"$ref":"#/definitions/RawAddress","description":"The first address to be compared"},"Address2":{"$ref":"#/definitions/RawAddress","description":"The second address to be compared"}}},"AddressMatchResponse":{"description":"The response to an address match request","required":["Result"],"type":"object","properties":{"Result":{"description":"The result of an address match","enum":["NoMatch","Match","MatchMissingPostcode","MatchNoPostcodes"],"type":"string"}}},"WaitHandle":{"type":"object","properties":{"Handle":{"type":"object"},"SafeWaitHandle":{"$ref":"#/definitions/SafeWaitHandle"}}},"SafeWaitHandle":{"type":"object","properties":{"IsInvalid":{"type":"boolean","readOnly":true},"IsClosed":{"type":"boolean","readOnly":true}}},"EdrsRequest":{"description":"Describes a request Application to Change the Register","required":["Affects","ApplicationDate","Applications","Client","DisclosableOverridingInterests","Parties","Titles","TotalFee"],"type":"object","properties":{"AdditionalNotifications":{"description":"Details of any third party to be notified on completion of the application","type":"array","items":{"$ref":"#/definitions/AdditionalPartyNotification"}},"Affects":{"description":"Details how much of the title the application affects","enum":["Part","Whole"],"type":"string"},"ApplicationDate":{"format":"date-time","description":"Date of the application","type":"string"},"Applications":{"description":"Details of one or more charge or other types of application (in priority order)","type":"array","items":{"$ref":"#/definitions/ApplicationEntry"}},"Client":{"$ref":"#/definitions/ClientInfo","description":"Contact and reference information"},"DisclosableOverridingInterests":{"description":"This application relates to a registerable disposition and disclosable overriding interests affect the registered estate","type":"boolean"},"LocalAuthority":{"description":"Local Authority serving the property","type":"string"},"Notes":{"description":"Optional. This is a free format notepad area for any additional notes","type":"string"},"Parties":{"description":"Details of parties involved in the transaction","type":"array","items":{"$ref":"#/definitions/EdrsParty"}},"Postcode":{"description":"Postcode of property application relates to","pattern":"^[A-Z]{1,2}[0-9R][0-9A-Z]? [0-9][A-Z-[CIKMOV]]{2}$","type":"string"},"RepresentingConveyancers":{"description":"Details of the conveyancer(s) representing the parties in the transaction","type":"array","items":{"$ref":"#/definitions/RepresentingConveyancer"}},"Titles":{"$ref":"#/definitions/ServiceTitles","description":"Details of this applications service type"},"TotalFee":{"format":"int64","type":"integer"}}},"AdditionalPartyNotification":{"required":["Name"],"type":"object","properties":{"Name":{"type":"string"},"Reference":{"type":"string"},"DxAddress":{"$ref":"#/definitions/DxAddress"},"EmailAddress":{"type":"string"},"PostalAddress":{"$ref":"#/definitions/EdrsPostalAddress"}}},"ApplicationEntry":{"description":"Describes a charge or other type of application.","required":["FeeInPence","Value"],"type":"object","properties":{"FeeInPence":{"format":"int64","description":"Application fee in pence","type":"integer"},"Value":{"format":"int64","description":"Application price paid / value","type":"integer"},"Document":{"description":"Classifies the type of document that will be attached. The only types of application that allow no document are COA and DIS","enum":["Original","Certified","Scanned"],"type":"string"},"Type":{"description":"Specifies the type of charge application","enum":["ADV1","ADV2","AN1","AP1","APT","AS1","AS2","AS3","C","CCD","CH2","CH3","CN","CNL","CN1","COA","CPD","DB","DIS","DJP","DOL","DSP","EX1","EX3","HR1","HR2","HR4","LEASE","NOE","NOL","PC","RC","RFN","RGOE","ROCA","ROCC","ROCU","ROE","RX1","RX2","RX3","RX4","SBC","SC","SEV","SL","TNV","TP1","TP2","TR1","TR2","TR4","TRM","TSC","UN1","UN2","UN3","UN4","UT1","VC","VLAN","VLAP","VLUN","VOCA","VOCU","VOE","VOEA","VOEU","WCT"],"type":"string"},"Charge":{"$ref":"#/definitions/ChargeEntry","description":"Details of a charge application"}}},"ClientInfo":{"description":"Contact and reference information","required":["Email","Reference","Telephone"],"type":"object","properties":{"Description":{"description":"Human-readable description of the request, returned when querying for applications by reference","type":"string"},"Email":{"description":"Contact email address for potential use by the Land Registry against the submitted request","type":"string"},"Reference":{"description":"String used to identify the request both with TitleExpert and the Land Registry","maxLength":25,"minLength":1,"type":"string"},"Telephone":{"description":"Contact telephone number for potential use by the Land Registry against the submitted request","type":"string"}}},"EdrsParty":{"required":["AddressForService","Roles"],"type":"object","properties":{"AddressForService":{"$ref":"#/definitions/AddressForService"},"IsApplicant":{"type":"boolean"},"Representation":{"description":"If specified, this party is a predefined representative","enum":["Lodging","Certified","Identity"],"type":"string"},"RepresentingConveyancer":{"format":"int32","description":"Identifies with a 1-based index the representing conveyancer to which this party relates","type":"integer"},"Roles":{"description":"The role/s this party plays in the transaction","type":"array","items":{"$ref":"#/definitions/PartyRole"}},"Company":{"$ref":"#/definitions/CompanyParty"},"Person":{"$ref":"#/definitions/PersonParty"}}},"RepresentingConveyancer":{"required":["Name","Reference"],"type":"object","properties":{"Name":{"type":"string"},"Reference":{"type":"string"},"DxAddress":{"$ref":"#/definitions/DxAddress"},"PostalAddress":{"$ref":"#/definitions/EdrsPostalAddress"}}},"ServiceTitles":{"type":"object","properties":{"Dealing":{"pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"array","items":{"type":"string"}},"Lessor":{"pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"array","items":{"type":"string"}},"Transferor":{"pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"array","items":{"type":"string"}},"Additional":{"pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"array","items":{"type":"string"}},"Lessee":{"pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"string"}}},"DxAddress":{"required":["DxNumber","DxExchange"],"type":"object","properties":{"CareOfName":{"type":"string"},"CareOfReference":{"type":"string"},"DxNumber":{"type":"string"},"DxExchange":{"type":"string"}}},"EdrsPostalAddress":{"required":["Lines"],"type":"object","properties":{"CareOfName":{"type":"string"},"CareOfReference":{"type":"string"},"Lines":{"type":"array","items":{"type":"string"}},"City":{"type":"string"},"County":{"type":"string"},"Country":{"type":"string"},"Postcode":{"pattern":"^[A-Z]{1,2}[0-9R][0-9A-Z]? [0-9][A-Z-[CIKMOV]]{2}$","type":"string"}}},"ChargeEntry":{"description":"Details of a charge application.","required":["ChargeDate"],"type":"object","properties":{"ChargeDate":{"format":"date-time","description":"Date of the charge","type":"string"},"SortCode":{"description":"Lender's sort code","type":"string"},"MdRef":{"description":"Lender's MDRef","type":"string"}}},"AddressForService":{"type":"object","properties":{"Register":{"enum":["A1","B1"],"type":"string"},"Postal":{"$ref":"#/definitions/EdrsPostalAddress"},"Additional":{"type":"array","items":{"$ref":"#/definitions/AdditionalAddress"}}}},"PartyRole":{"required":["Application","Role"],"type":"object","properties":{"Application":{"format":"int32","description":"The 1-based index of the application entry this party plays a role in","type":"integer"},"Role":{"enum":["Borrower","Lender","PersonalRepresentative","Proprietor","ThirdParty","Transferee","Transferor","Lessee","Lessor"],"type":"string"}}},"CompanyParty":{"required":["CompanyName"],"type":"object","properties":{"CompanyName":{"type":"string"},"CompanyRegistration":{"type":"string"},"LlpRegistration":{"type":"string"},"OverseasTerritory":{"type":"string"},"OverseasNumber":{"type":"string"}}},"PersonParty":{"required":["Forenames","Surname"],"type":"object","properties":{"Forenames":{"type":"string"},"Surname":{"type":"string"}}},"AdditionalAddress":{"type":"object","properties":{"DxAddress":{"$ref":"#/definitions/DxAddress"},"EmailAddress":{"type":"string"},"PostalAddress":{"$ref":"#/definitions/EdrsPostalAddress"}}},"ApplicationStatus":{"type":"object","properties":{"AppBarcodeReference":{"type":"string"},"StatusMessages":{"type":"string"},"Attachments":{"type":"array","items":{"$ref":"#/definitions/Attachment"}},"Requisitions":{"type":"array","items":{"$ref":"#/definitions/Correspondence"}},"Request":{"$ref":"#/definitions/EdrsRequest"},"Result":{"$ref":"#/definitions/ApplicationResult"},"Id":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"Reference":{"type":"string"},"Description":{"type":"string"},"Status":{"type":"string"},"StatusUpdated":{"format":"date-time","type":"string"}}},"Attachment":{"type":"object","properties":{"Id":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"Description":{"type":"string"},"Size":{"format":"int32","type":"integer"},"Status":{"enum":["Pending","Rejected","Accepted"],"type":"string"},"StatusMessages":{"type":"string"},"MimeType":{"type":"string"}}},"Correspondence":{"type":"object","properties":{"Id":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"MimeType":{"type":"string"},"Name":{"type":"string"},"Received":{"format":"date-time","type":"string"},"Size":{"format":"int32","type":"integer"}}},"ApplicationResult":{"type":"object","properties":{"ActualFee":{"format":"int64","type":"integer"},"AdditionalDespatchItems":{"type":"boolean"},"ResultType":{"enum":["FullElectronic","PartialElectronic","FullPostal","Cancellation"],"type":"string"},"Documents":{"type":"array","items":{"$ref":"#/definitions/ResultDocument"}},"Extracts":{"type":"array","items":{"$ref":"#/definitions/ResultExtract"}}}},"ResultDocument":{"type":"object","properties":{"Id":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"MimeType":{"type":"string"},"Name":{"type":"string"}}},"ResultExtract":{"type":"object","properties":{"Id":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"TitleNumber":{"type":"string"}}},"ApplicationSummary":{"type":"object","properties":{"Id":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"Reference":{"type":"string"},"Description":{"type":"string"},"Status":{"type":"string"},"StatusUpdated":{"format":"date-time","type":"string"}}},"Event[ApplicationStatus]":{"description":"Describes some Event that has occurred against a subject (Request of constituent thereof)","type":"object","properties":{"EventId":{"format":"uuid","description":"Uniquely identifies this Event. Use to Acknowledge receipt (and processing).","type":"string","example":"00000000-0000-0000-0000-000000000000"},"EventName":{"description":"Name of the Event that has occurred.","type":"string"},"Subject":{"$ref":"#/definitions/ApplicationStatus","description":"Data pertaining to the subject of this Event."}}},"AppendAttachment":{"type":"object","properties":{"Name":{"enum":["Abstract","Agreement","Assent","Assignment","BirthCertificate","Charge","Conveyance","Correspondence","CourtOrder","DeathCertificate","Deed","Discharge","DocumentList","Evidence","EX1A","FormDI","IdentityEvidence","IdentityForm","Indenture","LandTransactionTax","Lease","Licence","LRCorrespondence","MarriageCertificate","Plan","PowerofAttorney","Probate","StampDutyLandTax","StatementOfTruth","StatutoryDeclaration","SubCharge","Transfer","WitnessStatement"],"type":"string"},"CertifiedCopy":{"enum":["Original","Certified","Scanned"],"type":"string"}}},"AttachmentAppended":{"type":"object","properties":{"Id":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"}}},"AppendNotes":{"required":["Notes"],"type":"object","properties":{"Notes":{"type":"string"}}},"Event[AttachmentForApplication]":{"description":"Describes some Event that has occurred against a subject (Request of constituent thereof)","type":"object","properties":{"EventId":{"format":"uuid","description":"Uniquely identifies this Event. Use to Acknowledge receipt (and processing).","type":"string","example":"00000000-0000-0000-0000-000000000000"},"EventName":{"description":"Name of the Event that has occurred.","type":"string"},"Subject":{"$ref":"#/definitions/AttachmentForApplication","description":"Data pertaining to the subject of this Event."}}},"AttachmentForApplication":{"type":"object","properties":{"ApplicationId":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"ApplicationReference":{"type":"string"},"Id":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"Description":{"type":"string"},"Size":{"format":"int32","type":"integer"},"Status":{"enum":["Pending","Rejected","Accepted"],"type":"string"},"StatusMessages":{"type":"string"},"MimeType":{"type":"string"}}},"Event[CorrespondenceForApplication]":{"description":"Describes some Event that has occurred against a subject (Request of constituent thereof)","type":"object","properties":{"EventId":{"format":"uuid","description":"Uniquely identifies this Event. Use to Acknowledge receipt (and processing).","type":"string","example":"00000000-0000-0000-0000-000000000000"},"EventName":{"description":"Name of the Event that has occurred.","type":"string"},"Subject":{"$ref":"#/definitions/CorrespondenceForApplication","description":"Data pertaining to the subject of this Event."}}},"CorrespondenceForApplication":{"type":"object","properties":{"ApplicationId":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"ApplicationReference":{"type":"string"},"Id":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"MimeType":{"type":"string"},"Name":{"type":"string"},"Received":{"format":"date-time","type":"string"},"Size":{"format":"int32","type":"integer"}}},"BankruptcyRequest":{"description":"The specification of a K16 (Bankruptcy Search) request to be issued.","required":["ClientParameters","Names"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters","description":"Information about the client issuing the request"},"Deadline":{"format":"date-time","description":"If provided (ISO8601/like format yyyy-MM-dd HH:mm:ss), specifies that if the final response has not been received from the LRBG before the Deadline is met, the Request will be marked as Expired and made available for immediate return (LRBG costs may still be incurred).","type":"string"},"Names":{"description":"Between 1 and 6 names to be checked","type":"array","items":{"$ref":"#/definitions/Name"}},"AlternativeDespatchDetails":{"$ref":"#/definitions/AlternativeDespatchDetails","description":"Optional details of where to send any non-electronic results (if they are not to be sent to the default address)"}}},"ClientParameters":{"description":"Information about the client issuing the request","required":["ContactName","ContactPhone"],"type":"object","properties":{"ClientRef":{"description":"Optional string (maximum of 128 characters) for use by the client to identify this request. This will be truncated to 25 characters when sent to the LRBG.","maxLength":128,"minLength":0,"type":"string"},"ContactName":{"description":"Mandatory contact name which is passed to the Land Registry","type":"string"},"ContactPhone":{"description":"Mandatory phone number which is passed to the Land Registry","type":"string"}}},"Name":{"description":"Represents the name of a company or an individual","required":["SurnameOrCompany"],"type":"object","properties":{"SurnameOrCompany":{"description":"Guaranteed non-null and non-empty. The company name if this is a company, or the surname of an individual.","type":"string"},"Forenames":{"description":"If non-null and non-empty this Name is for an individual, and this field is the forenames. If null or empty this Name is for a company.","type":"string"}}},"AlternativeDespatchDetails":{"type":"object","properties":{"CompanyName":{"description":"Either null or a possibly empty company name","type":"string"},"Reference":{"description":"Either null or a possibly empty reference","type":"string"},"PostalAddress":{"$ref":"#/definitions/PostalAddress","description":"May be null. If non-null then DXAddress must be null."},"DXAddress":{"$ref":"#/definitions/DXAddress","description":"May be null. If non-null then PostalAddress must be null."}}},"PostalAddress":{"description":"A postal address as specified for a \"despatch address\"","required":["AddressLines"],"type":"object","properties":{"AddressLines":{"description":"Between 1 and 4 non-null and non-empty lines","type":"array","items":{"type":"string"}},"Postcode":{"description":"May be null or empty","pattern":"^[A-Z]{1,2}[0-9R][0-9A-Z]? [0-9][A-Z-[CIKMOV]]{2}$","type":"string"}}},"DXAddress":{"description":"Represents a DX (Direct Exchange) Address","required":["DXNumber","DXExchange"],"type":"object","properties":{"DXNumber":{"description":"Mandatory. Must be non-blank.","type":"string"},"DXExchange":{"description":"Mandatory. Must be non-blank.","type":"string"}}},"BankruptcyResponse":{"description":"Details of a Bankruptcy Request that has been isuued.","required":["ClientParameters","ResponseCommon","Names"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters","description":"Information about the client issuing the request"},"ResponseCommon":{"$ref":"#/definitions/LrbgResponseCommon","description":"Information about the status of the rqeuest."},"Names":{"description":"Between 1 and 6 names to be checked","type":"array","items":{"$ref":"#/definitions/Name"}},"AlternativeDespatchDetails":{"$ref":"#/definitions/AlternativeDespatchDetails","description":"Optional details of where to send any non-electronic results (if they are not to be sent to the default address)"},"ReturnedDocuments":{"$ref":"#/definitions/ReturnedDocuments","description":"Details of the documents (if any) returned by the LRBG if the request succeeded."}}},"LrbgResponseCommon":{"description":"Information about the status of an LRBG request.","required":["Id","ResponseUri","Status","StatusLastChanged","Acknowledged"],"type":"object","properties":{"SuccessMessage":{"description":"If the status is Complete, the success message (if any) received from the LRBG. May be null.","type":"string"},"FailureCode":{"description":"If the status is Failed, the failure code (if any) received from the LRBG. May be null.","type":"string"},"FailureMessage":{"description":"If the status is Failed, the failure message (if any) received from the LRBG. May be null.","type":"string"},"ActualPrice":{"$ref":"#/definitions/LRBGPrice","description":"The actual price charged by the LRBG for this request, if known. May be null if not known."},"Id":{"format":"uuid","description":"The request id, allocated when the request was accepted by the system.","type":"string","example":"00000000-0000-0000-0000-000000000000"},"ResponseUri":{"description":"The URL that can be used to retrieve the results of the request.","type":"string"},"Reference":{"description":"The reference string provided at the time the Request was constructed.","type":"string"},"Deadline":{"format":"date-time","description":"The date/time provided for the Request, by which a final result must be known.","type":"string"},"Status":{"description":"One of: Pending: Request has been submitted to the system for processing; final result is not yet known or ready. Complete: Processing for the Request has completed successfully and the results are available. Failed: Processing for the Request has completed but the Request was not successful. Cancelled: The Request was cancelled before processing was started or completed. Expired: The Request had a Deadline set and it was met before the Request finished.","type":"string"},"StatusLastChanged":{"format":"date-time","description":"The UTC date and time when the Status last changed (i.e. when the request was issued if the status is Pending, or when the result became known otherwise).","type":"string"},"AcknowledgeBefore":{"format":"date-time","type":"string"},"AcknowledgeUri":{"description":"If the status is Complete or Failed, the URI that can be used to acknowledge receipt of the results of this request. Null if the status is Pending.","type":"string"},"Acknowledged":{"description":"Whether or not receipt of the results of this request have been explicitly acknowledged.","type":"boolean"}}},"ReturnedDocuments":{"description":"Details of any documents returned by the LRBG.","required":["ResultType","Documents"],"type":"object","properties":{"ResultType":{"description":"Whether some or all or none of the documents were returned elctronically. Values are FE (full electronic), PE (partial electronic), FP (full postal), CN (cancellation) or IR (Interim). Currently Title Expert does not fully support IR; it is treated like PE but the outstanding documents must be requested again manually.","enum":["Unknown","FE","PE","FP","CN","IR"],"type":"string"},"HMLRReference":{"description":"An optional reference supplied by the LR. May be null.","type":"string"},"Title":{"description":"An optional title supplied by the LR. May be null.","type":"string"},"Description":{"description":"An optional description supplied by the LR. May be null.","type":"string"},"Documents":{"description":"An array with one entry per document returned. If no documents were returned then the array is empty rather than null.","type":"array","items":{"$ref":"#/definitions/ReturnedDocument"}}}},"LRBGPrice":{"description":"Represents the actual cost of an LRBG request","required":["Gross"],"type":"object","properties":{"Gross":{"format":"double","description":"GRoss amount.","type":"number"},"Net":{"format":"double","description":"Net amount, or null if price not split into Net/VAT","type":"number"},"VAT":{"format":"double","description":"VAT amount, or null if price not split into Net/VAT","type":"number"}}},"ReturnedDocument":{"description":"Information about one document retuurned by the LRBG","required":["Index","Uri"],"type":"object","properties":{"Index":{"format":"int32","description":"The 1-based index of this entry within the array of returneed documents","type":"integer"},"Filename":{"description":"The filename (with extension) of the doucment if known. Null if the filename is not known.","type":"string"},"MimeType":{"description":"The MIME type of the doucment if known. Null if not known.","type":"string"},"Uri":{"description":"The URI that can be used to obtain this document.","type":"string"}}},"ApiError":{"description":"Information about an error that has occurred","type":"object","properties":{"ErrorMessage":{"description":"A message describing the error. May be null.","type":"string"}}},"TitleDataResponse":{"description":"Details of a Request for Title Check that has been issued.","required":["ClientParameters","ResponseCommon"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters","description":"Information about the client issuing the request"},"RequestToCheck":{"format":"uuid","description":"The id of a previous Request for Title Check with title data which was used to perform this check.","type":"string","example":"00000000-0000-0000-0000-000000000000"},"RESDataUri":{"description":"(DEPRECATED) The URI to access the RES XML data (as an object) returned by the LRBG if the request succeeded. Null if the data is not available.","type":"string"},"RESDocumentUri":{"description":"The URI to access the RES XML data (as a document) returned by the LRBG if the request succeeded. Null if the data is not available or {ACSSolutions.TitleChecker.ClientApi.LrbgRequests.Models.TitleDataResponse.RequestToCheck} was provided in the request.","type":"string"},"ResponseCommon":{"$ref":"#/definitions/LrbgResponseCommon","description":"Information about the status of the rqeuest."},"ReturnedDocuments":{"$ref":"#/definitions/ReturnedDocuments","description":"Details of the documents (if any) returned by the LRBG if the request succeeded. If a Title Plan was requested then the OC will typically be the first document and the Title Plan will be the second. This field is always present, even if no documents were returned."},"TitleCheckOutputsUri":{"description":"URL from which to obtain the extra output data resulting from a title check. Null if not (yet) available.","type":"string"},"TitleCheckParameters":{"description":"List of named parameters for the title check as provided at the time of request. Null if no parameters were provided.","type":"object"},"TitleCheckProfile":{"description":"Name of the title check profile provided in the request.","type":"string"},"TitleCheckResultsUri":{"description":"The URL to access the results if the request succeeded. Null if the data is not available.","type":"string"},"TitleNumber":{"description":"The title number for which to retrieve info and perform basic checks. Not used if {ACSSolutions.TitleChecker.ClientApi.LrbgRequests.Models.TitleDataResponse.RequestToCheck} was provided in the request.","type":"string"},"WithPlan":{"description":"Whether or not a Title Plan was to be requested from the LR in addition to the OC. Not used if {ACSSolutions.TitleChecker.ClientApi.LrbgRequests.Models.TitleDataResponse.RequestToCheck} was provided in the request.","type":"boolean"}}},"BorrowerNameMatchRequest":{"description":"Specifies the paramaeters for the BorrowerNameMatch Custom Check.","required":["Borrowers","TitleDataId"],"type":"object","properties":{"Borrowers":{"description":"Between 1 and 4 borrowers, whose names are to be compared with the names of the registered proprietors.","type":"array","items":{"$ref":"#/definitions/Borrower"}},"MinConfidence":{"format":"int32","description":"If a fuzzy name comparison between a borrower and a proprietor has a confidence greater than or equal to this value then it will be treated as a possible fuzzy match. If not specified a default value is used.","maximum":100,"minimum":0,"type":"integer"},"ClientRef":{"description":"Optional string (maximum of 128 characters) for use by the client to identify this request.","maxLength":128,"minLength":0,"type":"string"},"Deadline":{"format":"date-time","description":"If provided (ISO8601/like format yyyy-MM-dd HH:mm:ss), specifies that if the final result is not ready before the Deadline is met, the Request will be marked as Expired and made available for immediate return (costs may still be incurred).","type":"string"},"TitleDataId":{"format":"uuid","description":"The id of the Title Data request, against whose data the Custom Check will be performed.","type":"string","example":"00000000-0000-0000-0000-000000000000"}}},"Borrower":{"description":"Details of a borrower (typically for a mortgage or re-mortgage)","required":["Names"],"type":"object","properties":{"Names":{"description":"The borrower's name (the first entry in the array) plus any aliases (e.g. maiden names or names from previous marriages).","type":"array","items":{"$ref":"#/definitions/Name"}}}},"BorrowerNameMatchResponse":{"description":"Contains the request parameters, request status and result data of the BorrowerNameMatch Custom Check.","required":["ResponseCommon","Request"],"type":"object","properties":{"ResponseCommon":{"$ref":"#/definitions/ResponseCommon","description":"Information about the status of the rqeuest."},"MatchDetails":{"description":"One entry for each borrower-proprietor match found, plus one entry for each unmatched borrower and one entry for each unmatched proprietor. Every borrower and every proprietor will appear in exactly one entry.","type":"array","items":{"$ref":"#/definitions/BorrowerNameMatchDetails"}},"Issues":{"description":"The issues found. If there are no issues this is an empty array, rather than null. As well as general issues (e.g. duplicate names) there will be one issue for each non-exact match plus one issue for each unmatched borrower or proprietor.","type":"array","items":{"$ref":"#/definitions/ProprietorNameMatchIssue"}},"MinConfidence":{"format":"int32","description":"The confidence threshold that was actually used for the BorrowerNameMatch. This will be the default value if not provided in the request.","type":"integer"},"Request":{"$ref":"#/definitions/BorrowerNameMatchRequest","description":"Contains the Custom Check parameters provided by the client."}}},"ResponseCommon":{"description":"Information about the status of a request.","required":["Id","ResponseUri","Status","StatusLastChanged","Acknowledged"],"type":"object","properties":{"Id":{"format":"uuid","description":"The request id, allocated when the request was accepted by the system.","type":"string","example":"00000000-0000-0000-0000-000000000000"},"ResponseUri":{"description":"The URL that can be used to retrieve the results of the request.","type":"string"},"Reference":{"description":"The reference string provided at the time the Request was constructed.","type":"string"},"Deadline":{"format":"date-time","description":"The date/time provided for the Request, by which a final result must be known.","type":"string"},"Status":{"description":"One of: Pending: Request has been submitted to the system for processing; final result is not yet known or ready. Complete: Processing for the Request has completed successfully and the results are available. Failed: Processing for the Request has completed but the Request was not successful. Cancelled: The Request was cancelled before processing was started or completed. Expired: The Request had a Deadline set and it was met before the Request finished.","type":"string"},"StatusLastChanged":{"format":"date-time","description":"The UTC date and time when the Status last changed (i.e. when the request was issued if the status is Pending, or when the result became known otherwise).","type":"string"},"AcknowledgeBefore":{"format":"date-time","type":"string"},"AcknowledgeUri":{"description":"If the status is Complete or Failed, the URI that can be used to acknowledge receipt of the results of this request. Null if the status is Pending.","type":"string"},"Acknowledged":{"description":"Whether or not receipt of the results of this request have been explicitly acknowledged.","type":"boolean"}}},"BorrowerNameMatchDetails":{"description":"Details of either a possible borrower-proprietor match, or of an unmatched borrower or proprietor","required":["MatchType"],"type":"object","properties":{"MatchType":{"description":"The type of match.","enum":["Undefined","Exact","Alias","MissingMiddleNames","MissingProprietorMiddleNames","Initials","PossibleMarriage","PossibleDivorce","FuzzyMatch","UnmatchedBorrower","UnmatchedProprietor"],"type":"string"},"BorrowerIndex":{"format":"int32","description":"The 0-based index of the borrower in the Borrowers array in the request, or null if MatchType is UnmatchedProprietor","type":"integer"},"BorrowerName":{"$ref":"#/definitions/Name","description":"The borrower's name, or null if MatchType is UnmatchedProprietor"},"ProprietorIndex":{"format":"int32","description":"The 0-based index of the proprietor in the array of proprietors in the TitleCheckResults, or null if MatchType is UnmatchedBorrower","type":"integer"},"Proprietor":{"$ref":"#/definitions/Party","description":"Details of the proprietor, or null if MatchType is UnmatchedBorrower"},"FuzzyMatchScorePercent":{"format":"int32","description":"Null unless MatchType is FuzzyMatch, when it is the confidence (%) of the match","type":"integer"}}},"ProprietorNameMatchIssue":{"required":["IssueId","IssueType","Message"],"type":"object","properties":{"Type":{"enum":["Undefined","BorrowerProprietorCountsDiffer","DuplicateBorrowerNames","DuplicateProprietorNames","InexactMatch","UnmatchedBorrower","UnmatchedProprietor"],"type":"string"},"DetailsIndex":{"format":"int32","type":"integer"},"CheckName":{"type":"string"},"IssueId":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IssueType":{"enum":["None","UnableToTitleCheck","TitleCommonhold","DifferentTitleNumber","IncompletePropertyAddress","MultiplePropertyAddresses","LeaseholdUnclear","MultipleLeaseEntries","LeaseDetailsNotParsable","ScheduleOfLeases","NoProprietorshipDate","ProprietorIsCompany","ChargePrioritiesChanged","RegChargeSecondMortgage","RegChargeProprietorNotCompany","MultipleChargeParties","MultipleChargeeParties","NoChargeDate","NoRegistrationDate","RegChargeSubcharge","ExtraTitleNumber","DeedOfPostponement","Matrimonial","FormARestrictionSingleProprietor","FormPRestriction","FormLLRestriction","Restriction","RightToBuyCharge","InhibitionCaution","OptionToPurchase","RightOfPreEmption","ProprietorNotice","EquitableCharge","NotedCharge","FlyingFreehold","Footprint","GreenOutEntry","MissingDocument","BankruptcyNotice","UnidentifiedEntry","MissingLeaseDetails","PendingApplication","PossibleSharedOwnership","MiningLease","ProprietorCountsDiffer","DuplicateExpectedProprietors","DuplicateRegisteredProprietors","InexactProprietorMatch","UnmatchedExpectedProprietor","UnmatchedRegisteredProprietor"],"type":"string"},"Message":{"type":"string"}}},"Party":{"description":"Represents a person or an organisation who is a \"party\" to something in the legal sense","required":["IsCompany","Names","Addresses"],"type":"object","properties":{"IsCompany":{"description":"Whether this party is a company or an individual","type":"boolean"},"Names":{"description":"If this is a company there is exactly one name. If this is an individual there is at least one name, where the first is the \"normal\" name and the others are aliases.","type":"array","items":{"$ref":"#/definitions/OCName"}},"Addresses":{"description":"Zero or more addresses, where the first (if any) is the \"normal\" address. If there are no addresses this is an empty array rather than null.","type":"array","items":{"$ref":"#/definitions/Address"}},"CompanyNumber":{"description":"If this is a company, the company registration number if known. Null if this is an individual or the company registration number is not known.","type":"string"}}},"OCName":{"description":"The name of an individual or a company","required":["SurnameOrCompany","SingleLine"],"type":"object","properties":{"SurnameOrCompany":{"description":"Surname of an individual, or name of a company","type":"string"},"Forenames":{"description":"Forenames of an individual, or null if this is a company","type":"string"},"SingleLine":{"description":"A single-line version of the name (useful for display purposes) obtained by concatenating the forenames (if any) and the surname/company name using a space as the separator.","type":"string"}}},"OfficialSearchRequest":{"description":"The specification of an OS1 (Official Search of Whole) request to be issued.","required":["ClientParameters","TitleNumber","PropertyDescription","PriorityCode","Proprietor","ApplicantParty","ContinueIfNameMismatch","ContinueIfDeveloperTitle","ContinueIfPendingSearchesOfPart"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters","description":"Information about the client issuing the request"},"Deadline":{"format":"date-time","description":"If provided (ISO8601/like format yyyy-MM-dd HH:mm:ss), specifies that if the final response has not been received from the LRBG before the Deadline is met, the Request will be marked as Expired and made available for immediate return (LRBG costs may still be incurred).","type":"string"},"TitleNumber":{"description":"Mandatory. The title number of the property.","pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"string"},"PropertyDescription":{"description":"Mandatory. A description of the property (typically the address) for use by the LR if there is a problem identifying the property from the title number. Maximum of 130 characters.","type":"string"},"SearchFrom":{"format":"date-time","description":"Mandatory unless \"Is First Registration\" is true. The date (format yyyy-mm-dd) falling within the defintition of search from date in rule 131 of the Land Registration rules 2003.","type":"string"},"PriorityCode":{"description":"Mandatory.","enum":["Purchase","Lease","Charge"],"type":"string"},"Proprietor":{"description":"Mandatory. 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). Maximum of 100 characters.","maxLength":100,"minLength":0,"type":"string"},"ApplicantParty":{"description":"Mandatory. 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. Maximum of 100 characters.","maxLength":100,"minLength":0,"type":"string"},"ContinueIfNameMismatch":{"description":"Mandatory. Whether to continue if the proprietor names do not match.","type":"boolean"},"ContinueIfDeveloperTitle":{"description":"Mandatory. Whether to continue if there is \"developer title\".","type":"boolean"},"ContinueIfPendingSearchesOfPart":{"description":"Mandatory. Whether to continue if there are any pending searches of part.","type":"boolean"},"AlternativeDespatchDetails":{"$ref":"#/definitions/AlternativeDespatchDetails","description":"Optional details of where to send any non-electronic results (if they are not to be sent to the default address)"}}},"OfficialSearchResponse":{"description":"Details of an Official Search of Whole Request that has been isuued.","required":["ClientParameters","ResponseCommon","TitleNumber","PropertyDescription","PriorityCode","Proprietor","ApplicantParty","ContinueIfNameMismatch","ContinueIfDeveloperTitle","ContinueIfPendingSearchesOfPart"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters","description":"Information about the client issuing the request"},"ResponseCommon":{"$ref":"#/definitions/LrbgResponseCommon","description":"Information about the status of the rqeuest."},"TitleNumber":{"description":"The title number of the property.","type":"string"},"PropertyDescription":{"description":"A description of the property (typically the address) for use by the LR if there is a problem identifying the property from the title number.","type":"string"},"SearchFrom":{"format":"date-time","description":"If \"Is First Registration\" is false, the date (format yyyy-mm-dd) falling within the defintition of search from date in rule 131 of the Land Registration rules 2003.","type":"string"},"PriorityCode":{"enum":["Purchase","Lease","Charge"],"type":"string"},"Proprietor":{"description":"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). Maximum of 100 characters.","type":"string"},"ApplicantParty":{"description":"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. Maximum of 100 characters.","type":"string"},"ContinueIfNameMismatch":{"description":"Whether to continue if the proprietor names do not match.","type":"boolean"},"ContinueIfDeveloperTitle":{"description":"Whether to continue if there is \"developer title\".","type":"boolean"},"ContinueIfPendingSearchesOfPart":{"description":"Whether to continue if there are any pending searches of part.","type":"boolean"},"AlternativeDespatchDetails":{"$ref":"#/definitions/AlternativeDespatchDetails","description":"Optional details of where to send any non-electronic results (if they are not to be sent to the default address)"},"ReturnedDocuments":{"$ref":"#/definitions/ReturnedDocuments","description":"Details of the documents (if any) returned by the LRBG if the request succeeded."}}},"OwnerVerifyResponse":{"description":"Details of an Online Ownership Verification request that has been issued.","required":["ResponseCommon","Request","Matches"],"type":"object","properties":{"ResponseCommon":{"$ref":"#/definitions/LrbgResponseCommon","description":"Information about the status of the rqeuest."},"Request":{"$ref":"#/definitions/RequestParams","description":"Contains the parameters as submitted for the request."},"Matches":{"description":"Details of zero or more verification matches.","type":"array","items":{"$ref":"#/definitions/Match"}}}},"RequestParams":{"description":"Contains the parameters as submitted for the request.","required":["Name"],"type":"object","properties":{"Name":{"$ref":"#/definitions/OwnerVerifyName","description":"Specifies the name of the entity whose ownership was verified."},"TitleNumber":{"description":"The known Title Number of the property whose ownership was verified. Will be null if verification was performed by address search.","type":"string"},"SearchAddress":{"$ref":"#/definitions/PropertyAddressSearch","description":"Address search criteria of the property whose ownership was verified. Will be null if verification was performed by known Title Number."}}},"Match":{"required":["SubjectProperty","Proprietorship","Surname","Forename","MiddleName"],"type":"object","properties":{"SubjectProperty":{"$ref":"#/definitions/SubjectProperty","description":"Contains the title number and address details for the property matched."},"Proprietorship":{"description":"Whether the property is Sole or Joint owned.","enum":["Unknown","Sole","Joint"],"type":"string"},"Surname":{"$ref":"#/definitions/MatchInfo","description":"Indicates whether the Surname was matched and details of how it matched. MatchType will be set to Skipped where there is no Private Individual proprietorship name found for a title number or where LR have no proprietorship details available for a title number."},"Forename":{"$ref":"#/definitions/MatchInfo","description":"Indicates whether the Forename was matched and details of how it matched. Forename and Middle name matches will be returned with a MatchType of Skipped if there was NO match on Surname."},"MiddleName":{"$ref":"#/definitions/MatchInfo","description":"Indicates whether the Middle name was matched and details of how it matched. Forename and Middle name matches will be returned with a MatchType of Skipped if there was NO match on Surname."},"AllNames":{"$ref":"#/definitions/MatchInfo","description":"Indicates if a match is found against the string concatenation of forename, middle name(s) and surname. Will only be returned when there is no match on surname."},"HistoricalMatch":{"$ref":"#/definitions/HistoricalMatch","description":"Whether the match corresponds with a previous ownership of the property (and the dates of same, if available). Will be null/missing if the match corresponds to current ownership of the property."}}},"OwnerVerifyName":{"description":"Specifies the name of the entity whose ownership is to be verified.","required":["FirstForename","Surname"],"type":"object","properties":{"FirstForename":{"description":"Forename of the proprietor to be searched.","type":"string"},"MiddleName":{"description":"Middle name of the proprietor to be searched.","type":"string"},"Surname":{"description":"Surname of the proprietor to be searched.","type":"string"}}},"PropertyAddressSearch":{"description":"Address search criteria of the property whose ownership is to be verified.","type":"object","properties":{"Tenure":{"description":"Tenure of the property to be searched ie freehold, leasehold or rentcharge. If no specific tenure has been supplied (null), the system will search against all tenures.","enum":["other","freehold","leasehold","commonhold","feuhold","mixed","unknown","unavailable","caution_against_first_registration","rent_charge","franchise","profit_a_prendre_in_gross","manor"],"type":"string"},"BuildingName":{"description":"The name of the building or house on a street of this address.","maxLength":50,"minLength":1,"type":"string"},"BuildingNumber":{"description":"The number of a building or house on a street of this address. Where the building or house occupies a range of numbers on the street, e.g. '1-9 Main St', this will be the lower number of the range.","maxLength":5,"minLength":1,"type":"string"},"Street":{"description":"Name of a street or thoroughfare.","maxLength":80,"minLength":1,"type":"string"},"City":{"description":"The name of the city, town or village of this address.","maxLength":35,"minLength":1,"type":"string"},"Postcode":{"description":"The identifier for one or more properties according to the UK postal service.","pattern":"^[A-Z]{1,2}[0-9R][0-9A-Z]? [0-9][A-Z-[CIKMOV]]{2}$","type":"string"}}},"SubjectProperty":{"required":["TitleNumber","PropertyAddress","Tenure"],"type":"object","properties":{"TitleNumber":{"description":"The title number for the property matched.","type":"string"},"PropertyAddress":{"$ref":"#/definitions/PropertyAddress","description":"Contains the address details for the property matched."},"Tenure":{"description":"Tenure of the property matched.","type":"string"}}},"MatchInfo":{"required":["Type","Methods"],"type":"object","properties":{"Type":{"description":"Indicates if an exact, partial or no match.","enum":["Skipped","None","Partial","Exact"],"type":"string"},"Methods":{"description":"Contains a list of match methods that passed to result in a partial match.","type":"array","items":{"enum":["Distance","Sound","Initial","Middle","Alias"],"type":"string"}}}},"HistoricalMatch":{"type":"object","properties":{"ProprietorFrom":{"format":"date-time","description":"Registered on date or null if unknown.","type":"string"},"ProprietorTo":{"format":"date-time","description":"Registered on date or null if unknown.","type":"string"}}},"PropertyAddress":{"description":"Contains the address details of a matched property.","type":"object","properties":{"SubBuildingName":{"description":"Sub building name of the property matched.","type":"string"},"BuildingName":{"description":"The name of the building or house on a street of this address.","maxLength":50,"minLength":1,"type":"string"},"BuildingNumber":{"description":"The number of a building or house on a street of this address. Where the building or house occupies a range of numbers on the street, e.g. '1-9 Main St', this will be the lower number of the range.","maxLength":5,"minLength":1,"type":"string"},"Street":{"description":"Name of a street or thoroughfare.","maxLength":80,"minLength":1,"type":"string"},"City":{"description":"The name of the city, town or village of this address.","maxLength":35,"minLength":1,"type":"string"},"Postcode":{"description":"The identifier for one or more properties according to the UK postal service.","pattern":"^[A-Z]{1,2}[0-9R][0-9A-Z]? [0-9][A-Z-[CIKMOV]]{2}$","type":"string"}}},"OwnerVerifyByTitleRequest":{"description":"Specification of the Online Ownership Verification to be performed.","required":["TitleNumber","Name"],"type":"object","properties":{"TitleNumber":{"description":"The known Title Number of the property whose ownership is to be verified.","pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"string"},"Reference":{"description":"Optional string (maximum of 128 characters) for use by the client to identify this request. This will be truncated to 25 characters when sent to the LRBG.","maxLength":128,"minLength":0,"type":"string"},"Deadline":{"format":"date-time","description":"If provided (ISO8601/like format yyyy-MM-dd HH:mm:ss), specifies that if the final response has not been received from the LRBG before the Deadline is met, the Request will be marked as Expired and made available for immediate return (LRBG costs may still be incurred).","type":"string"},"Name":{"$ref":"#/definitions/OwnerVerifyName","description":"Specify the name of the entity whose ownership is to be verified."}}},"OwnerVerifyByAddressRequest":{"description":"Specification of the Online Ownership Verification to be performed.","required":["SearchAddress","Name"],"type":"object","properties":{"SearchAddress":{"$ref":"#/definitions/PropertyAddressSearch","description":"Address search criteria of the property whose ownership is to be verified."},"Reference":{"description":"Optional string (maximum of 128 characters) for use by the client to identify this request. This will be truncated to 25 characters when sent to the LRBG.","maxLength":128,"minLength":0,"type":"string"},"Deadline":{"format":"date-time","description":"If provided (ISO8601/like format yyyy-MM-dd HH:mm:ss), specifies that if the final response has not been received from the LRBG before the Deadline is met, the Request will be marked as Expired and made available for immediate return (LRBG costs may still be incurred).","type":"string"},"Name":{"$ref":"#/definitions/OwnerVerifyName","description":"Specify the name of the entity whose ownership is to be verified."}}},"OwnerVerifyResult":{"description":"Contains the request parameters and match results of an Online Ownership Verification request.","required":["Request","Matches"],"type":"object","properties":{"Request":{"$ref":"#/definitions/RequestParams","description":"Contains the parameters as submitted for the request."},"Matches":{"description":"Details of zero or more verification matches.","type":"array","items":{"$ref":"#/definitions/Match"}}}},"TitleCheckRequest":{"description":"Describes a Request for Title Check upon the title data returned by a previous Request.","required":["ClientParameters"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters"},"Deadline":{"format":"date-time","type":"string"},"RequestId":{"format":"uuid","description":"Identifies the previous Request for Title Check whose data is to be used to perform another. Must not itself have been in reference to another but must have its own data.","type":"string","example":"00000000-0000-0000-0000-000000000000"},"TitleCheckParameters":{"type":"object"},"TitleCheckProfile":{"type":"string"}}},"TitleDataRequest":{"description":"The specification of a Title Data request to be issued.","required":["ClientParameters","TitleNumber"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters"},"Deadline":{"format":"date-time","type":"string"},"NotifyIfPendingApplication":{"type":"boolean"},"NotifyIfPendingFirstRegistration":{"type":"boolean"},"SendBackDatedIndicator":{"type":"boolean"},"TitleNumber":{"pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"string"},"WithPlan":{"description":"Whether or not a Title Plan is to be requested from the LR in addition to rthe OC. May be omitted, in which case a plan is not requested.","type":"boolean"},"TitleCheckParameters":{"type":"object"},"TitleCheckProfile":{"type":"string"}}},"TitleCheckXmlRequest":{"description":"Specifies a request to perform a Title Check of supplied XML from Register Extract Service.","required":["ClientParameters","GatewayResponse"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters"},"Deadline":{"format":"date-time","type":"string"},"RequestedTitle":{"description":"Optional. The Title Number for which data was originally requested, if different from that actually returned (such as if closed-and-continued). If not provided, the TitleNumber in the Summary data will be used.","pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"string"},"Documents":{"description":"Optional. If specified provide one or more PDF documents related to the title (as returned from the Register Extract Service). By convention, the first document will contain an Official Copy of the Register of Title and the second an Official Copy of the Title Plan. Specifying an array (empty or otherwise) here will override any attachments in the GatewayResponse property.","type":"array","items":{"$ref":"#/definitions/NamedBlob"}},"GatewayResponse":{"description":"Provide the XML SOAP Envelope or ResponseOCWithSummaryV2_1Type or GatewayResponse verbatim from the LRBG, base-64 encoded. Attachment contents will be accepted if valid ZIP or PDF format data is found. Attachment contents are skipped if any value is provided for the Documents property.","type":"string"},"TitleCheckParameters":{"type":"object"},"TitleCheckProfile":{"type":"string"}}},"NamedBlob":{"description":"Represents a simple pairing of file/blob contents with a name.","required":["Content"],"type":"object","properties":{"Name":{"description":"Specifies the name of the file/blob.","type":"string"},"Content":{"description":"Specifies the base-64 encoded content of the file/blob.","type":"string"}}},"SavedRESData":{"description":"The RES data saved in the Document Store.","required":["RequestedTitle"],"type":"object","properties":{"RequestedTitle":{"description":"The title number from the Title Check request (not necessarily the same as the title number of the OC and RES data returned by the LRBG).","type":"string"},"Summary":{"$ref":"#/definitions/Q1OCSummaryDataType","description":"The RES Summary Data. May be null (though that would be very unusual)."},"Registers":{"$ref":"#/definitions/Q1OCRegisterDataType","description":"The RES Registers Data. May be null (though that would be very unusual)."}}},"Q1OCSummaryDataType":{"type":"object","properties":{"OfficialCopyDateTime":{"$ref":"#/definitions/DateTimeType"},"EditionDate":{"$ref":"#/definitions/DateType"},"PricePaidEntry":{"$ref":"#/definitions/Q1PricePaidEntryType"},"PropertyAddress":{"type":"array","items":{"$ref":"#/definitions/Q1AddressType"}},"Title":{"$ref":"#/definitions/Q1TitleType"},"RegisterEntryIndicators":{"$ref":"#/definitions/Q1RegisterEntryIndicatorsType"},"Proprietorship":{"$ref":"#/definitions/Q1ProprietorshipType"},"Lease":{"type":"array","items":{"$ref":"#/definitions/Q1LeaseType"}},"RestrictionDetails":{"type":"array","items":{"$ref":"#/definitions/Q1RestrictionEntryType"}},"Charge":{"type":"array","items":{"$ref":"#/definitions/Q1ChargeDetailsType"}},"AgreedNotice":{"type":"array","items":{"$ref":"#/definitions/Q1AgreedNoticeType"}},"Bankruptcy":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"Caution":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"DeedOfPostponement":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"GreenOutEntry":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"HomeRights":{"type":"array","items":{"$ref":"#/definitions/Q1HomeRightsType"}},"RentCharge":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"VendorsLien":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"RightOfPreEmption":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"DocumentDetails":{"type":"array","items":{"$ref":"#/definitions/Q1DocumentEntryType"}},"UnilateralNoticeDetails":{"type":"array","items":{"$ref":"#/definitions/Q1UnilateralNoticeDetailsType"}},"DeathOfProprietor":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"DiscountCharge":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"EquitableCharge":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"NotedCharge":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"CreditorsNotice":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"UnidentifiedEntry":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}},"CCBIEntry":{"type":"array","items":{"$ref":"#/definitions/Q1EntryDetailsType"}}}},"Q1OCRegisterDataType":{"type":"object","properties":{"PropertyRegister":{"$ref":"#/definitions/Q1RegisterType"},"ProprietorshipRegister":{"$ref":"#/definitions/Q1RegisterType"},"ChargesRegister":{"$ref":"#/definitions/Q1RegisterType"}}},"DateTimeType":{"type":"object","properties":{"Value":{"format":"date-time","type":"string"}}},"DateType":{"type":"object","properties":{"Value":{"format":"date-time","type":"string"}}},"Q1PricePaidEntryType":{"type":"object","properties":{"MultipleTitleIndicator":{"enum":["Item2","MoreThan2"],"type":"string"},"MultipleTitleIndicatorSpecified":{"type":"boolean"},"EntryDetails":{"$ref":"#/definitions/Q1EntryDetailsType"}}},"Q1AddressType":{"type":"object","properties":{"PostcodeZone":{"$ref":"#/definitions/Q1PostcodeZoneType"},"AddressLine":{"$ref":"#/definitions/AddressLineType"}}},"Q1TitleType":{"type":"object","properties":{"TitleNumber":{"$ref":"#/definitions/Q2TextType1"},"ClassOfTitleCode":{"$ref":"#/definitions/ClassOfTitleCodeType"},"CommonholdIndicator":{"$ref":"#/definitions/IndicatorType1"},"TitleRegistrationDetails":{"$ref":"#/definitions/Q1TitleRegistrationDetailsType"}}},"Q1RegisterEntryIndicatorsType":{"type":"object","properties":{"AgreedNoticeIndicator":{"$ref":"#/definitions/IndicatorType1"},"BankruptcyIndicator":{"$ref":"#/definitions/IndicatorType1"},"CautionIndicator":{"$ref":"#/definitions/IndicatorType1"},"CCBIIndicator":{"$ref":"#/definitions/IndicatorType1"},"ChargeeIndicator":{"$ref":"#/definitions/IndicatorType1"},"ChargeIndicator":{"$ref":"#/definitions/IndicatorType1"},"ChargeRelatedRestrictionIndicator":{"$ref":"#/definitions/IndicatorType1"},"ChargeRestrictionIndicator":{"$ref":"#/definitions/IndicatorType1"},"CreditorsNoticeIndicator":{"$ref":"#/definitions/IndicatorType1"},"DeathOfProprietorIndicator":{"$ref":"#/definitions/IndicatorType1"},"DeedOfPostponementIndicator":{"$ref":"#/definitions/IndicatorType1"},"DiscountChargeIndicator":{"$ref":"#/definitions/IndicatorType1"},"EquitableChargeIndicator":{"$ref":"#/definitions/IndicatorType1"},"GreenOutEntryIndicator":{"$ref":"#/definitions/IndicatorType1"},"HomeRightsChangeOfAddressIndicator":{"$ref":"#/definitions/IndicatorType1"},"HomeRightsIndicator":{"$ref":"#/definitions/IndicatorType1"},"LeaseHoldTitleIndicator":{"$ref":"#/definitions/IndicatorType1"},"MultipleChargeIndicator":{"$ref":"#/definitions/IndicatorType1"},"NonChargeRestrictionIndicator":{"$ref":"#/definitions/IndicatorType1"},"NotedChargeIndicator":{"$ref":"#/definitions/IndicatorType1"},"PricePaidIndicator":{"$ref":"#/definitions/IndicatorType1"},"PropertyDescriptionNotesIndicator":{"$ref":"#/definitions/IndicatorType1"},"RentChargeIndicator":{"$ref":"#/definitions/IndicatorType1"},"RightOfPreEmptionIndicator":{"$ref":"#/definitions/IndicatorType1"},"ScheduleOfLeasesIndicator":{"$ref":"#/definitions/IndicatorType1"},"SubChargeIndicator":{"$ref":"#/definitions/IndicatorType1"},"UnidentifiedEntryIndicator":{"$ref":"#/definitions/IndicatorType1"},"UnilateralNoticeBeneficiaryIndicator":{"$ref":"#/definitions/IndicatorType1"},"UnilateralNoticeIndicator":{"$ref":"#/definitions/IndicatorType1"},"VendorsLienIndicator":{"$ref":"#/definitions/IndicatorType1"}}},"Q1ProprietorshipType":{"type":"object","properties":{"CurrentProprietorshipDate":{"$ref":"#/definitions/DateType"},"Items":{"type":"array","items":{"$ref":"#/definitions/Q1PartyType"}},"ItemsElementName":{"type":"array","items":{"enum":["CautionerParty","RegisteredProprietorParty"],"type":"string"}}}},"Q1LeaseType":{"type":"object","properties":{"LeaseTerm":{"$ref":"#/definitions/LeaseTermTextType"},"LeaseDate":{"$ref":"#/definitions/TextType"},"Rent":{"$ref":"#/definitions/RentAmountTextType"},"LeaseParty":{"type":"array","items":{"$ref":"#/definitions/Q1PartyType"}},"EntryDetails":{"$ref":"#/definitions/Q1EntryDetailsType"}}},"Q1RestrictionEntryType":{"type":"object","properties":{"Item":{"$ref":"#/definitions/Q1RestrictionType"},"ItemElementName":{"enum":["ChargeRelatedRestriction","ChargeRestriction","NonChargeRestriction"],"type":"string"}}},"Q1ChargeDetailsType":{"type":"object","properties":{"ChargeID":{"$ref":"#/definitions/TextType"},"ChargeDate":{"$ref":"#/definitions/DateType"},"RegisteredCharge":{"$ref":"#/definitions/Q1ChargeType"},"ChargeProprietor":{"$ref":"#/definitions/Q1ChargeProprietorType"},"SubCharge":{"type":"array","items":{"$ref":"#/definitions/Q1SubChargeDetailsType"}}}},"Q1AgreedNoticeType":{"type":"object","properties":{"AgreedNoticeType":{"enum":["Item10","Item20"],"type":"string"},"AgreedNoticeTypeSpecified":{"type":"boolean"},"EntryDetails":{"$ref":"#/definitions/Q1EntryDetailsType"}}},"Q1EntryDetailsType":{"type":"object","properties":{"EntryNumber":{"$ref":"#/definitions/TextType"},"EntryText":{"$ref":"#/definitions/TextType"},"RegistrationDate":{"$ref":"#/definitions/DateType"},"Item":{"type":"object"},"Infills":{"type":"array","items":{"type":"object"}}}},"Q1HomeRightsType":{"type":"object","properties":{"ChangeOfAddressIndicator":{"$ref":"#/definitions/IndicatorType1"},"HomeRightsEntryDetails":{"$ref":"#/definitions/Q1EntryDetailsType"},"ChangeOfAddressEntryDetails":{"$ref":"#/definitions/Q1EntryDetailsType"}}},"Q1DocumentEntryType":{"type":"object","properties":{"DocumentType":{"enum":["Item10","Item20","Item30","Item40","Item50","Item60","Item70","Item80","Item90","Item100","Item110","Item120","Item130","Item140","Item150","Item160","Item170","Item180"],"type":"string"},"DocumentDate":{"$ref":"#/definitions/TextType"},"EntryNumber":{"type":"array","items":{"$ref":"#/definitions/TextType"}},"PlanOnlyIndicator":{"$ref":"#/definitions/IndicatorType1"},"FiledUnder":{"$ref":"#/definitions/TextType"},"RegisterDescription":{"$ref":"#/definitions/TextType"}}},"Q1UnilateralNoticeDetailsType":{"type":"object","properties":{"UnilateralNotice":{"$ref":"#/definitions/Q1EntryDetailsType"},"UnilateralNoticeBeneficiary":{"$ref":"#/definitions/Q1EntryDetailsType"}}},"Q1RegisterType":{"type":"object","properties":{"DistrictDetails":{"type":"array","items":{"$ref":"#/definitions/TextType"}},"RegisterEntry":{"type":"array","items":{"$ref":"#/definitions/Q1RegisterEntryType"}},"Schedule":{"type":"array","items":{"$ref":"#/definitions/Q1ScheduleType"}}}},"Q1PostcodeZoneType":{"type":"object","properties":{"Postcode":{"$ref":"#/definitions/TextType"}}},"AddressLineType":{"type":"object","properties":{"IndexNumeric":{"type":"array","items":{"$ref":"#/definitions/NumericType"}},"Line":{"type":"array","items":{"$ref":"#/definitions/TextType"}}}},"Q2TextType1":{"type":"object","properties":{"Value":{"type":"string"}}},"ClassOfTitleCodeType":{"type":"object","properties":{"Value":{"enum":["Item10","Item20","Item30","Item40","Item50","Item60","Item70","Item80","Item90","Item100","Item110","Item120","Item130"],"type":"string"}}},"IndicatorType1":{"type":"object","properties":{"Value":{"type":"boolean"}}},"Q1TitleRegistrationDetailsType":{"type":"object","properties":{"DistrictName":{"$ref":"#/definitions/DistrictNameTextType"},"AdministrativeArea":{"$ref":"#/definitions/AdministrativeAreaTextType"},"LandRegistryOfficeName":{"$ref":"#/definitions/LandRegistryOfficeNameTextType"},"LatestEditionDate":{"$ref":"#/definitions/DateType"},"PostcodeZone":{"type":"array","items":{"$ref":"#/definitions/Q1PostcodeZoneType"}},"RegistrationDate":{"$ref":"#/definitions/DateType"}}},"Q1PartyType":{"type":"object","properties":{"Item":{"type":"object"},"Address":{"type":"array","items":{"$ref":"#/definitions/Q1AddressType"}},"CharityDetails":{"$ref":"#/definitions/Q1CharityDetailsType"},"TradingName":{"$ref":"#/definitions/TextType"},"PartyNumber":{"$ref":"#/definitions/TextType"},"PartyDescription":{"$ref":"#/definitions/TextType"}}},"LeaseTermTextType":{"type":"object","properties":{"Value":{"type":"string"}}},"TextType":{"type":"object","properties":{"Value":{"type":"string"}}},"RentAmountTextType":{"type":"object","properties":{"Value":{"type":"string"}}},"Q1RestrictionType":{"type":"object","properties":{"RestrictionTypeCode":{"$ref":"#/definitions/RestrictionCodeType"},"ChargeID":{"$ref":"#/definitions/TextType"},"EntryDetails":{"$ref":"#/definitions/Q1EntryDetailsType"}}},"Q1ChargeType":{"type":"object","properties":{"MultipleTitleIndicator":{"$ref":"#/definitions/TextType"},"EntryDetails":{"$ref":"#/definitions/Q1EntryDetailsType"}}},"Q1ChargeProprietorType":{"type":"object","properties":{"ChargeeParty":{"type":"array","items":{"$ref":"#/definitions/Q1PartyType"}},"EntryDetails":{"$ref":"#/definitions/Q1EntryDetailsType"}}},"Q1SubChargeDetailsType":{"type":"object","properties":{"ChargeDate":{"$ref":"#/definitions/DateType"},"RegisteredCharge":{"$ref":"#/definitions/Q1ChargeType"},"ChargeProprietor":{"$ref":"#/definitions/Q1ChargeProprietorType"}}},"Q1RegisterEntryType":{"type":"object","properties":{"EntryNumber":{"$ref":"#/definitions/TextType"},"EntryDate":{"$ref":"#/definitions/TextType"},"EntryType":{"$ref":"#/definitions/TextType"},"EntryText":{"type":"array","items":{"$ref":"#/definitions/TextType"}}}},"Q1ScheduleType":{"type":"object","properties":{"ScheduleType":{"$ref":"#/definitions/TextType"},"ScheduleEntry":{"type":"array","items":{"$ref":"#/definitions/Q1RegisterEntryType"}}}},"NumericType":{"type":"object","properties":{"Value":{"format":"double","type":"number"}}},"DistrictNameTextType":{"type":"object","properties":{"Value":{"type":"string"}}},"AdministrativeAreaTextType":{"type":"object","properties":{"Value":{"type":"string"}}},"LandRegistryOfficeNameTextType":{"type":"object","properties":{"Value":{"type":"string"}}},"Q1CharityDetailsType":{"type":"object","properties":{"CharityName":{"type":"array","items":{"$ref":"#/definitions/TextType"}},"CharityAddress":{"type":"array","items":{"$ref":"#/definitions/Q1AddressType"}},"CharityType":{"$ref":"#/definitions/CharityCodeType"}}},"RestrictionCodeType":{"type":"object","properties":{"Value":{"enum":["Item0","Item10","Item20","Item30"],"type":"string"}}},"CharityCodeType":{"type":"object","properties":{"Value":{"enum":["C","R","S"],"type":"string"}}},"TitleCheckResults":{"required":["TitleNumberRequested","DataExtract","CheckedAt","Issues"],"type":"object","properties":{"TitleNumberRequested":{"type":"string"},"DataExtract":{"$ref":"#/definitions/TitleDataExtract"},"CheckedAt":{"format":"date-time","type":"string"},"Issues":{"type":"array","items":{"$ref":"#/definitions/Issue"}}}},"TitleDataExtract":{"description":"Information that has been extracted from the RES return.","required":["TitleNumber","OCDateTime","EditionDate","District","LROfficeName","PropertyData","ProprietorsData"],"type":"object","properties":{"TitleNumber":{"description":"The title number of the returned OC (not necessarily the same as the title number asked for)","type":"string"},"OCDateTime":{"format":"date-time","description":"The OC date/time","type":"string"},"EditionDate":{"format":"date-time","description":"The edition date","type":"string"},"District":{"description":"The district (always present)","type":"string"},"AdminstrativeArea":{"description":"The administrative area (always present)","type":"string"},"LROfficeName":{"description":"The LR office name (always present)","type":"string"},"PropertyData":{"$ref":"#/definitions/PropertyData","description":"Data extracted about the property (always present)"},"Leases":{"description":"Data extracted about the leases, each corresponding to the same entry from the RES summary. Present only if this is a leasehold property (when it may be an empty array), otherwise null.","type":"array","items":{"$ref":"#/definitions/Lease"}},"SchedulesOfLeases":{"description":"Null if the OC contains no schedules of leases, otherwise 0 or more \"schedules\" (where a \"schedule\" is defined as a Schedule entry (i.e. an entry of type Q1ScheduleType) in any of the Property, Proprietorship and Charges Registers whose \"ScheduleType\" is the text \"SCHEDULE OF NOTICES OF LEASE\"). An empty array means that the \"schedule of leases\" is actually just an ordinary entry in the Charges Register.","type":"array","items":{"$ref":"#/definitions/ScheduleOfLeases"}},"ProprietorsData":{"$ref":"#/definitions/ProprietorsData","description":"Data extracted about the proprietor(s) (always present)"},"RegisteredChargesData":{"$ref":"#/definitions/RegisteredChargesData","description":"Data extracted about the registered charges if any, or null if there are no registered charges"},"ExtraTitleNumbers":{"description":"Details of 1 or more \"extra title numbers\" found, or null if no extra title numbers were found. An \"extra title number\" is a title number mentioned in the OC which is likely to be \"relevant\" when doing something involving the current title number.","type":"array","items":{"$ref":"#/definitions/ExtraTitleNumber"}},"FormARestrictions":{"description":"The register entries that were identified as Form A restrictions, or null if no Form A restrictions were found.","type":"array","items":{"$ref":"#/definitions/RegisterEntry"}},"FormPRestrictions":{"description":"Details of 1 or more Form P restrictions found, or null if no Form P restrictions were found.","type":"array","items":{"$ref":"#/definitions/FormPRestriction"}},"FormLLRestrictions":{"type":"array","items":{"$ref":"#/definitions/RegisterEntry"}},"OtherRestrictions":{"type":"array","items":{"$ref":"#/definitions/RegisterEntry"}},"Documents":{"description":"Data extracted about the documents referred to on the register, or null if no such documents were found.","type":"array","items":{"$ref":"#/definitions/Document"}}}},"Issue":{"required":["IssueId","IssueType","Message"],"type":"object","properties":{"CheckName":{"type":"string"},"IssueId":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IssueType":{"enum":["None","UnableToTitleCheck","TitleCommonhold","DifferentTitleNumber","IncompletePropertyAddress","MultiplePropertyAddresses","LeaseholdUnclear","MultipleLeaseEntries","LeaseDetailsNotParsable","ScheduleOfLeases","NoProprietorshipDate","ProprietorIsCompany","ChargePrioritiesChanged","RegChargeSecondMortgage","RegChargeProprietorNotCompany","MultipleChargeParties","MultipleChargeeParties","NoChargeDate","NoRegistrationDate","RegChargeSubcharge","ExtraTitleNumber","DeedOfPostponement","Matrimonial","FormARestrictionSingleProprietor","FormPRestriction","FormLLRestriction","Restriction","RightToBuyCharge","InhibitionCaution","OptionToPurchase","RightOfPreEmption","ProprietorNotice","EquitableCharge","NotedCharge","FlyingFreehold","Footprint","GreenOutEntry","MissingDocument","BankruptcyNotice","UnidentifiedEntry","MissingLeaseDetails","PendingApplication","PossibleSharedOwnership","MiningLease","ProprietorCountsDiffer","DuplicateExpectedProprietors","DuplicateRegisteredProprietors","InexactProprietorMatch","UnmatchedExpectedProprietor","UnmatchedRegisteredProprietor"],"type":"string"},"Message":{"type":"string"}}},"PropertyData":{"description":"Data extracted about the property","required":["TitleCode","Class","Tenure","Commonhold","Addresses","IsNotMainTitle"],"type":"object","properties":{"TitleCode":{"description":"The \"class of title code\" from the RES data, e.g. \"Qualified Freehold\"","type":"string"},"Class":{"description":"The class of title, e.g. Absoulte (derived from TitleCode)","enum":["Other","Absolute","Possessory","Qualified","Good"],"type":"string"},"Tenure":{"description":"The title tenure, e.g. Leasehold (derived from TitleCode)","enum":["Other","Freehold","Leasehold"],"type":"string"},"Commonhold":{"description":"Is this property Commonhold?","type":"boolean"},"Addresses":{"description":"1 or more addresses for the property","type":"array","items":{"$ref":"#/definitions/Address"}},"IsNotMainTitle":{"description":"True if ALL the property addresses are definitely something other than the main part of the property (e.g. a garage or additional land). A value of false DOES NOT guarantee that this title is for the main part of the property.","type":"boolean"},"IsScottish":{"description":"True if ANY of the property addresses is definitely known to be in Scotland. False if ALL the property addresses are definitely known not to be in Scotland. Null iin all other cases (typically those where a postcode is missing).","type":"boolean"},"PurchaseRegisterEntryDate":{"format":"date-time","description":"The registration date of the \"price paid\" register entry, if there is one.","type":"string"},"PurchasePrices":{"description":"The values from the price infills (if any) of the \"price paid\" register entry, if there is one. Typically there is either a single value or two values, where two values indicates a range of prices. Null unless there is at least one price.","type":"array","items":{"format":"double","type":"number"}},"PurchaseDates":{"description":"The values from the date infills (if any) of the \"price paid\" register entry, if there is one. Null unless there is at least one date.","type":"array","items":{"format":"date-time","type":"string"}}}},"Lease":{"description":"The data extracted from a single RES LeaseEntry element if this is a leasehold property.","required":["Parties","LeaseTermText","UnableToFullyParseTerm","RegisterEntry"],"type":"object","properties":{"Parties":{"description":"Two or more parties to the lease.","type":"array","items":{"$ref":"#/definitions/Party"}},"LeaseTermText":{"description":"The text containing details of the lease term.","type":"string"},"UnableToFullyParseTerm":{"description":"If true then the lease term could not be fully parsed. Some information may have been extracted, but the term should be checked manually before relying on any such information.","type":"boolean"},"TermInYears":{"format":"int32","description":"The lease term in years, rounded down if is not a whole number of years, or null if it cannot be determined.","type":"integer"},"TermStartDate":{"format":"date-time","description":"The lease start date, or null if it cannot be determined.","type":"string"},"TermEndDate":{"format":"date-time","description":"The lease end date (i.e. the last date on which the lease is valid), or null if it cannot be determined. The date 31/12/9998 is a special value indicating that the lease end date is outside the range of a DateTime value (because the lease duration is a very long period, e.g. 10,000 years).","type":"string"},"YearsRemaining":{"format":"int32","description":"Number of whole years remaining on the lease at the date the Title Check was performed, or null it it cannot be determined.","type":"integer"},"RegisterEntry":{"$ref":"#/definitions/RegisterEntry","description":"The register entry containing the lease details."}}},"ScheduleOfLeases":{"description":"Data from an entry of type Q1ScheduleType whose ScheduleType is \"SCHEDULE OF NOTICES OF LEASE\"","required":["ScheduleEntries"],"type":"object","properties":{"ScheduleEntries":{"description":"1 or more schedukle entries","type":"array","items":{"$ref":"#/definitions/ScheduleOfLeasesEntry"}}}},"ProprietorsData":{"description":"Data extracted from the RES about the registered proprietors of the property","required":["Proprietors"],"type":"object","properties":{"ProprietorshipDate":{"format":"date-time","description":"Defined in the RES schema as \"the date of the proprietorship entry in theRegister\". May be null.","type":"string"},"Proprietors":{"description":"1 or more proprietors. Typically there are at most 4 proprietors.","type":"array","items":{"$ref":"#/definitions/Party"}}}},"RegisteredChargesData":{"description":"Information extracted from the RES about the registered charges on the property","required":["PrioritiesChanged","Charges"],"type":"object","properties":{"PrioritiesChanged":{"description":"Set to true if entries are found indicating that the charge priorities are different from the order in which they appear in the Charges register.","type":"boolean"},"Charges":{"description":"Details of 1 or more registered charges","type":"array","items":{"$ref":"#/definitions/RegisteredCharge"}}}},"ExtraTitleNumber":{"description":"Information about an \"extra title number\" found in the OC, and the register entries that refer to it","required":["TitleNumber","RegisterEntries"],"type":"object","properties":{"TitleNumber":{"description":"The title number (non-null and non-empty)","type":"string"},"RegisterEntries":{"description":"1 or more register entries that refer to the title number","type":"array","items":{"$ref":"#/definitions/RegisterEntry"}}}},"RegisterEntry":{"description":"Represents one entry from one of the Property, Proprietorship or Charges registers","required":["Register","IsSchedule","EntryNumber","Text"],"type":"object","properties":{"Register":{"description":"The register containing the entry","enum":["Unknown","Property","Proprietorship","Charges"],"type":"string"},"IsSchedule":{"description":"Whether this entry is a normal register entry (false) or is an entry in a schedule (true)","type":"boolean"},"ScheduleType":{"description":"If this is an entry in a schedule then the schedule type, otherwise null.","type":"string"},"ScheduleNumber":{"format":"int32","description":"If this is an entry in a schedule then the 1-based index into the array of Schedules for this register, otherwise null.","type":"integer"},"EntryNumber":{"description":"The non-null non-empty entry \"number\". Although normally an integer, it is typed as a string in the RES schema.","type":"string"},"EntryType":{"description":"An optional string (so may be null) describing the type of the register entry. The possible values are not defined anywhere, but on 30/05/2012 Matthew Bell of the Land Registry gave us a list (of some 300 entries) of all the values he knew about.","type":"string"},"EntryDate":{"format":"date-time","description":"Date of the entry. May be null.","type":"string"},"RegistrationDate":{"format":"date-time","description":"Registration date of the entry. May be null. I believe this only applies to certain types of entry.","type":"string"},"TextHasNewlines":{"description":"If present and true, then the text of the entry preserves the line breaks in the register. Entries with this value set should be displayed in a fixed-width font as they are typically formatted so as to appear in columns.","type":"boolean"},"Text":{"description":"Text of the entry. If TextHasNewlines == true then lines are separated with Environment.Newline, otherwise line breaks have been replaced by spaces.","type":"string"}}},"FormPRestriction":{"description":"Information about a Form P restriction","required":["RegisterEntry","ForExistingCharge"],"type":"object","properties":{"RegisterEntry":{"$ref":"#/definitions/RegisterEntry","description":"The register entry that was identified as a Form P restriction"},"ForExistingCharge":{"description":"Whether this restriction was identified as being for an existing charge","type":"boolean"}}},"Document":{"description":"The data extracted from a single RES Q1DocumentEntry element, describing a document referred to on the register.","required":["DocumentType","EntryNumbers","PlanOnly"],"type":"object","properties":{"DocumentType":{"description":"The document type.","enum":["Abstract","Agreement","Assent","Assignment","Charge","Conveyance","Deed","Indenture","Lease","Licence","Plan","SubCharge","Transfer","Other","CommonholdCommunityStatement","MemorandumAndArticlesOfAssociation","SurrenderOfDevelopmentRights","TerminationDocument"],"type":"string"},"DocumentDate":{"format":"date-time","description":"The document date (optional).","type":"string"},"EntryNumbers":{"description":"An array of the letter and entry number within the relevant Sub-Register or Schedule. There will always be at least one element.","type":"array","items":{"type":"string"}},"PlanOnly":{"description":"Whether the document is only held as a plan.","type":"boolean"},"FiledUnder":{"description":"Null unless the document is filed under a different title number, in which case it contains that title number.","type":"string"},"RegisterDescription":{"description":"The full description of the document as it appears on the register.","type":"string"}}},"ScheduleOfLeasesEntry":{"description":"An entry from a schedule of leases","required":["EntryText"],"type":"object","properties":{"EntryText":{"description":"The text of the entry. It may have multiple lines separated by Environment.Newline. The lines are typically formatted by internal padding with spaces for a multi-column display, and so are best  displayed in a fixed-width font!","type":"string"},"TitleNumber":{"description":"A \"best guess\" at the title number from the entry, or null if a title number cannot be found. Not guaranteed to be correct, and may be null even if the entry does contain a title number.","type":"string"}}},"RegisteredCharge":{"description":"Information about a registered charge","required":["ChargeEntry","ProprietorEntry"],"type":"object","properties":{"ChargeEntry":{"$ref":"#/definitions/RegisterEntry","description":"The register entry for the charge. Will not be null."},"ChargeDate":{"format":"date-time","description":"The charge date. Can be null.","type":"string"},"ProprietorEntry":{"$ref":"#/definitions/RegisterEntry","description":"The register entry for the charge proprietors. Will not be null."},"Proprietors":{"description":"1 or more charge proprietors.","type":"array","items":{"$ref":"#/definitions/Party"}},"SubCharges":{"description":"The sub-charges for this charge, if any. If there are no sub-charges this field is null rather than an empty array. There can only be one level of sub-charges, i.e. a sub-charge cannot itself have sub-charges.","type":"array","items":{"$ref":"#/definitions/RegisteredCharge"}}}},"DocumentsRequest":{"description":"The specification of an OC2 (Documents) request to be issued.","required":["RequiredDocuments","ClientParameters","TitleNumber","PropertyDescription"],"type":"object","properties":{"RequiredDocuments":{"description":"Mandatory. Details of 1 or more documents required.","type":"array","items":{"$ref":"#/definitions/OC2DocumentSpec"}},"ClientParameters":{"$ref":"#/definitions/ClientParameters","description":"Information about the client issuing the request"},"Deadline":{"format":"date-time","description":"If provided (ISO8601/like format yyyy-MM-dd HH:mm:ss), specifies that if the final response has not been received from the LRBG before the Deadline is met, the Request will be marked as Expired and made available for immediate return (LRBG costs may still be incurred).","type":"string"},"ContinueIfTitleClosedAndContinued":{"type":"boolean"},"NotifyIfPendingApplication":{"type":"boolean"},"NotifyIfPendingFirstRegistration":{"type":"boolean"},"SendBackDatedIndicator":{"type":"boolean"},"TitleNumber":{"description":"Mandatory. The title number for which documents are required.","pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"string"},"PropertyDescription":{"description":"Mandatory. A description of the property (typically the address) for use by the LR if there is a problem identifying the property from the title number. Maximum of 130 characters.","type":"string"},"AlternativeDespatchDetails":{"$ref":"#/definitions/AlternativeDespatchDetails","description":"Optional details of where to send any non-electronic results (if they are not to be sent to the default address)"}}},"OC2DocumentSpec":{"description":"Represents the specification of a document to be retrieved as part of an OC2 request","required":["DocumentType"],"type":"object","properties":{"DocumentType":{"description":"The type of document. Must be specified.","enum":["Abstract","Agreement","Assent","Assignment","Charge","Conveyance","Deed","Indenture","Lease","Licence","Plan","SubCharge","Transfer","Other","CommonholdCommunityStatement","MemorandumAndArticlesOfAssociation","SurrenderOfDevelopmentRights","TerminationDocument"],"type":"string"},"Date":{"format":"date-time","description":"The date of the document (in the format yyyy-mm-dd), or null for the most recent version.","type":"string"},"FileUnder":{"description":"Null unless the document is filed under a different (from the title number of the request) title number.","pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"string"},"AdditionalInformation":{"description":"Null unless DocumentType is Other, when it must be a non-empty string describing the document.","pattern":".*\\S.*","type":"string"}}},"DocumentsResponse":{"description":"Details of a Docxuments Request that has been isuued.","required":["DocumentsRequired","ClientParameters","ResponseCommon","TitleNumber","PropertyDescription"],"type":"object","properties":{"DocumentsRequired":{"description":"Mandatory. Details of 1 or more documents requested.","type":"array","items":{"$ref":"#/definitions/OC2DocumentSpec"}},"ClientParameters":{"$ref":"#/definitions/ClientParameters","description":"Information about the client issuing the request"},"ResponseCommon":{"$ref":"#/definitions/LrbgResponseCommon","description":"Information about the status of the rqeuest."},"TitleNumber":{"description":"The title number for which documents are required.","type":"string"},"PropertyDescription":{"description":"A description of the property (typically the address) for use by the LR if there is a problem identifying the property from the title number.","type":"string"},"AlternativeDespatchDetails":{"$ref":"#/definitions/AlternativeDespatchDetails","description":"Optional details of where to send any non-electronic results (if they are not to be sent to the default address)"},"ReturnedDocuments":{"$ref":"#/definitions/ReturnedDocuments","description":"Details of the documents (if any) returned by the LRBG if the request succeeded. Note that if more than one document was requested then there is no automatic method for matching the returned documents with the requested documents, and manual inspection will probably be needed."}}},"TitleNumbersResult":{"description":"An array of the title numbers matching the request parameters","required":["Titles"],"type":"object","properties":{"Titles":{"type":"array","items":{"$ref":"#/definitions/TitleDetails"}}}},"TitleDetails":{"description":"Details of one title number that matches the request parameters","required":["TitleNumber","Address"],"type":"object","properties":{"TitleNumber":{"description":"The title number","type":"string"},"Address":{"$ref":"#/definitions/LRAddress","description":"The address of the property"},"Description":{"description":"An optional description of the property. May be null.","type":"string"},"TenureCode":{"format":"int32","description":"The LR code for the Tenure (e.g.10 for Freehold)","type":"integer"},"Tenure":{"description":"The tenure converted to a user-friendly String, e.g. \"freehold\"","type":"string"}}},"LRAddress":{"description":"An address in the format returned by the LRBG. The field names should bve self-explanatory.","type":"object","properties":{"BuildingName":{"type":"string"},"SubBuildingName":{"type":"string"},"BuildingNumber":{"type":"string"},"Street":{"type":"string"},"City":{"type":"string"},"Postcode":{"type":"string"}}},"LrbgItemDetailsApiError":{"description":"Information about an error that has occurred","required":["ItemDetails"],"type":"object","properties":{"LRBGErrorCode":{"description":"If the error was one returned by the LRBG, the LRBG error code if specified. May be null.","type":"string"},"ItemDetails":{"description":"Contains details of errors and associated items","type":"array","items":{"$ref":"#/definitions/ErrorItemDetails"}},"ErrorMessage":{"description":"A message describing the error. May be null.","type":"string"}}},"LrbgApiError":{"description":"Information about an error that has occurred","type":"object","properties":{"LRBGErrorCode":{"description":"If the error was one returned by the LRBG, the LRBG error code if specified. May be null.","type":"string"},"ErrorMessage":{"description":"A message describing the error. May be null.","type":"string"}}},"TitlePlanRequest":{"required":["ClientParameters","TitleNumber","PropertyDescription"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters","description":"Information about the client issuing the request"},"Deadline":{"format":"date-time","description":"If provided (ISO8601/like format yyyy-MM-dd HH:mm:ss), specifies that if the final response has not been received from the LRBG before the Deadline is met, the Request will be marked as Expired and made available for immediate return (LRBG costs may still be incurred).","type":"string"},"ContinueIfTitleClosedAndContinued":{"type":"boolean"},"NotifyIfPendingApplication":{"type":"boolean"},"NotifyIfPendingFirstRegistration":{"type":"boolean"},"SendBackDatedIndicator":{"type":"boolean"},"TitleNumber":{"description":"Mandatory. The title number for which documents are required.","pattern":"^[A-Z]{0,3}[0-9]{1,6}[TZ]?$","type":"string"},"PropertyDescription":{"description":"Mandatory. A description of the property (typically the address) for use by the LR if there is a problem identifying the property from the title number. Maximum of 130 characters.","type":"string"},"AlternativeDespatchDetails":{"$ref":"#/definitions/AlternativeDespatchDetails","description":"Optional details of where to send any non-electronic results (if they are not to be sent to the default address)"}}},"TitlePlanResponse":{"description":"Results of a TitlePlan request.","required":["ClientParameters","ResponseCommon","TitleNumber","PropertyDescription"],"type":"object","properties":{"ClientParameters":{"$ref":"#/definitions/ClientParameters","description":"Information about the client issuing the request"},"ResponseCommon":{"$ref":"#/definitions/LrbgResponseCommon","description":"Information about the status of the rqeuest."},"TitleNumber":{"description":"The title number for which documents are required.","type":"string"},"PropertyDescription":{"description":"A description of the property (typically the address) for use by the LR if there is a problem identifying the property from the title number.","type":"string"},"AlternativeDespatchDetails":{"$ref":"#/definitions/AlternativeDespatchDetails","description":"Optional details of where to send any non-electronic results (if they are not to be sent to the default address)"},"ReturnedDocuments":{"$ref":"#/definitions/ReturnedDocuments","description":"Details of the documents (if any) returned by the LRBG if the request succeeded. Note that if more than one document was requested then there is no automatic method for matching the returned documents with the requested documents, and manual inspection will probably be needed."}}},"TeUser":{"type":"object","properties":{"name":{"type":"string"},"time_created":{"format":"date-time","type":"string"},"time_disabled":{"format":"date-time","type":"string"},"lrbg_username":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"}}}