Skip to main content
POST
CLI

Authorizations

​
Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

​
X-API-Key
string

API key

​
Idempotency-Key
string

Idempotency key for preventing duplicate requests

Body

application/json
​
customerName
string
required

Customer name

​
email
string<email>

Business email address. Use an email on the company domain when available; personal email domains such as Gmail may require additional due diligence.

Maximum string length: 255
Example:

"contact@acme.com"

​
countryCode
enum<string>

Country code (ISO 3166-2)

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AR,
AS,
AT,
AU,
AW,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BR,
BS,
BT,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
EU,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SY,
SZ,
TC,
TD,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
​
requestedCapabilities
enum<string>[]

Capabilities requested by the customer

Available options:
USD_ACH_PAYIN,
USD_ACH_PAYOUT,
USD_WIRE_PAYIN,
USD_WIRE_PAYOUT,
USD_BALANCE,
USD_YIELD,
SWIFT_PAYIN,
SWIFT_PAYOUT,
STABLECOIN_PAYIN,
STABLECOIN_PAYOUT,
STABLECOIN_SWAPS,
AED_FX_PAYOUT,
AUD_FX_PAYOUT,
BHD_FX_PAYOUT,
BOB_FX_PAYOUT,
BRL_FX_PAYOUT,
CLP_FX_PAYOUT,
CNY_FX_PAYOUT,
COP_FX_PAYOUT,
DOP_FX_PAYOUT,
EGP_FX_PAYOUT,
EUR_FX_PAYOUT,
GBP_FX_PAYOUT,
HKD_FX_PAYOUT,
IDR_FX_PAYOUT,
INR_FX_PAYOUT,
JPY_FX_PAYOUT,
KRW_FX_PAYOUT,
KWD_FX_PAYOUT,
MXN_FX_PAYOUT,
MYR_FX_PAYOUT,
PEN_FX_PAYOUT,
PHP_FX_PAYOUT,
PYG_FX_PAYOUT,
QAR_FX_PAYOUT,
SAR_FX_PAYOUT,
SGD_FX_PAYOUT,
THB_FX_PAYOUT,
TRY_FX_PAYOUT,
TWD_FX_PAYOUT,
USD_FX_PAYOUT,
VND_FX_PAYOUT
​
businessName
string

Legal business name

Maximum string length: 1024
Example:

"Acme Corporation"

​
businessType
enum<string>

Business legal structure

Available options:
CORPORATION,
LLC,
PARTNERSHIP,
GEN_PARTNERSHIP,
LLP,
LP,
SOLE_PROPRIETORSHIP,
NON_PROFIT,
TRUST,
COOPERATIVE,
PRIVATE_LIMITED_COMPANY,
SPV,
JOINT_VENTURE
Example:

"LLC"

​
taxIdentificationNumber
string

Tax identification number issued by the tax authority (e.g., EIN in the US, VAT number in EU). This is different from the business registration number.

Validated against country-specific formats when countryCode is provided. Accepts NOT_APPLICABLE when no tax ID is available. If the value does not match the expected format, prefix with OVERRIDE: (e.g. OVERRIDE:12-3456789) to store it as-is. These should be used sparingly; missing or overridden tax IDs may trigger additional customer due diligence.

Maximum string length: 50
Example:

"12-3456789"

​
website
string

Business website URL

Maximum string length: 512
Example:

"https://acme.com"

​
industry
string

6-digit NAICS industry classification code

Required string length: 6
Pattern: ^\d{6}$
Example:

"522320"

​
isCrypto
boolean

Set true if the business operates in crypto or digital assets.

Example:

false

​
isRemoteCompany
boolean

Set true when the business operates remotely from an owner or director address.

Example:

false

​
industryCryptoSubtype
enum<string>

Crypto-specific industry subtype. Required when isCrypto is true.

Available options:
PROTOCOL,
EXCHANGE,
INVESTMENT,
LENDER,
MARKET_MAKER,
SAAS,
MINER
​
yearEstablished
number

Year the business was established

