Skip to main content
GET
Get an account by Accoumt Number

Authorizations

Authorization
string
header
required

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

Headers

trace-id
string

Path Parameters

accountNumber
string
required

Response

Found the Account

id
string
createdAt
string<date-time>
updatedAt
string<date-time>
createdBy
string
updatedBy
string
name
string

Name for this customer account

Required string length: 1 - 128
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
addressLine1
string

Primary address line

Required string length: 6 - 256
addressLine2
string

Secondary address line

country
string | null

Country code (2-digit)

state
string | null

State, county, province, or region.

city
string | null

City name

postalCode
string | null

Postal or ZIP code

email
string | null

Email address

Required string length: 3 - 128
status
enum<string>
Available options:
active,
in-active,
draft
source
string | null

Source of the account