Cleared Counterparty Developer Docs

Venues and clearing desks still ask one operational question before quote or settle: is this counterparty cleared under the published policy right now? Screenshots and portal sprawl do not answer that at gate latency.

Cleared publishes a portable eligibility fact. The eligibility record is the unit of record: a sealed decision with allows[], policy_version, and a Stratum proof identifier the venue can read fail-closed. Vault holds preimages only. Assessor packs open decided / sealed / consumed without vault bytes.

Who this is for

You are…	The problem you feel	What Cleared gives you
Venue or clearing integrator	Quote/settle must block unless a live pass exists	Gate check against a sealed fact — missing/expired/fail/timeout → deny
Institution ops / Early Access operator	Onboard and decision must leave an examiner-grade trail	Onboard → decide → seal under policy_version; case_id for idempotency
Examiner or reviewer	Need decision trace without raw PII	Assessor pack: decided, sealed, consumed — no vault bytes

Start here. Early Access partners request API access by arrangement. Then mint a clr_ key and complete a first call in Quickstart.

Explore by topic

Topic	Start here
What is Live vs contract-preview	Integration Surfaces
Who can read or act	Access Model
States a case moves through	Lifecycle
Shape of the sealed fact	Eligibility record
Venue gate before quote	Gate check
Examiner pack	Assessor pack
Machine-readable paths	API reference

What Cleared gives you

Capability	What it gives you
Eligibility record	One shared answer: allowed actions under a named policy_version
Gate check	Fail-closed read before quote/settle — no silent allow on miss/timeout
Stratum seal	Tamper-evident SoR identifier (stratum_record_id) the venue can cache
Assessor pack (Arbiter API)	Decided + sealed + consumed trail without vault PII
Demo public ledger	Seal receipts on Cleared /seals for public_demo networks
clr_ API keys	Bearer auth for onboard, eligibility, and gate surfaces

How the system fits

1. Ops onboard a legal person; vault holds documents; API returns case_id.
2. Cleared runs silent screens under a published policy_version and decides pass / fail / refer.
3. Stratum receives an exactly-once seal (Idempotency-Key = case_id + policy_version).
4. Venue calls gate with subject + action; Cleared answers allow or deny from the live-pass cache.
5. Examiner opens an Arbiter pack via API — no vault bytes.
6. Demo networks with public_demo publish a receipt on the demo public ledger.

Optional outsider prove (Full / Should) is labeled on Integration Surfaces; Stratum-only degrade means quote SoR stays on Stratum when outsider prove is down.

Reading order

1. Disclosure Boundary — what we publish vs keep private
2. Integration Surfaces — maturity honesty (Stratum + Arbiter MVP Must)
3. Quickstart — first authenticated call
4. Demo ledger — public seal receipts for demo networks
5. Gate check or Eligibility record depending on your role
6. Production Checklist before Early Access traffic