Skip to content

Real Estate Address Object ​

Represents the address fields for a real estate property. A property is located either by a street address (line1 + line2, with city and postalCode) or by cadastral data (parcelNumber + cadastralArea); the two groups are conditionally required against each other.

ParameterDescription
line1 string, nullablePrimary address line (e.g., street name).
line2 string, nullableSecondary address info (e.g., house or unit number).
city string, nullableCity name. Required unless both parcelNumber and cadastralArea are provided.
postalCode string, nullablePostal code. Required unless both parcelNumber and cadastralArea are provided.
parcelNumber string, nullableParcel number. Required when line1 or line2 is missing.
cadastralArea string, nullableCadastral area. Required when line1 or line2 is missing.

Validation Notes ​

  • A full street address needs line1, line2, city and postalCode.
  • If either line1 or line2 is missing, both parcelNumber and cadastralArea are required; city and postalCode may then be omitted.
  • If no street address (line1/line2) and no addressCoords are provided, userCoords must be supplied so the backend can resolve the region via reverse geocoding (see Real Estate Object).
  • All fields are returned in every response, unset ones as null.