v4

latestSwagger 2.02026-08-033766226.9 KB

PropertyRegister

Retrieves property registry check associated with the registration.

get/api/property-register/{id}

idstring uuid required

Id of the registration.

apikeystring required

ApiKey supplied.

Details of the property register check.

matchResult0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

Unknown = 0, FullNameMatch = 1, SurnameMatch = 2, NoNameMatch = 3, NoAddressMatch = 4, TitleNotRegistered = 5, Unavailable = 6, OutOfHours = 7

matchResultTextstring

propertyOwnership0 | 1 | 2

Unknown = 0, SoleOwnership = 1, JointOwnership = 2

propertyOwnershipTextstring

titleNumberstring

checkStatus0 | 1 | 2 | 3

Unknown = 0, Pass = 1, Refer = 2, Fail = 3

hasBeenOverriddenboolean