Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 2.27 KB

address.md

File metadata and controls

41 lines (32 loc) · 2.27 KB
Raw

Address

Represents a physical address.

Structure

Address

Fields

Name Type Tags Description
address_line_1 string Optional The first line of the address.

Fields that start with address_line provide the address's most specific
details, like street number, street name, and building name. They do not
provide less specific details like city, state/province, or country (these
details are provided in other fields).
address_line_2 string Optional The second line of the address, if any.
address_line_3 string Optional The third line of the address, if any.
locality string Optional The city or town of the address.
sublocality string Optional A civil region within the address's locality, if any.
sublocality_2 string Optional A civil region within the address's sublocality, if any.
sublocality_3 string Optional A civil region within the address's sublocality_2, if any.
administrative_district_level_1 string Optional A civil entity within the address's country. In the US, this
is the state.
administrative_district_level_2 string Optional A civil entity within the address's administrative_district_level_1.
In the US, this is the county.
administrative_district_level_3 string Optional A civil entity within the address's administrative_district_level_2,
if any.
postal_code string Optional The address's postal code.
country str (Country) Optional Indicates the country associated with another entity, such as a business.
Values are in ISO 3166-1-alpha-2 format.
first_name string Optional Optional first name when it's representing recipient.
last_name string Optional Optional last name when it's representing recipient.
organization string Optional Optional organization name when it's representing recipient.

Example (as JSON)

{
  "address_line_1": "address_line_10",
  "address_line_2": "address_line_20",
  "address_line_3": "address_line_36",
  "locality": "locality0",
  "sublocality": "sublocality0"
}