Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB
Addresses

Creates an address

Creates an address.

post/addresses

Request body

customer_referencestring

A customer reference string for customer look ups.

first_namestring required

The first name associated with the address. An address must have either a first last name or a business name.

last_namestring required

The last name associated with the address. An address must have either a first last name or a business name.

business_namestring required

The business name associated with the address. An address must have either a first last name or a business name.

phone_numberstring

The phone number associated with the address.

street_addressstring required

The primary street address information about the address.

extended_addressstring

Additional street address information about the address such as, but not limited to, unit number or apartment number.

localitystring required

The locality of the address. For US addresses, this corresponds to the city of the address.

administrative_areastring

The locality of the address. For US addresses, this corresponds to the state of the address.

neighborhoodstring

The neighborhood of the address. This field is not used for addresses in the US but is used for some international addresses.

boroughstring

The borough of the address. This field is not used for addresses in the US but is used for some international addresses.

postal_codestring

The postal code of the address.

country_codestring required

The two-character (ISO 3166-1 alpha-2) country code of the address.

address_bookboolean

Indicates whether or not the address should be considered part of your list of addresses that appear for regular use.

validate_addressboolean

Indicates whether or not the address should be validated for emergency use upon creation or not. This should be left with the default value of true unless you have used the /addresses/actions/validate endpoint to validate the address separately prior to creation. If an address is not validated for emergency use upon creation and it is not valid, it will not be able to be used for emergency services.

Example request

{
  "customer_reference": "MY REF 001",
  "first_name": "Alfred",
  "last_name": "Foster",
  "business_name": "Toy-O'Kon",
  "phone_number": "+12125559000",
  "street_address": "600 Congress Avenue",
  "extended_address": "14th Floor",
  "locality": "Austin",
  "administrative_area": "TX",
  "neighborhood": "Ciudad de los deportes",
  "borough": "Guadalajara",
  "postal_code": "78701",
  "country_code": "US",
  "validate_address": true
}

Response

Successful response

Example response

{
  "data": {
    "id": "1293384261075731499",
    "record_type": "address",
    "customer_reference": "MY REF 001",
    "first_name": "Alfred",
    "last_name": "Foster",
    "business_name": "Toy-O'Kon",
    "phone_number": "+12125559000",
    "street_address": "600 Congress Avenue",
    "extended_address": "14th Floor",
    "locality": "Austin",
    "administrative_area": "TX",
    "neighborhood": "Ciudad de los deportes",
    "borough": "Guadalajara",
    "postal_code": "78701",
    "country_code": "US",
    "validate_address": true,
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}