API Reference

Create a title analysis

post
https://secure.finch-app.com/api/public/v1/title//analysis

Creates and performs a new title analysis on the given title. If the title is not held on file in your cloud, the title can be automatically ordered using HM Land Registry Business Gateway.

Ordering titles is billed by HM Land Registry to the Business Gateway account.

Permissions

The following permissions are required to call this API. Learn more.

Permission typePermissions
API key action permissionTitle
Folder access control list permissionSender

Remarks

When titles are being ordered from HM Land Registry, the title order may be postponed for processing at their discression. When this occurs, the status of your title analysis will be "Queued". You can then await the "titleAnalysis_ready" webhook for when the title analysis is ready, or you may periodically poll "Get Analysis" (4 hour recommended poll time).

Path Params
string | null
required
Body Params

Specifies business gateway credentials and title analysis configuration

string
required
length ≥ 1

The HM Land Registry Business Gateway username

string
required
length ≥ 1

The HM Land Registry Business Gateway password

uuid | null

An optional unique request ID (uuid) for resiliance and debugging purposes. Send any properly generated new uuid. If one is not provided (not recommended), a new request ID will be generated for you.

string | null

Optional. When placing an order for a title (as needed), specifies the path to the folder, seperated by forward slashes '/' that the resulting title will be stored in.
If a folder is not specified, the default folder of the application will be used, if it has one. If no folder can be resolved, an error will be raised.

string | null

Optional. When placing an order for a title (as needed), specifies your reference for order, as recorded on The HM Land Registry Business Gateway

boolean

Optional, defaults to true. If you do not have a copy of the title on file, orders the title automatically from HM Land Registry using HM Land Registry business gateway.

boolean

Optional, defaults to false. When placing an order for a title (as needed), specifies if a copy of the title plan will be ordered alongside, if one exists. Ordering title plans is billable with HM Land Registry.

boolean

Optional, defaults to false. Determines if a HM Land Registry title will be ordered (as needed) when there is a pending application on the property.

analysisConfiguration

Optional. Specifies custom risk analysis rules for title analysis.

Responses

Updated almost 2 years ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 2 years ago