# Axiym Client Account API

Product: Client Account API
API reference version: 0.3.0 (current)
OpenAPI contract: https://docs.sandbox.axiym.io/openapi/client-account-api/0.3.0.yaml
Canonical page: https://docs.sandbox.axiym.io/client-account-api/api-reference/0.3.0

Use the Client Account API to manage Axiym accounts owned by clients onboarded through your partnership: view balances and statements, register external bank accounts and wallets, deposit funds, convert currencies, and make withdrawals. The access token identifies your partnership; `clientId` selects the client whose API resources you operate.

Subscribe to webhooks to receive notifications about client availability, account movements, and changes to deposits, conversions, withdrawals, and registered external accounts. Subscriptions belong to your partnership. Events about client resources include `clientId` to identify the relevant client.

## Downloads




OpenAPI contract

v0.3.0 · current

Explore the schema or generate a client for your integration.

[


Download OpenAPI](/openapi/client-account-api/0.3.0.yaml)




Postman collection

v0.3.0 · current

Import ready-to-use requests and connect to the sandbox.

[


Download collection](/postman/client-account-api/axiym_client_account_api_v0.3.0.json)

## Environments




Sandbox

[`https://partner-api.sandbox.axiym.io/api/v1`](https://partner-api.sandbox.axiym.io/api/v1)




Production

[`https://partner-api.axiym.io/api/v1`](https://partner-api.axiym.io/api/v1)

## Resources



[Auth](/client-account-api/api-reference/0.3.0/auth/oauth/token/post)

OAuth 2.0 client credentials authentication for the partnership.







[Onboarding](/client-account-api/api-reference/0.3.0/onboarding/startOnboarding)

Client KYB onboarding applications and their review status.







[Clients](/client-account-api/api-reference/0.3.0/clients/listClients)

Client records associated with your partnership. The list includes clients that are onboarding, active, or disabled; only active clients can use Client Account API operations.







[Accounts](/client-account-api/api-reference/0.3.0/accounts/listAccounts)

Axiym accounts and balances owned by the represented client.







[Address Book](/client-account-api/api-reference/0.3.0/address-book/listAddressBookEntries)

External bank accounts and wallets registered in the selected client's address book for whitelisting as deposit sources and withdrawal destinations.







[Deposits](/client-account-api/api-reference/0.3.0/deposits/getDepositInstructions)

Incoming funds credited to the represented client’s Axiym accounts.







[Conversions](/client-account-api/api-reference/0.3.0/conversions/listConversionPairs)

Currency conversions between the represented client’s permitted Axiym accounts.







[Withdrawals](/client-account-api/api-reference/0.3.0/withdrawals/listWithdrawals)

Outgoing funds from the represented client’s Axiym accounts.







[Webhook Subscriptions](/client-account-api/api-reference/0.3.0/webhook-subscriptions/webhooks/subscriptions/get)

Partnership-owned webhook subscriptions and signing keys.