The offered API

Stories you can explore

As an SDK author, I want to browse what callers supply, what they obtain and which refusals to handle. This reference is generated from CDDL, the refusal registries and the model conformance corpora.

Specification candidate. Preparation is unsigned. Callers supply published evidence; the API has no KERI networking. These are abstract model calls with synthetic fixture oracles, not a deployed transaction or cryptographic codec.

flowchart LR
  Caller[Caller] -->|Supplied published evidence| Assessment[Evidence assessment]
  Assessment -->|Missing required evidence| Unknown[unknown]
  Assessment -->|Complete model inputs| Model[Model operation]
  Model -->|Predicate fails| Refused[Named refusal]
  Model -->|Predicate holds| Result[State, flow or verdict]
  • Manage a checkpoint: As a controller or advancer, I want to inspect the evidence, state change and addressed value flow for a checkpoint operation.
  • Check historical evidence: As a relying party, I want to know which historical keys cover a supplied event and whether that range is final or provisional.
  • Project a revocation mirror: As a mirror contributor, I want to open a registry or record a published revocation from its supplied issuer seal.
  • Assess credential chains: As a credential holder or relying party, I want to inspect chain admission, cached dependencies and revocation membership.
  • Use delegated approvals: As a delegatee, I want an approval certificate to name my exact event and be consumed by the corresponding model operation.

What supports the reference

The reference covers 32 operations: eight Checkpoint actions, sixteen statement-model actions and eight queries. Examples come from 1472 checkpoint cells and 66 statement cases. The statement source contains 52 unproved theorem statements.

Read the operation catalogue, statement semantics and limits, encoding contract, implementation gaps and CDDL shapes. Model observations do not establish deployment support, proof completion or mirror freshness.

Source and artifact hashes bind this generated reference.