Skip to content

Access Model

Who may connect, what each role can do at the interface, and what never crosses the vault wall.

Maturity: Early Access. Enforcement details for Early Access keys are issued per partner — this page is the public actor contract.

Actors

ActorRole at the interface
Institution ops / Early Access operatorCreates onboard cases, attaches vault material, triggers decision/seal paths entitled to their key
Venue / clearing integratorCalls gate check only (or eligibility read as issued). Never receives vault bytes
Examiner / reviewerOpens assessor pack (decided / sealed / consumed). No vault via pack
Cleared serviceVerifies clr_ keys, enforces scopes, maintains live-pass cache, fails closed on gate miss/timeout
BlockSkunk operatorProvisions environments and keys; does not publish judgment criteria in this docs set

Capabilities

CapabilityOpsVenueExaminer
Onboard / attach docsYes (scoped)NoNo
Read eligibility / case statusYes (scoped)Read-only if scopedVia pack only
Gate check (allow/deny)OptionalYes (primary)No
Assessor pack exportYes if entitledNoConsume / verify
Vault downloadOps vault path onlyNeverNever

Unauthorized calls return public error categories — see Errors. Existence of out-of-scope subjects is not confirmed beyond those categories.

Vault wall

  • Vault holds document preimages and screening inputs.
  • Stratum / optional prove / pack payloads carry no PII (fitness denylist at CI for Early Access).
  • Gate and pack APIs never return vault bytes.
  • Public prove (when Live) proves digests / txids — not vault contents.

Keys and scopes

Partners receive clr_ API keys with scopes such as:

Scope (illustrative)Intent
cleared.onboardCreate case, attach vault refs
cleared.eligibility.readRead case / eligibility status
cleared.gateGate check before quote/settle
cleared.pack.readAssessor pack export / verify

Exact scope strings are issued with the key. Treat undocumented scopes as non-contract. See Authentication.

Was this page clear?