API reference
Contract-preview path catalog for Cleared REST. Issued OpenAPI for your environment is authoritative when it differs.
Maturity: Contract-preview / by arrangement. Not a promise of public self-serve.
Base URL
| Environment | Base URL |
|---|---|
| Docs placeholder | {API_ORIGIN} |
| Your Early Access | Issued with the clr_ key |
All paths below are relative to that base. Auth: Authorization: Bearer clr_… — Authentication.
Conventions
| Convention | Rule |
|---|---|
| Content type | application/json unless noted |
| Idempotency | Idempotency-Key on create/seal writes |
| Time | ISO-8601 UTC |
| IDs | Opaque strings (case_…, subj_…, stratum_rec_…) |
| Errors | Errors categories |
Endpoints
Health
GET /v1/health
Liveness / maturity label. May be unauthenticated in some envs — prefer authenticated.
Cases (ops)
POST /v1/cases
Idempotency-Key: <client key>
Create onboard case → case_id, status: received.
GET /v1/cases/{case_id}
Case status at the interface (no vault bytes).
POST /v1/cases/{case_id}/attachments
Attach vault references / upload handles as issued (preimages stay in vault).
POST /v1/cases/{case_id}/decide
Record decision under policy_version (criteria not public).
POST /v1/cases/{case_id}/seal
Idempotency-Key: {case_id}:{policy_version}
Stratum ingest → stratum_record_id.
GET /v1/cases/{case_id}/assessor-pack
Assessor pack export — Assessor pack.
Eligibility
GET /v1/eligibility/{subject_ref}
Current eligibility record shape — Eligibility record.
Gate (venue)
POST /v1/gate/check
Fail-closed allow/deny — Gate check.
OpenAPI
When Live, environments publish machine-readable OpenAPI (path TBD per deploy). Until then, this page + Quickstart synthetic examples are the integrator contract. Breaking changes land in Changelog.