Required range: x >= 1800
Example:

2010

​
numberOfEmployees
number

Number of employees

Required range: x >= 0
Example:

50

​
tradeName
string

Business trade name (DBA). Separate multiple names with semicolons.

Maximum string length: 1024
Example:

"Acme Services; Acme Pay"

​
description
string

Business description

Maximum string length: 2048
Example:

"Cloud software services provider"

​
phone
string

Business phone number in E.164 format

Maximum string length: 16
Example:

"+14155551234"

​
registrationDate
string

Business registration date in ISO 8601 format (YYYY-MM-DD)

Example:

"2020-01-15"

​
registrationNumber
string

Business registration number issued by the state/authority when the business was registered (e.g., LLC filing number, corporation charter number). This is different from the tax identification number.

Maximum string length: 50
Example:

"123456789"

​
hasMaterialIntermediaryOwnership
boolean

Whether the business has material intermediary ownership (25%+ owned by another entity)

Example:

false

​
accountPurpose
enum<string>

Purpose of the account

Available options:
PAYROLL,
VENDOR_PAYMENTS,
TREASURY,
OPERATIONS,
CAPITAL_DEPLOYMENT,
CROSS_BORDER_PAYMENTS,
STABLECOIN_CONVERSION,
ECOMMERCE,
OTHER
Example:

"OPERATIONS"

​
accountPurposeExplanation
string

Detailed explanation of account purpose

Maximum string length: 2048
Example:

"Operating expenses and customer settlements"

​
sourceOfFunds
enum<string>

Source of funds for the business

Available options:
BUSINESS_REVENUE,
INVESTMENT,
OWNER_CAPITAL,
LOAN,
GRANTS,
EQUITY,
INHERITANCE,
GIFT,
OTHER
Example:

"BUSINESS_REVENUE"

​
sourceOfFundsDescription
string

Detailed description of source of funds

Maximum string length: 2048
Example:

"Revenue from software services"

​
estimatedAnnualRevenueUsd
enum<string>

Estimated annual revenue in USD

Available options:
PRE_REVENUE,
LESS_THAN_10K,
10K_TO_50K,
50K_TO_100K,
100K_TO_500K,
500K_TO_1M,
1M_TO_5M,
5M_TO_10M,
10M_TO_50M,
50M_TO_250M,
MORE_THAN_250M,
LESS_THAN_100K
​
expectedMonthlyPaymentsUsd
number

Expected monthly fiat payment volume in USD-equivalent

Required range: x >= 0
Example:

50000

​
primaryTargetMarket
enum<string>

Primary target market. RETAIL = B2C (consumers), COMMERCIAL = B2B (businesses), GOVERNMENT = B2G (government entities), OTHER = another market not covered by the standard options.

Available options:
RETAIL,
COMMERCIAL,
GOVERNMENT,
OTHER
Example:

"COMMERCIAL"

​
primaryTargetMarketExplanation
string

Primary target market explanation (required if primaryTargetMarket is OTHER)

Maximum string length: 2048
Example:

"Marketplace serving mixed B2B and B2C sellers"

​
operatesInProhibitedCountries
boolean

Whether the business operates in prohibited countries

Example:

false

​
highRiskActivities
enum<string>[]

List of high-risk activities the business engages in

Available options:
MONEY_SERVICES,
LENDING_BANKING,
OTC_FX_CRYPTO_BROKERAGE,
HOLD_CLIENT_FUNDS,
INVESTMENT_SERVICES,
SAFE_DEPOSIT_BOX,
PRECIOUS_METALS_STONES_JEWELRY,
NICOTINE_TOBACCO,
MARIJUANA,
PHARMACEUTICALS,
THIRD_PARTY_PAYMENT_PROCESSING,
ADULT_ENTERTAINMENT,
WEAPONS_FIREARMS_EXPLOSIVES,
GAMBLING
Example:
​
highRiskActivitiesExplanation
string

Explanation of high-risk activities

Maximum string length: 2048
Example:

"Cryptocurrency exchange services"

