Axiym

Start client onboarding

Creates and immediately submits a client onboarding case for compliance review. Document intake is handled through Axiym's compliance KYB flow. 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 for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.

Lengthlength <= 255

Request Body

application/json

Client onboarding request.

legalEntityName*string

Official name of the company.

incorporationDate*string

Date the legal entity was established.

Formatdate
registrationDate*string

Date the company 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

Your unique reference for the client within your partnership.

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