v4

latestSwagger 2.02026-08-033766226.9 KB

PropertyRegister

Creates new property registry check against the registration.

post/api/property-register

Headers

apikeystring required

ApiKey supplied.

Request body

regEntryIdstring uuid required

Example request

{
  "person": {
    "forename": "Angela",
    "middleName": null,
    "surname": "UK Specimen"
  },
  "address": {
    "addressLine1": "25 Westgate Street",
    "addressLine2": null,
    "addressLine3": null,
    "city": "Cardiff",
    "postcode": "CF101NS",
    "county": "Cardiff",
    "country": "United Kingdom"
  },
  "regEntryId": "12345678-1234-1234-1234-1234567890ab"
}

Response

Details of newly added data 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