Vepler logo
v2.169.0

Explicit country and identity fields on the property API

Property responses carry an explicit countryCode, the address country as a UK nation, the identity scheme behind locationId, and slots for UPRN and Eircode, ready for UK and Ireland.

Added

  • Property responses carry new optional fields: a sovereign countryCode (GB or IE) on both the property and its address, an idScheme (uprn or eircode) that tells you which scheme locationId holds, an explicit uprn, and an eircode slot on the address. These are additive, so existing integrations are unaffected.
  • POST /v1/property/query accepts an optional countryCode hint on the request. It is a soft signal rather than a hard filter, so omitting it keeps the current behaviour.

Changed

  • The address.country field reports the specific UK nation, one of england, scotland, wales or northern-ireland, and is null when the nation is genuinely unknown. It is derived from the same authoritative country signal used elsewhere on the record.

Affected endpoints