> 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-old.md).

# Overview -old

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.

Reveel PayID APIs allow you to:

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

***

#### 🔐 Authentication

All API requests require a valid API key in the `Authorization` header.

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

> 💡 API keys are issued after your application is approved. Request access here

***

#### 🌍 Base URL

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

***

#### 🗂 API Categories

Endpoints are organized by functionality:

| Category             | Description                                      |
| -------------------- | ------------------------------------------------ |
| **User APIs**        | Create and manage platform users                 |
| **PayID APIs**       | Claim, check, and search PayIDs                  |
| **Routes APIs**      | Configure how users want to receive payments     |
| **Transaction APIs** | Trigger, track, and monitor payment flows        |
| **Agent APIs**       | Engage with a smart assistant to handle payments |

***

#### 📦 Response Format

All responses follow a standard structure:

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

In case of error:

```json
jsonCopyEdit{
  "success": false,
  "message": "Invalid PayID",
  "error": "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

***

#### 🧰 Tools

You can test the API using:

* cURL
* Postman Collection (coming soon)
* API playground (coming soon)


---

# 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-old.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.