# Schemas

Data models used by the 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/schemas

[Complete reference with related definitions](/client-account-api/api-reference/0.3.0/schemas.full.md)

Fetch individual schemas as needed. Each export preserves the original schema and links to related types.

- [OnboardingRequest](/client-account-api/api-reference/0.3.0/schemas/OnboardingRequest.md): Client onboarding request.
- [OnboardingCase](/client-account-api/api-reference/0.3.0/schemas/OnboardingCase.md): Snapshot of a client onboarding application. Created in the submitted state and reviewed by Axiym compliance; while the review is in progress the status stays ONBOARDING. An approved application ends in APPROVED; a rejected application ends in REJECTED.
- [Client](/client-account-api/api-reference/0.3.0/schemas/Client.md)
- [Address](/client-account-api/api-reference/0.3.0/schemas/Address.md): Registered legal address of a business.
- [DisbursementAccount](/client-account-api/api-reference/0.3.0/schemas/DisbursementAccount.md): Bank account at the Payment Network that receives funding disbursements.
- [Currency](/client-account-api/api-reference/0.3.0/schemas/Currency.md): Currency code — ISO 4217 (e.g. USD, EUR) or a supported digital currency (USDT, USDC).
- [AccountStatus](/client-account-api/api-reference/0.3.0/schemas/AccountStatus.md): `ACTIVE` is available for supported operations. `SUSPENDED` is temporarily unavailable for supported operations. `CLOSED` is permanently closed.
- [Account](/client-account-api/api-reference/0.3.0/schemas/Account.md): An account holding a currency balance. Receiving details for funding it are served by the deposit instructions.
- [AccountRef](/client-account-api/api-reference/0.3.0/schemas/AccountRef.md): Compact account reference. Fetch the account via `GET /clients/{clientId}/accounts/{accountId}` for the current balance and status; deposit instructions serve its payment details.
- [PaymentRailsCode](/client-account-api/api-reference/0.3.0/schemas/PaymentRailsCode.md): Payment rail code the account settles on (e.g. `ZENUS_BANK`, `TRON`).
- [StatementEntryType](/client-account-api/api-reference/0.3.0/schemas/StatementEntryType.md): Direction of movement on the account.
- [StatementEntry](/client-account-api/api-reference/0.3.0/schemas/StatementEntry.md): A posted ledger movement on an account. Entries are returned in posting order and carry the running balance, so consecutive entries reconcile against each other.
- [ConversionStatus](/client-account-api/api-reference/0.3.0/schemas/ConversionStatus.md): `PENDING` awaits confirmation and appears only in the create response. `ACTIVE` is executing. `COMPLETED` means the funds were exchanged. `CANCELED` means the conversion stopped; see `reasonCode`.
- [ConversionPair](/client-account-api/api-reference/0.3.0/schemas/ConversionPair.md): An allowed exchange direction. You sell the `sell` side and buy the `buy` side. Use its stable `pairId` to create a conversion; Axiym selects the corresponding accounts.
- [ConversionPairSide](/client-account-api/api-reference/0.3.0/schemas/ConversionPairSide.md): One side of a conversion pair.
- [ConversionRequest](/client-account-api/api-reference/0.3.0/schemas/ConversionRequest.md): A conversion along one of your conversion pairs. `pairId` selects the accounts on both sides; `sellAmount` is in the pair's sell currency.
- [Conversion](/client-account-api/api-reference/0.3.0/schemas/Conversion.md)
- [ConversionEventData](/client-account-api/api-reference/0.3.0/schemas/ConversionEventData.md): A compact notification for routing and correlation. Retrieve the conversion from `GET /clients/{clientId}/conversions/{conversionId}` when you need its amounts, rate, or current state.
- [DepositStatus](/client-account-api/api-reference/0.3.0/schemas/DepositStatus.md): `PENDING` awaits crediting. `HELD` is temporarily on hold. `COMPLETED` was credited to the account. `CANCELED` or `REJECTED` was not completed; see `reasonCode`.
- [Deposit](/client-account-api/api-reference/0.3.0/schemas/Deposit.md)
- [DepositInstruction](/client-account-api/api-reference/0.3.0/schemas/DepositInstruction.md): Axiym's receiving details for one transfer scheme; the shape matches the scheme.
- [BankDepositInstruction](/client-account-api/api-reference/0.3.0/schemas/BankDepositInstruction.md): Axiym's receiving bank details for one transfer scheme. Exactly one of `iban` and `accountNumber` is present. Bank fields are present when the scheme uses them.
- [DepositIntermediaryBank](/client-account-api/api-reference/0.3.0/schemas/DepositIntermediaryBank.md): Bank the transfer passes through before the receiving bank. Present when the scheme uses one; put it on the transfer as the intermediary bank.
- [TransferScheme](/client-account-api/api-reference/0.3.0/schemas/TransferScheme.md): Transfer scheme the instruction applies to. `BOOK` is a transfer between accounts held at the same provider; `BLOCKCHAIN` is a wallet transfer.
- [WalletDepositInstruction](/client-account-api/api-reference/0.3.0/schemas/WalletDepositInstruction.md)
- [DepositEventData](/client-account-api/api-reference/0.3.0/schemas/DepositEventData.md): A compact notification for routing and correlation. Retrieve the deposit from `GET /clients/{clientId}/deposits/{depositId}` when you need its amount, transaction hash, or current state.
- [Bank](/client-account-api/api-reference/0.3.0/schemas/Bank.md): Destination bank details. Present on bank destinations only. The address country selects the applicable corridor rules.
- [Iban](/client-account-api/api-reference/0.3.0/schemas/Iban.md): International Bank Account Number in electronic format — no spaces, upper case. Its check digits are verified; country-specific lengths are left to the receiving bank.
- [BankAddress](/client-account-api/api-reference/0.3.0/schemas/BankAddress.md): Postal address of the bank. Only the country is required — it selects the corridor rules. Supply the rest when the corridor or a correspondent asks for it.
- [CountryCode](/client-account-api/api-reference/0.3.0/schemas/CountryCode.md): ISO 3166-1 alpha-2 country code.
- [DestinationStatus](/client-account-api/api-reference/0.3.0/schemas/DestinationStatus.md): `PENDING_REVIEW` awaits due diligence and compliance checks. `ACTIVE` is whitelisted for deposits and withdrawals. `SUSPENDED` is temporarily unavailable. `CLOSED` is permanently retired.
- [AddressBookEntry](/client-account-api/api-reference/0.3.0/schemas/AddressBookEntry.md): A registered external bank account or wallet in the selected client's address book. Its status indicates whether it is whitelisted for deposits and withdrawals.
- [BankAddressBookEntry](/client-account-api/api-reference/0.3.0/schemas/BankAddressBookEntry.md): A registered external bank account. Exactly one of `iban` and `accountNumber` is present.
- [WalletAddressBookEntry](/client-account-api/api-reference/0.3.0/schemas/WalletAddressBookEntry.md)
- [Destination](/client-account-api/api-reference/0.3.0/schemas/Destination.md): Where the funds are delivered, as recorded on the operation at creation time. This is a snapshot: it carries the account or wallet details and, when the destination was taken from the address book, its `destinationId`. It does not carry the address book entry's status or creation date; read the address book entry for its current state.
- [BankDestination](/client-account-api/api-reference/0.3.0/schemas/BankDestination.md): The bank account the funds are delivered to. Exactly one of `iban` and `accountNumber` is present.
- [WalletDestination](/client-account-api/api-reference/0.3.0/schemas/WalletDestination.md)
- [BankDestinationRequest](/client-account-api/api-reference/0.3.0/schemas/BankDestinationRequest.md): Registers an external bank account for whitelisting in the selected client's address book. The entry starts in `PENDING_REVIEW` while Axiym performs due diligence and compliance checks. It can fund deposits and receive withdrawals once `ACTIVE`. Supply exactly one of `iban` and `accountNumber`.
- [WalletDestinationRequest](/client-account-api/api-reference/0.3.0/schemas/WalletDestinationRequest.md): Registers an external wallet for whitelisting in the selected client's address book. The entry starts in `PENDING_REVIEW` while Axiym performs due diligence and compliance checks. It can fund deposits and receive withdrawals once `ACTIVE`.
- [PageInfo](/client-account-api/api-reference/0.3.0/schemas/PageInfo.md)
- [WithdrawalStatus](/client-account-api/api-reference/0.3.0/schemas/WithdrawalStatus.md): `PENDING_CONFIRMATION` is awaiting explicit confirmation and has not started execution. `PENDING` is queued for execution. `HELD` is temporarily on hold. `COMPLETED` means the withdrawal finished successfully. `CANCELED` and `REJECTED` did not complete (see `reasonCode`).
- [Withdrawal](/client-account-api/api-reference/0.3.0/schemas/Withdrawal.md)
- [WithdrawalRequest](/client-account-api/api-reference/0.3.0/schemas/WithdrawalRequest.md): A withdrawal from the selected client's Axiym account to a whitelisted external account identified by `destinationId` in that client's address book. Both accounts must be `ACTIVE` and use the same currency. Creating the withdrawal returns `PENDING_CONFIRMATION`; call `POST /clients/{clientId}/withdrawals/{withdrawalId}/confirm` to begin execution.
- [SupportingDocumentType](/client-account-api/api-reference/0.3.0/schemas/SupportingDocumentType.md): Axiym classification of evidence supplied with a withdrawal.
- [SupportingDocumentInput](/client-account-api/api-reference/0.3.0/schemas/SupportingDocumentInput.md): A document supporting the payment, such as an invoice or contract. One item is one file of up to 10 MB in PDF, JPEG or PNG format; supply the file content as base64.
- [SupportingDocument](/client-account-api/api-reference/0.3.0/schemas/SupportingDocument.md): Metadata of a document accepted with the payment. File content is not returned.
- [ClientEventData](/client-account-api/api-reference/0.3.0/schemas/ClientEventData.md): Client record snapshot at the time of the event. Fetch `GET /clients/{clientId}` when current profile details are required.
- [ClientStatusEventData](/client-account-api/api-reference/0.3.0/schemas/ClientStatusEventData.md): Compact client availability change. Fetch `GET /clients/{clientId}` when current profile details are required.
- [ClientOnboardingEventData](/client-account-api/api-reference/0.3.0/schemas/ClientOnboardingEventData.md): Compact outcome of a client onboarding review. Fetch `GET /onboardings/{clientId}` for the authoritative case, including any available rejection reason.
- [WithdrawalEventStatus](/client-account-api/api-reference/0.3.0/schemas/WithdrawalEventStatus.md): Statuses that appear in withdrawal events. `PENDING_CONFIRMATION` never does: events start with `withdrawal.created` once the withdrawal is confirmed.
- [WithdrawalEventData](/client-account-api/api-reference/0.3.0/schemas/WithdrawalEventData.md): A compact notification for routing and correlation. Retrieve the withdrawal from `GET /clients/{clientId}/withdrawals/{withdrawalId}` when you need its amount, fees, transaction hash, or current state.
- [AccountMovementEventData](/client-account-api/api-reference/0.3.0/schemas/AccountMovementEventData.md): A posted account movement. The event includes the movement amount but not the current balance. Retrieve the account when you need its latest balance.
- [AccountStatusEventData](/client-account-api/api-reference/0.3.0/schemas/AccountStatusEventData.md): Account lifecycle notification.
- [DestinationEventData](/client-account-api/api-reference/0.3.0/schemas/DestinationEventData.md): Notification about the review or availability of an external account registered in the selected client's address book. `destinationId` identifies its address book entry.
- [Event](/client-account-api/api-reference/0.3.0/schemas/Event.md): Webhook event envelope delivered to your registered endpoint.
- [Subscription](/client-account-api/api-reference/0.3.0/schemas/Subscription.md)
- [RequestStatus](/client-account-api/api-reference/0.3.0/schemas/RequestStatus.md)
- [PublicKey](/client-account-api/api-reference/0.3.0/schemas/PublicKey.md)
- [Money](/client-account-api/api-reference/0.3.0/schemas/Money.md): Monetary amount and its currency.
- [Decimal](/client-account-api/api-reference/0.3.0/schemas/Decimal.md): Decimal number serialized as a string to preserve precision. Amounts sent to Axiym are positive and carry at most 8 decimal places.
- [ExternalReference](/client-account-api/api-reference/0.3.0/schemas/ExternalReference.md): Your optional identifier for correlating the resource with your system. Axiym returns it on reads. It does not make retries safe; use `Idempotency-Key` for that.
- [ValidationFieldErrors](/client-account-api/api-reference/0.3.0/schemas/ValidationFieldErrors.md): Nested validation errors keyed by field name or array index. Leaf values are arrays of `ValidationError` objects.
- [Network](/client-account-api/api-reference/0.3.0/schemas/Network.md): Wallet network.
- [ValidationError](/client-account-api/api-reference/0.3.0/schemas/ValidationError.md): One field-level validation error.