Skip to main content
GET
Get address information by id

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

address_id
string<uuid>
required

ID of the address

Example:

"1a582c51-e4ff-4e57-9558-08cab6b963aa"

Response

Address information

creation_date
string<date-time>
required

Date and time when the address was created.

Example:

"2019-01-01T00:00:00Z"

is_active
boolean
required

Whether the address is active or not

Example:

true

last_updated_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

address_line_1
string
required

Street address line 1

Example:

"100 Main St."

country_code
string
required

ISO-3166-1 Alpha-2 country code

Pattern: ^[A-Z]{2}$
Example:

"US"

id
string<uuid>
required
read-only

The unique identifier for this resource.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

business_id
string<uuid>

The identifier for the business customer associated with address.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

customer_id
string<uuid>

The identifier for the personal customer associated with address.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

address_line_2
string

Street address line 2

Example:

"Suite 99"

address_type
enum<string>
read-only

Specifies the address type.

Available options:
BILLING,
LEGAL,
OPERATING,
OTHER,
SHIPPING
Example:

"SHIPPING"

city
string

City

Example:

"New York"

is_registered_agent
boolean

Indicates whether an address is a registered agent. Omitted if the address is not a registered agent.

Example:

true

nickname
string

A nickname for the address. This is used to identify the address in the UI.

Example:

"Home"

postal_code
string

Postal code. For US, formats of 12345 or 12345-1234 are accepted. For CA, formats of A1A 1A1 or A1A1A1 (regardless of case) are accepted, and will be converted to A1A 1A1 format.

Example:

"28620"

state
string

State, region, province, or prefecture. This is the ISO-3166-2 subdivision code, excluding the country prefix. For example, TX for Texas USA or TAM for Tamaulipas Mexico. Its length varies by country, e.g. 2 characters for US, 3 for MX.

Example:

"NY"