Base URL
All paths in this reference are relative to:Base URL
application/pdf). Timestamps are ISO 8601 with a UTC offset.
Endpoints
Partner access
| Method | Path | Auth | Rate limit | Purpose |
|---|---|---|---|---|
| POST | /api/partner/request | Public | 5/hour per IP | Request a partner API key (details) |
Proof Passport
| Method | Path | Auth | Rate limit | Purpose |
|---|---|---|---|---|
| POST | /api/passport/seal | Partner key | 12/min per IP | Seal an executed PDF (details) |
| GET | /api/passport/{id} | Partner key | — | Fetch one of your passports |
| POST | /api/passport/webhooks | Partner key | — | Register a passport.sealed webhook (details) |
| GET | /api/passport/verify/{code} | Public (verify code) | 12/min per IP | Verify a sealed passport |
| GET | /api/passport/verify/{code}/document | Public (verify code) | 12/min per IP | Download the sealed PDF |
Closing Rooms
| Method | Path | Auth | Rate limit | Purpose |
|---|---|---|---|---|
| POST | /api/rooms | Partner key | 60/min per key | Create a room (details) |
| GET | /api/rooms | Partner key | 60/min per key | List your rooms |
| POST | /api/rooms/{roomCode}/orders | Partner key | 60/min per key | Attach an order by its public code |
| DELETE | /api/rooms/{roomCode}/orders/{orderCode} | Partner key | 60/min per key | Detach an order |
| POST | /api/rooms/{roomCode}/rotate | Partner key | 60/min per key | Reissue the room’s bearer link |
| GET | /api/rooms/{roomCode} | Public (room code) | 30/min per IP | Live room view — progress, order cards, activity, passport |
Closing Passports
| Method | Path | Auth | Rate limit | Purpose |
|---|---|---|---|---|
| POST | /api/rooms/{roomCode}/passport | Partner key | 60/min per key | Seal the room’s next passport version (details) |
| GET | /api/verify/room/{verifyCode} | Public (verify code) | 30/min per IP | Verify a Closing Passport — manifest, hashes, chain status |
| GET | /api/verify/room/{verifyCode}/pdf | Public (verify code) | 30/min per IP | Download the sealed passport certificate |
Webhook management
| Method | Path | Auth | Rate limit | Purpose |
|---|---|---|---|---|
| GET | /api/partner/webhooks | Dashboard session | 120/min per session | List webhook subscriptions (details) |
| POST | /api/partner/webhooks | Dashboard session | 120/min per session | Create a subscription — the signing secret is shown exactly once |
| DELETE | /api/partner/webhooks/{id} | Dashboard session | 120/min per session | Delete a subscription |
The partner dashboard also exposes session-authenticated mirrors of the room
routes (
/api/partner/rooms/...) for firms that operate rooms from the UI.
They call the same underlying service and return the same shapes as the
partner-key routes documented on the rooms page.Conventions
- Bearer codes, not accounts. Public reads are authorized by possession of an unguessable code — a room code, an order code, or a verify code. Whoever holds the code can read; treat every code like a credential.
- Errors are JSON:
{"error": "human-readable message"}with a 4xx status. Public verification surfaces return the same generic{"verdict": "unknown"}404 for malformed, unknown, and missing codes — nothing to enumerate. - Rate limiting returns
429 Too Many Requests. Limits are listed per endpoint above and on the authentication page. - Honesty by design. Responses never claim evidence that is not held: evidence badges distinguish SEALED (verifiable artifact hash on record) from RECORDED (platform attestation only), and every Closing Passport manifest carries an explicit coverage statement of what it does and does not prove. See the evidence model.
Explore the reference
Authentication
Partner API keys, how keys are issued and rotated, and every rate limit.
Partner access requests
Request a trial key self-serve — instant issue or human review.
Closing Rooms
Create rooms, attach orders, rotate links, and read the live room view.
Closing Passports
Versioned, sealed evidence manifests with a verifiable hash chain.
Proof Passport
Seal any executed PDF and get a public verification URL back.
Webhooks
Signed event deliveries and how to verify them.