Client onboarding
Before you use Trade API for a client, that client must be onboarded with
Axiym and have an active clientId.
Choose an onboarding route
KYB onboarding can be completed in either of two ways:
- API onboarding — create a case with Start client onboarding, then either poll Get onboarding status or handle the
client.activatedwebhook event. - Manual onboarding — work with Axiym to complete the same KYB review outside your API integration.
Both routes result in an Axiym-issued clientId. Retrieve it later with
List clients or Get
client. Store it with your
own client reference and use it in every Trade API business-resource path:
/clients/{clientId}/...When you use the API route, send your stable partnerClientId with the legal
entity and registered-address data. Retain both identifiers: use
partnerClientId to correlate the client in your own system and clientId in
Trade API paths.
partnerClientId must be unique within your partnership. A new request with
an existing value returns 409 Conflict; retrieve the existing onboarding case
instead of creating another one.
Trade-only clients
Trade onboarding requires the same KYB review as PNSL onboarding. It does not require the financial due diligence and underwriting used when a client will receive payment funding through PNSL.
Wait for activation
Do not start deposits, conversions, or withdrawals until the client is active and its accounts and permitted conversion pairs are available. Then continue to Client context to discover the resources available for that client.
If you use webhooks, treat client.activated as a notification, not
as the complete client record. Fetch the onboarding case using its clientId.
Only continue when the final status is ACTIVE; REJECTED requires a new or
corrected onboarding process with Axiym.