# Getting Started

Build and operate an Account API integration.

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

Use this guide to retrieve your Axiym accounts, select registered external
accounts, deposit funds, create and confirm withdrawals, track outcomes, and
reconcile account activity.

Before implementing, read
[Concepts & Workflows](/account-api/concepts/overview).

## Recommended path

### 1. Prepare access

Complete [Access setup](/account-api/integration-guide/access-setup) to obtain
environment-specific OAuth credentials, then use the
[authentication reference](/account-api/api-reference/0.3.0/auth/oauth/token/post)
and shared header conventions to configure your integration.

### 2. Register and verify webhooks

Create a subscription through the
[Webhook Subscriptions reference](/account-api/api-reference/0.3.0/webhook-subscriptions/webhooks/subscriptions/post),
verify Ed25519 signatures, deduplicate deliveries by event ID, and fetch the
relevant resource whenever authoritative state matters.

### 3. Select an external account and validate the sandbox flow

Address book entries are registered outside the Account API. Retrieve the
available records using [Select an address book entry](/account-api/integration-guide/register-external-account),
then use [Sandbox testing](/account-api/integration-guide/sandbox-testing) to
confirm account access, destination status, withdrawal creation and confirmation,
event handling, and reconciliation. Start with the
[Quickstart](/account-api/integration-guide/quick-start) using provisioned
sandbox accounts and destinations.

### 4. Implement the operational workflow

Follow [Deposit funds](/account-api/integration-guide/deposit-funds),
[Create and confirm a withdrawal](/account-api/integration-guide/create-a-withdrawal),
[Track a withdrawal](/account-api/integration-guide/track-a-withdrawal), and
[Reconcile activity](/account-api/integration-guide/reconcile-activity).

## Fundamentals

Use these references for the conventions that apply across the integration:

* [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 query parameters](/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)

## Production-readiness checklist

* Credentials are stored and rotated securely.
* Any required egress or network controls are confirmed for the correct environment.
* Only active, compatible accounts and destinations can be selected.
* Idempotency keys survive timeouts and process restarts.
* A created withdrawal is confirmed explicitly before the integration treats it as processing.
* Webhook signatures are verified against the raw request body.
* Duplicate and out-of-order events are handled safely.
* Current state is recovered through list and get operations.
* Completed deposits and withdrawals are reconciled to account activity and external records.