Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Addresses

Create a address

Create a address.

post/addresses

Request body

address_type'BILLING' | 'LEGAL' | 'OPERATING' | 'OTHER' | 'SHIPPING' required

Specifies the address type.

business_idstring uuid

The identifier for the business customer associated with address.

customer_idstring uuid

The identifier for the personal customer associated with address.

address_line_1string required

Street address line 1

address_line_2string

Street address line 2

citystring required

City

country_codestring required

ISO-3166-1 Alpha-2 country code

is_activeboolean

Whether the address is active or not

is_registered_agentboolean

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

nicknamestring

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

postal_codestring

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.

statestring required

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 request

{
  "address_type": "SHIPPING",
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "address_line_1": "100 Main St.",
  "address_line_2": "Suite 99",
  "city": "New York",
  "country_code": "US",
  "is_active": true,
  "is_registered_agent": true,
  "nickname": "Home",
  "postal_code": "28620",
  "state": "NY"
}

Response

Created address

business_idstring uuid

The identifier for the business customer associated with address.

creation_datestring date-time required

Date and time when the address was created.

customer_idstring uuid

The identifier for the personal customer associated with address.

is_activeboolean required

Whether the address is active or not

last_updated_timestring date-time required
address_line_1string required

Street address line 1

address_line_2string

Street address line 2

address_type'BILLING' | 'LEGAL' | 'OPERATING' | 'OTHER' | 'SHIPPING'

Specifies the address type.

citystring

City

country_codestring required

ISO-3166-1 Alpha-2 country code

idstring uuid required

The unique identifier for this resource.

is_registered_agentboolean

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

nicknamestring

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

postal_codestring

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.

statestring

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 response

{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "creation_date": "2019-01-01T00:00:00Z",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "is_active": true,
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "address_line_1": "100 Main St.",
  "address_line_2": "Suite 99",
  "address_type": "SHIPPING",
  "city": "New York",
  "country_code": "US",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "is_registered_agent": true,
  "nickname": "Home",
  "postal_code": "28620",
  "state": "NY"
}