# Getting Started

Product: Account API
Guides follow API reference 0.1.0 and event reference 0.1.0.
Canonical page: https://docs.sandbox.axiym.io/account-api/integration-guide

Use this guide to build and operate an Account API integration. It assumes
you already understand Axiym accounts, registered external accounts, deposits,
conversions, and withdrawals as described in
[Concepts & Workflows](/account-api/concepts/overview).

Your credentials provide access to your organization’s Axiym accounts and API
resources. External bank accounts and wallets must be registered and whitelisted
before they can fund deposits or receive withdrawals.

## Recommended path

### 1. Prepare access

Complete
[Access and environments](/account-api/integration-guide/access-setup)
to obtain sandbox credentials, provide your egress addresses, and confirm the
Axiym accounts, conversion pairs, and external-account test fixtures available
for testing.

### 2. Understand sandbox testing

Read [Sandbox testing](/account-api/integration-guide/sandbox-testing)
before moving funds. It covers test balances, wallet transfers on testnet,
and bank scenarios coordinated with Axiym.

### 3. Complete the quickstart

[Make your first conversion](/account-api/integration-guide/quick-start)
takes you from authentication to a confirmed conversion. It is the shortest
way to validate credentials, Axiym account access, permissions, idempotency,
and the quote-and-confirm workflow.

### 4. Implement the workflows you need

| Guide                                                                         | Use it to                                                                                                             |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| [Add to the address book](/account-api/integration-guide/add-to-address-book) | Register an external bank account or wallet for whitelisting as a deposit source and withdrawal destination.          |
| [Deposit funds](/account-api/integration-guide/deposit-funds)                 | Send funds from a whitelisted external account, identify the resulting deposit, and confirm the Axiym account credit. |
| [Execute a conversion](/account-api/integration-guide/execute-a-conversion)   | Select a permitted pair, create a locked quote, confirm it, and track execution.                                      |
| [Withdraw funds](/account-api/integration-guide/withdraw-funds)               | Create and confirm a withdrawal from an Axiym account to an active, whitelisted external account.                     |
| [Reconcile activity](/account-api/integration-guide/reconcile-activity)       | Join API resources to account statement entries and verify period balances.                                           |

Register the external account or wallet and wait until its status is `ACTIVE`
before testing a deposit or withdrawal. Activation follows Axiym’s due diligence
and compliance checks; confirm the review process available in sandbox.

### 5. Apply the shared conventions

The fundamentals apply across Account API operations:

* [Authentication](/account-api/integration-guide/fundamentals/authentication)
* [Common Headers](/account-api/integration-guide/fundamentals/common-headers)
* [Idempotency](/account-api/integration-guide/fundamentals/idempotency)
* [Pagination and List Filters](/account-api/integration-guide/fundamentals/pagination-and-query-parameters)
* [Error Handling and Retries](/account-api/integration-guide/fundamentals/error-handling-and-retries)
* [Rate Limits](/account-api/integration-guide/fundamentals/rate-limits)
* [Data Formats and Constants](/account-api/integration-guide/fundamentals/data-formats-and-constants)
* [Payment Rails](/account-api/integration-guide/fundamentals/payment-rails)
* [Blockchain Networks](/account-api/integration-guide/fundamentals/blockchain-networks)

## Definition of a production-ready integration

Before moving production funds, your integration should be able to:

* obtain new access tokens before expiry without exposing client secrets;
* attach request IDs and idempotency keys correctly;
* handle asynchronous deposit, conversion, external-account, and
  withdrawal states;
* distinguish simulated sandbox bank activity from real external settlement;
* retry only requests that are safe to retry;
* follow cursor pagination until `hasNextPage` is false; and
* reconcile completed operations against Axiym account statements and the
  corresponding treasury or payment records in your system.