ProofRails logoProofRails Docs
Evidence layer for onchain payments

API overview

Official documentation for ProofRails — the open evidence and translation layer for onchain payments.

API overview

ProofRails exposes a REST API served by FastAPI.

Base URLs

http://localhost:8000          # local development
https://app.proofrails.com     # hosted app/API when configured

Interactive docs

FastAPI generates:

GET /docs
GET /redoc
GET /openapi.json

Authentication

Most endpoints require:

X-API-Key: <your_project_api_key>

Project-scoped keys can be generated through project registration or the app settings flow, depending on deployment.

API groups

  • Receipts
  • Verification
  • Projects and API keys
  • Agents
  • x402
  • Anchoring
  • Monitoring
  • Webhooks