English
Search…
⌃K
Links

Address

Overview

Some resources have associated location data: Order payments have an associated billing address or a user may have an address associated with it. Legiti standardizes the format in which we collect this data as follows:
{
"street_name": "Rua Fidalga",
"street_number": "252",
"zip_code": "05432-010",
"city": "São Paulo",
"state": "SP",
"country": "BR",
"details": "Apto 11",
"label": "Casa",
"latitude": -43.2360,
"longitude": -23.5115
}
Property
Type
Description
street_name
String
The street of the address
street_number
String
The street number of the address
zip_code
String
The zip code (e.g. CEP) of the address
city
String
The city in which the address is located
state
String
The up to three-character ISO 3166-2 abbreviation of the state in which the address is located
country
String
The two-character ISO 3166-2 country code in which the address is located
details
String
Extra details (such as delivery instructions) provided by the user about the address ("complemento" in Portuguese)
label
String
A name chosen by the user for this address (e.g work/home)
latitude
Float
The exact latitude of the address
longitude
Float
The exact longitude of the address
custom_data
JSON for saving customizable data for each client
In all endpoints where an Address entity is provided, all of the above fields are required except for latitude, longitude, zip_code, label, and details.