Skip to main content

Address

Represents a physical address with fields for street, city, state, zip code, and country.

street object

The street address, including any necessary street number, street name, and additional details like apartment or suite numbers.

anyOf
string
city object

The city or locality of the address. This field specifies the urban area or town.

anyOf
string
state object

The state, province, or region of the address. This field identifies the larger administrative area or region.

anyOf
string
zip_code object

The postal code for the address, which is used for mail delivery purposes. It can be numerical or alphanumeric, depending on the country's postal system.

anyOf
string
country object

The country of the address, specified in uppercase letters as per the ISO 3166-1 alpha-2 or alpha-3 country codes or full country name.

anyOf
string
location object
anyOf
typeType (string)
Default value: Point
coordinatesarrayrequired

Possible values: >= 2, <= 2

formatFormat (string)

Possible values: [EPSG:2154, EPSG:4326]

Default value: EPSG:2154
Address
{
  "street": "string",
  "city": "string",
  "state": "string",
  "zip_code": "string",
  "country": "string",
  "location": {
    "type": "Point",
    "coordinates": [
      null
    ],
    "format": "EPSG:2154"
  }
}