Developers: the short version

Create records, look anything up, read a record's live status and check Proof Rail's signatures from your own code.

Developers building Proof Rail into a product or a tool.

1. Sign up at proofrail.me/app/signup. A sandbox key that starts with rp_sandbox_ is created and shown once. You can make more under Developer access in your dashboard.
2. Create test records with POST /api/v1/records and your sandbox key. Test records are free and never public.
3. Look anything up with GET /api/v1/lookup?q= followed by the value. No key is needed.
4. Read a record's live status with GET /api/v1/records/ followed by the ID and /status.
5. Verify a signature: remove the signature field, write the rest as canonical JSON, and check it against the key in /.well-known/jwks.json whose kid matches signing_key_id.
6. Read the full reference at proofrail.me/developers.

Sandbox

A test area. Records made there are free, private and never shown as verified.

Canonical JSON

JSON written one fixed way, with keys in alphabetical order and no spaces, so the same data always gives the same bytes.

Ed25519

The signature method Proof Rail uses. The public keys are published at /.well-known/jwks.json.

kid

The ID of a key in the published key list.

• GET /api/v1/lookup?q=@ProofRailme returns result "verified" and the record RP-XH7NO2BN7UFR.

• The lookup API allows 30 requests a minute from one address. Above that it answers 429 with a retry-after header.
• Live keys (rp_live_) need a confirmed email and an active plan. For costs, see the pricing page.
• Never send keys, secrets or wallet recovery phrases to Proof Rail.