Skip to content

Real Estate Address Object

Represents the address fields for a real estate property.

ParameterDescription
line1 string, nullablePrimary address line (e.g., street name).
line2 string, nullableSecondary address info (e.g., unit number).
city stringCity name (required).
postalCode stringPostal code (required).
parcelNumber string, nullableParcel number (required if both line1 and line2 are omitted).
cadastralArea string, nullableCadastral area (required if both line1 and line2 are omitted).

Validation Notes

  • city and postalCode must always be provided.
  • If line1 and line2 are omitted, you must supply both parcelNumber and cadastralArea.