Skip to main content
POST
/
api
/
accounts
Create a new account
curl --request POST \
  --url https://api.example.com/api/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Abbie",
  "accountNumber": "ACC-0000000001",
  "addressLine1": "street or PO Box",
  "addressLine2": "Apt, suite, unit, building, floor etc.",
  "country": "US",
  "state": "CA",
  "city": "Los Angeles",
  "postalCode": "84001",
  "email": "Abbie@gmail.com",
  "type": "silver",
  "source": "aws"
}
'
{
  "name": "Abbie",
  "number": "ACC-0000000041",
  "addressLine1": "street or PO Box",
  "addressLine2": "Apt, suite, unit, building, floor etc.",
  "country": "US",
  "state": "CA",
  "city": "Los Angeles",
  "postalCode": "84001",
  "email": "Abbie@gmail.com",
  "status": "active",
  "source": "aws",
  "taxExempt": false,
  "id": "e3ef9de3-bbdc-495c-b608-a6fa1f62ada0",
  "createdOn": "2026-03-02T03:39:30.676048Z",
  "updatedOn": "2026-03-02T03:39:30.676051Z",
  "createdBy": "f17bb9d8-ff51-423c-b6d3-bc474b755510",
  "updatedBy": "f17bb9d8-ff51-423c-b6d3-bc474b755510"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
trace-id
string

Body

application/json
​
name
string
required

Name for this customer account

Required string length: 1 - 128
Example:

"Abbie"

​
number
string

Number for this account. You can specify your own customer identifier. If you don't specify the system will generate one

Required string length: 1 - 128
Example:

"ACC-0000000001"

​
addressLine1
string

Primary address line

Required string length: 6 - 256
Example:

"street or PO Box"

​
addressLine2
string

Secondary address line

Example:

"Apt, suite, unit, building, floor etc."

​
country
string

Country code

Example:

"US"

​
state
string

State or province

Example:

"CA"

​
city
string

City name

Example:

"Los Angeles"

​
postalCode
string

Postal or ZIP code

Example:

"84001"

​
email
string

Email address

Required string length: 3 - 128
Example:

"abbie@gmail.com"

​
source
string

Source of the account

​
taxExempt
boolean

Tax exempt used for tax engine integration

Response

OK

​
id
string
​
createdOn
string<date-time>
​
updatedOn
string<date-time>
​
createdBy
string
​
updatedBy
string
​
name
string

name

​
number
string
​
addressLine1
string
​
addressLine2
string
​
country
string | null
​
state
string | null
​
city
string | null
​
postalCode
string | null
​
email
string | null
​
status
enum<string>
Available options:
active,
in-active,
draft
​
source
string | null