ProofRails logoProofRails Docs
Evidence layer for onchain payments

Quickstart

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

Start hereAPI referenceGitHub

Quickstart

This quickstart gets the backend running locally, creates a receipt, polls status, and verifies the resulting evidence.

Prerequisites

  • Git
  • Docker and Docker Compose, or Python 3.11+
  • A terminal with access to the ProofRails repository

Clone

git clone https://github.com/proofrails/middleware-ISO-v2.2-and-x402.git
cd middleware-ISO-v2.2-and-x402
git checkout agentic
cp .env.example .env

For local development, set:

API_KEYS=dev-admin-CHANGE_ME
X402_MOCK_PAYMENTS=true
RATE_LIMIT_ENABLED=false
AUTO_CREATE_DB=true

Run with Docker Compose

docker compose up --build

The local API should be available at:

http://localhost:8000

Interactive OpenAPI docs:

http://localhost:8000/docs

Run backend directly

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
uvicorn app.main:app --reload --port 8000

Health check

curl http://localhost:8000/v1/health

Next step

Create a receipt with Create your first receipt.