Clients and onboarding
The Client Account API lets your organization manage Axiym accounts owned by clients who have completed Axiym onboarding. Each client has separate accounts, balances, and activity.
How onboarding works
Each client completes Axiym’s Know Your Business (KYB) review before using its accounts. You can submit the onboarding information through the API or work with Axiym to complete onboarding manually.
Once onboarding is complete, you can access the client's Axiym accounts and
activity using its unique clientId. The client must be ACTIVE to use
Client Account API operations. A client undergoing onboarding or with status
DISABLED cannot perform these operations.
Roles and responsibilities
- Your organization integrates with Axiym and retains its relationship with the client.
- The client completes Axiym onboarding and owns its Axiym accounts and activity.
- Axiym reviews the client and determines the capabilities available to it.
Your organization manages the API connection and webhook subscriptions. The accounts and financial activity belong to the individual clients.
One client, one account context
Each client has its own Axiym accounts, address book, conversion pairs, deposits, conversions, withdrawals, and statements. An operation stays within one client’s context; resources from different clients cannot be combined.
External bank accounts and wallets must be whitelisted and ACTIVE in the
selected client’s address book before they can fund deposits or receive
withdrawals. The external account does not have to be owned by the client.
Capabilities are specific to each client
An active client does not automatically have access to every currency or operation:
- its Axiym accounts determine which currencies and payment rails it can use;
- its whitelisted external accounts determine where deposits may originate and withdrawals may be sent; and
- its conversion pairs determine the permitted currency conversions.
For onboarding requests, client identifiers, and selecting the client for an operation, see the Client onboarding and Client context integration guides.