Client context

Your partner access token identifies your partnership. For business-resource requests, clientId in the path selects the onboarded client whose Axiym accounts and API resources you operate.

Read Clients and onboarding before implementing this guide.

1. Store the client identifier

Store the Axiym-issued clientId provided through your onboarding process. Use List clients to reconcile your client records with Axiym, or Get client to check one client's current status. Attach the identifier to each account, conversion pair, address book entry, deposit, conversion, withdrawal, event, and reconciliation record.

2. Discover resources for that client

List the client's address book entries, Axiym accounts, and conversion pairs. These responses define the resources and capabilities available in that client context.

Do not copy permissions or identifiers from another client.

3. Keep resources in the same client context

• Deposit from an ACTIVE, whitelisted external account in that client’s address book.
• Use deposit instructions from that client's receiving Axiym account.
• Convert using a pairId returned for that client.
• Withdraw from that client’s Axiym account to an ACTIVE, whitelisted external account identified by destinationId in the client’s address book.

4. Retry in the same context

Keep the clientId, endpoint, request body, and Idempotency-Key unchanged when retrying a state-changing request.

5. Reconcile by client

Retrieve statements and related resources through the same client's paths. Route partnership webhook events using their clientId, then fetch the authoritative resource from the endpoint under /clients/{clientId}.