Integration Surfaces
Maturity honesty for Cleared API and adjacent surfaces. Never assume Live unless this matrix says so.
Unit of record
The unit of record is the eligibility record: a sealed pass/fail/refer decision under a published policy_version, with allows[] the venue can gate on. See Disclosure Boundary.
Surface matrix
MVP Must (Early Access target): Stratum seal API, Arbiter pack API, fail-closed gate, demo public ledger for public_demo networks.
| Surface | What it gives you | Maturity | Notes |
|---|---|---|---|
REST API (clr_ Bearer) | Onboard, eligibility status, gate check | By arrangement / Early Access → target Live | Base URL labeled per environment; see API reference |
| Onboard + decide | case_id; pass/fail/refer under policy_version | MVP Must / contract-preview | Vault holds preimages only |
| Stratum seal API | Live stratum_record_id; live-pass cache | MVP Must / by arrangement | Exactly-once via Idempotency-Key; fixtures CI-only |
| Arbiter assessor pack API | Decided + sealed + consumed export | MVP Must / contract-preview | No vault bytes; outbound Arbiter docs |
| Gate check | Fail-closed allow/deny before quote | MVP Must / contract-preview | Fake gate for eng; production consume by arrangement |
| Demo public ledger | Seal receipts on Cleared /seals | MVP Must / Early Access | public_demo networks only; see Demo ledger |
| Optional outsider prove | Extra digest when configured | Should / not quote SoR | Stratum-only degrade if prove is down |
| Portable escrow proof | Escrow/portable prove | Not yet public (Full) | Not required for MVP gate |
| Webhooks / continuous monitoring | Event push | Not yet public | Out of MVP Must |
| MCP / agent tools | Tool surface | Not yet public | Cleared is REST-first for Early Access |
Launch path
For Early Access partners aiming at API access by launch date:
- Request access (demo or contracted arrangement).
- Receive environment base URL + scoped
clr_key (Authentication). - Complete Quickstart against the issued environment (decide → live Stratum seal → gate → Arbiter pack).
- Wire Gate check fail-closed; prove deny on miss/timeout.
- Confirm demo receipts on Demo ledger / live seals page when using
public_demonetworks. - Pass Production Checklist before production quote traffic.
Surfaces move from contract-preview → Live only when this matrix is updated. Do not hardcode undocumented paths.
Related products
| Product | Role relative to Cleared |
|---|---|
| Stratum | Shared sealed SoR for the eligibility fact (MVP Must API) |
| Arbiter | Assessor pack / evidence integrity when entitled (MVP Must API) |
| Legate | Agent MCP envoy — not the Cleared gate surface |
Cleared does not replace KYB vendors; it publishes the fact the venue gates on.