> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quantumapi.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Qustody API: complete endpoint reference

The Custody API exposes 27 endpoints for managing tenants, vault accounts, wallets, transactions, assets, and webhooks on the Quantum Chain network.

## Base URL

```
https://api.qustody.io/v1
```

The API is served from `api.qustody.io`. The companion dashboard is at [app.qustody.io](https://app.qustody.io). For local development, point `baseUrl` at your own deployment — see [Configure a development network](/guides/configure-a-development-network).

## Authentication

All endpoints except `/healthz` and `/readyz` require a Bearer API key:

```
Authorization: Bearer <key_id>:<secret>
```

See [Authentication](/authentication) for details on credential format and IP allowlisting.

## Request format

* Content-Type: `application/json`
* All request bodies are JSON objects
* Path parameters use `{id}` notation
* Query parameters support pagination via `page` and `page_size`

## Response format

Successful responses return the resource directly:

```json theme={null}
{
  "id": "tx_abc123",
  "status": "COMPLETED",
  "amount": "10.0",
  "created_at": "2026-03-19T10:00:00Z"
}
```

List endpoints return paginated responses:

```json theme={null}
{
  "data": [...],
  "page": 1,
  "page_size": 20,
  "total": 142
}
```

## Error format

Errors include a numeric code and human-readable message:

```json theme={null}
{
  "error": {
    "code": 1001,
    "message": "Invalid API key"
  }
}
```

### Error code ranges

| Range       | Category                         |
| ----------- | -------------------------------- |
| `1000–1099` | Authentication and authorization |
| `1100–1199` | Validation and request errors    |
| `1200–1299` | Policy violations                |
| `1300–1399` | Transaction errors               |
| `1400–1499` | Webhook errors                   |
| `1500–1599` | Asset errors                     |
| `1600–1699` | Internal errors                  |

## OpenAPI specification

The complete API is defined in an OpenAPI 3.1.0 specification. All endpoint pages below are auto-generated from this spec.

<Card title="OpenAPI Specification" icon="file-code" href="https://github.com/Quantum-Chain-PTE-LTD/go-quantum-chain/blob/main/custody/api/openapi.yaml">
  View the source OpenAPI specification
</Card>