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

Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the X-Request-Id response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.

Formatuuid
Idempotency-Key?string

Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.

Lengthlength <= 255

Request Body

application/json

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 fiat (e.g. USD, EUR) or a supported stablecoin (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.

paymentRails?string

Payment rail code.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json