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.
| Parameter | Description |
|---|---|
line1 string, nullable | Primary address line (e.g., street name). |
line2 string, nullable | Secondary address info (e.g., house or unit number). |
city string, nullable | City name. Required unless both parcelNumber and cadastralArea are provided. |
postalCode string, nullable | Postal code. Required unless both parcelNumber and cadastralArea are provided. |
parcelNumber string, nullable | Parcel number. Required when line1 or line2 is missing. |
cadastralArea string, nullable | Cadastral area. Required when line1 or line2 is missing. |
Validation Notes
- A full street address needs
line1,line2,cityandpostalCode. - If either
line1orline2is missing, bothparcelNumberandcadastralAreaare required;cityandpostalCodemay then be omitted. - If no street address (
line1/line2) and noaddressCoordsare provided,userCoordsmust 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.