Axiym

Start client onboarding

Creates and immediately submits a client onboarding case for compliance review. Document intake is owned by Axiym's compliance KYB flow. The client is visible in GET /clients after approval; track the case with GET /onboardings/{clientId}.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid
Idempotency-Key*string

A unique key that makes a funds-moving request safe to retry. Reusing the key returns the original result instead of creating a duplicate. A UUID is recommended.

Lengthlength <= 255

Request Body

application/json

Client onboarding request.

legalEntityName*string

Official name of the company

incorporationDate*string

Date legal entity was established

Formatdate
registrationDate*string

Date when the company registered / joined your network

Formatdate
legalAddress*Address

Legal Address

currency*Currency

Currency code — ISO 4217 (e.g. USD, EUR) or a supported digital currency (USDT, USDC).

partnerClientId?string

Unique identifier from the partner side to maintain data mapping and ensure onboarding uniqueness.

disbursementAccount?DisbursementAccount

Payment Network bank account that receives funding disbursements for this client (the funding destination).

paymentRails?string

Payment Rail Code

Response Body

application/json

application/json

application/json

application/json

application/json

application/json