Create a address

Create a address.

Log in to see full request history
Body Params

Address to create

string
required

Specifies the address type.

string

The identifier for the business customer associated with address.

string

The identifier for the personal customer associated with address.

string
required

Street address line 1

string

Street address line 2

string
required

City

string
required

ISO-3166-1 Alpha-2 country code

boolean

Whether the address is active or not

boolean

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

string

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

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.

string
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.

Responses

Language
Credentials
api_key
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json