# API

> **API documentation overview**\
> This section describes how to integrate with the Aurex platform using the official API.

The Aurex API provides programmatic access to core platform functionality that is also available in the dashboard. It is designed for developers, teams, and partners who need **automated or scalable access** to users, wallets, cards, and transactions.

{% hint style="danger" %}
**Important**

The mobile application does **not** use user-generated API keys.
{% endhint %}

***

### What this section contains

This API documentation is structured into focused sub-sections, each covering a specific part of the platform:

* **Overview** — general API behavior, base URL, limits, and response formats
* **Auth** — authentication model, API keys, and security requirements
* **Users** — user creation, wallet balances, and deposits
* **Cards** — virtual card issuance, top-ups, transactions, and OTP codes

Each sub-section contains **practical explanations, endpoints, and examples**.

***

### Who this API is for

The Aurex API is intended for:

* backend services and integrations,
* automation and internal tooling,
* payment and card management systems,
* partners building on top of Aurex infrastructure.

{% hint style="danger" %}
**Important**\
The API exposes **real financial operations**. Actions performed via API have the same effect as actions performed in the dashboard.
{% endhint %}

***

### General principles

* REST-style HTTP API
* JSON request and response format
* API key–based authentication
* Standard HTTP status codes for errors

All requests require proper authentication and are subject to rate limits.

***

### Before you start

Before using the API, make sure that:

* you have access to the Aurex dashboard,
* an API key has been created,
* you understand the security implications of API access.

Detailed technical information is provided in the sub-sections below.

***

> **Next step**\
> Start with the **Overview** section to understand base API behavior and limits before making your first request.