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:

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

💡 API keys are issued after your application is approved. Request access here: [email protected]

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

Response Format

All responses follow a consistent structure:

Success Response

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

Error Response

{
  "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

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