id | string (UUID), 🔒 System | — | Unique ID |
full_address | string, 🔒 System | — | Concatenate all address fields. A pre-formatted full address string for display purposes (e.g. “123 Main St Apt 4B, San Francisco, CA 94103, USA”). |
address_line1 | string | ✅ Yes | Primary street address |
address_line2 | string | ⚪ No | Additional street address |
city | string | ⚪ No | City |
region | string | ⚪ No | State or province |
postal_code | string | ⚪ No | ZIP or postal code |
country | string | ✅ Yes | ISO 3166-1 alpha-2 code |
latitude | Float | ⚪ No | Geographical latitude of the address, useful for maps or distance calculations. |
longitude | Float | ⚪ No | Geographical longitude of the address, used with latitude for precise location mapping. |
is_registered | Boolean | ⚪ No | Indicates whether this is the user’s or entity’s registered address. |
is_primary | Boolean | ⚪ No | Indicates whether this is the user’s or entity’s main/default address. Default = true |
label | enum | ⚪ No | A flexible field for storing additional custom info such as delivery notes or validation source. Enum email + phone + addresses labels |
created_at | ISO 8601, 🔒 system | - | Timestamp |
updated_at | ISO 8601, 🔒 system | - | Timestamp |
deleted_at | string, 🔒 system | - | nullable ISO 8601 |