​
signedAgreementId
string

Signed agreement ID

Maximum string length: 256
Example:

"tos_abc123"

Response

Customer created successfully

​
id
string
required

Customer ID

​
customerName
string
required

Customer name

​
organizationId
string
required

Organization ID

​
type
enum<string>
required

Customer type

Available options:
INDIVIDUAL,
BUSINESS
​
status
enum<string>
required

Customer status

Available options:
DRAFT,
IN_REVIEW,
NEED_ACTIONS,
REJECTED,
ACTIVE,
INACTIVE,
SUSPENDED
​
createdAt
string<date-time>
required

Customer creation date

Example:

"2026-01-15T10:00:00Z"

​
updatedAt
string<date-time>
required

Customer last update date

Example:

"2026-01-15T10:00:00Z"

​
email
string

Customer email address

​
countryCode
enum<string>

Country code (ISO 3166-2)

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AR,
AS,
AT,
AU,
AW,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BR,
BS,
BT,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
EU,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SY,
SZ,
TC,
TD,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
​
imageUrl
string

Customer image URL

​
requestedCapabilities
enum<string>[] | null

Capabilities requested by the customer

Available options:
USD_ACH_PAYIN,
USD_ACH_PAYOUT,
USD_WIRE_PAYIN,
USD_WIRE_PAYOUT,
USD_BALANCE,
USD_YIELD,
SWIFT_PAYIN,
SWIFT_PAYOUT,
STABLECOIN_PAYIN,
STABLECOIN_PAYOUT,
STABLECOIN_SWAPS,
AED_FX_PAYOUT,
AUD_FX_PAYOUT,
BHD_FX_PAYOUT,
BOB_FX_PAYOUT,
BRL_FX_PAYOUT,
CLP_FX_PAYOUT,
CNY_FX_PAYOUT,
COP_FX_PAYOUT,
DOP_FX_PAYOUT,
EGP_FX_PAYOUT,
EUR_FX_PAYOUT,
GBP_FX_PAYOUT,
HKD_FX_PAYOUT,
IDR_FX_PAYOUT,
INR_FX_PAYOUT,
JPY_FX_PAYOUT,
KRW_FX_PAYOUT,
KWD_FX_PAYOUT,
MXN_FX_PAYOUT,
MYR_FX_PAYOUT,
PEN_FX_PAYOUT,
PHP_FX_PAYOUT,
PYG_FX_PAYOUT,
QAR_FX_PAYOUT,
SAR_FX_PAYOUT,
SGD_FX_PAYOUT,
THB_FX_PAYOUT,
TRY_FX_PAYOUT,
TWD_FX_PAYOUT,
USD_FX_PAYOUT,
VND_FX_PAYOUT
​
capabilities
object[]

Computed capability statuses. Included on list responses. READY only when the customer is ACTIVE.

​
customerDetails
object

Customer details with transliteration support.

For INDIVIDUAL customers:

  • firstName, lastName, middleName
  • transliteratedFirstName, transliteratedMiddleName, transliteratedLastName
  • dateOfBirth, phone, occupation, sourceOfIncome

For BUSINESS customers:

  • businessName, tradeName, businessType, taxIdentificationNumber
  • website, industry, email, phone

Verification and EDD-specific fields are submitted separately through the verification endpoints.

​
associatedEntities
object[]

Associated entities (beneficial owners and control persons) for business customers.

​
addresses
object[]

Customer addresses.

Each address must include addressLine1, city, postalCode, and country.

​
missingRequirements
object[]

Merged list of missing fields and documents required for full verification. Only populated when customer data is incomplete.

Example:
​
accounts
array[]

Customer accounts (only included when expand=accounts). Returns all accounts for this customer.

​
documents
object[]

Customer documents (only included when expand=documents). Returns all documents for this customer.

​
treasury
object

Treasury balances (only included when expand=treasury). Returns treasury wallet balances grouped by treasury.

​
verificationSessions
object[]

Verification sessions (only included when expand=verificationSessions). Returns verification session summaries.