Skip to main content

​
Primary key

document_id
uuiddefault:"Random UUID"publicrequired
The unique identifier for the address.

​
Specific attributes

adresse_brute
varcharpublic
The raw address string.
address_clean
booleandefault:"false"publicrequired
Indicates whether the address has been cleaned or standardized.
building_name
varcharpublic
The name of the building, if applicable.
Rules: Max length: 150 characters
condominium_name
varcharpublic
The name of the condominium, if applicable.
Rules: Max length: 150 characters
google_place_code
varcharpublic
The Google Places API code for the address, if available.
Rules: Max length: 250 characters
latitude
decimalpublic
The latitude coordinate of the address.
Rules: Precision: 12, Scale: 8
longitude
decimalpublic
The longitude coordinate of the address.
Rules: Precision: 12, Scale: 8
mapbox_place_code
varcharpublic
The Mapbox Places API code for the address, if available.
Rules: Max length: 250 characters
postal_code
varcharpublic
The postal code of the address.
Rules: Max length: 10 characters
street_apartment
varcharpublic
The apartment number or identifier within the building.
Rules: Max length: 150 characters
street_complement
varcharpublic
Additional information to help locate the address.
Rules: Max length: 150 characters
street_name
varcharpublicrequired
The name of the street.
Rules: Max length: 250 characters
street_number
varcharpublicrequired
The number of the building on the street.
Rules: Max length: 10 characters
street_reference
varcharpublic
A reference point or landmark to help locate the address.
street_unit_number
varcharpublic
The unit number within the building, if applicable.
Rules: Max length: 10 characters

​
Foreign keys

city
uuidpublicrequired
The unique identifier of the associated city. Ref: City Schema
country
uuidpublicrequired
The unique identifier of the associated country. Ref: Country Schema
state
uuidpublicrequired
The unique identifier of the associated state. Ref: State Schema
type_address
uuidpublicrequired
The unique identifier of the associated address type. Ref: TypeAddress Schema

​
Tracking attributes

created_at
timestamppublic
The timestamp when the address was created.
Rules: Precision: 6, with timezone
deleted_at
timestamppublic
The timestamp when the address was deleted, if applicable.
Rules: Precision: 6, with timezone
is_actived
booleandefault:"true"public
Indicates whether the address is active.
is_deleted
booleandefault:"false"public
Indicates whether the address has been deleted.
updated_at
timestamppublic
The timestamp when the address was last updated.
Rules: Precision: 6, with timezone