> For the complete documentation index, see [llms.txt](https://docs.reveel.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.reveel.id/api-references/overview.md).

# Overview

Welcome to the Reveel PayID REST API reference. This section contains detailed documentation for every publicly accessible endpoint available to partner applications, wallets, and agents.

### What You Can Do

Reveel PayID APIs allow you to:

* Register and manage users
* Claim and manage PayIDs
* Define and manage custom routing rules
* Initiate cross-chain transactions
* Retrieve transaction history and user activities

### Authentication

All API requests require a valid API key in the Authorization header:

```http
Authorization: Bearer your-api-key
Content-Type: application/json
Accept: application/json
```

💡 API keys are issued after your application is approved. Request access here: **<devs@r3vl.xyz>**

### Base URL

```
https://api.reveel.id/v1
```

### API Categories

The API endpoints are organized into these main categories:

* **Users** - Create, retrieve, and manage user accounts
* **PayIDs** - Claim, search, and manage PayIDs
* **Routes** - Create and manage routing rules for incoming payments
* **Transactions** - Initialize transactions and retrieve activity history

### &#x20;Response Format

All responses follow a consistent structure:

#### Success Response

```json
{
  "success": true,
  "data": {
    // endpoint-specific payload
  },
  "meta": {
    "message": "Action completed successfully"
  }
}
```

#### Error Response

```json
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid input data",
    "details": {
      "errors": [
        {
          "path": ["payId"],
          "message": "PayID not found"
        }
      ]
    }
  }
}
```

### Rate Limits & Versioning

* All endpoints are versioned under `/v1`
* Current rate limits: 100 requests/minute (subject to change)
* Abuse or misuse of APIs may result in throttling or key revocation

### &#x20;Error Codes

Common error codes you may encounter:

| Code                 | Description                                       |
| -------------------- | ------------------------------------------------- |
| `UNAUTHORIZED`       | Invalid or missing API key                        |
| `VALIDATION_ERROR`   | Invalid request parameters                        |
| `RESOURCE_NOT_FOUND` | Requested resource does not exist                 |
| `CONFLICT`           | Resource already exists or conflicts with another |
| `INTERNAL_ERROR`     | Server-side error                                 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.reveel.id/api-references/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.