New to the integration? Start with Partner onboarding before using the reference to make requests.
Explore the contract
The interactive reference contains required fields, validation rules and response schemas for each endpoint. Its public availability does not grant access to the business endpoints: authenticated requests still require your account's API key.
The production reference sends requests to the live API. Funding and ordering calls can create real transactions. Use the sandbox reference while developing.
Reseller endpoints
Paths below are relative to https://api.akariq.com/api/v1. This table is built from the versioned OpenAPI document used by the API.
| Method | Path | Required permission |
|---|---|---|
GET | /account | balance:read |
GET | /countries | catalog:read |
GET | /regions | catalog:read |
GET | /plans | catalog:read |
GET | /plans/{id} | catalog:read |
GET | /balance | balance:read |
GET | /balance/transactions | balance:read |
POST | /balance/topups | balance:write |
POST | /orders | orders:write |
GET | /orders | orders:read |
GET | /orders/{id} | orders:read |
GET | /esims/{id}/installation | esims:install |
Request conventions
- Use HTTPS and
Authorization: Bearer YOUR_API_KEY. - POST bodies use
Content-Type: application/json. The request body limit is 16 KiB. - Purchase and funding requests require an
Idempotency-Key. - Amounts are integer USD cents. Use the current account price from the catalog.
- List responses with pagination expose
nextCursor. The default limit is 25; the maximum is 100. - Private API responses use
Cache-Control: no-store.
See Errors & retries for failure handling and Authentication for key permissions.