Skip to content
Registry StackDocsv0.41.0

Registry Stack documentation

View as Markdown

Registry Stack provides focused components for institutions that manage authoritative data and the services around it.

Answer a bounded question with Evidence Gateway

Section titled “Answer a bounded question with Evidence Gateway”

Use Evidence Gateway when a caller needs a signed, minimum-disclosure answer rather than a record. Start with the Evidence Gateway overview and your first assertion.

Build a writable registry with Base Registry Engine

Section titled “Build a writable registry with Base Registry Engine”

Use Base Registry Engine (BReg) when an institution needs a governed system of record backed by PostgreSQL. Start with the BReg overview and create and query your first registry. Continue by building a production candidate and querying it from an application.

Use Registry Casework when authorized people must claim, draft, and decide work owned by another system. Start with the Casework overview and decide your first work item.

Send operational messages with Registry Messaging

Section titled “Send operational messages with Registry Messaging”

Use Registry Messaging to send one reviewed email or SMS through an operator-connected provider. See the Registry Messaging overview.

Publish portable metadata with Registry Manifest

Section titled “Publish portable metadata with Registry Manifest”

Use Registry Manifest to validate metadata and render static, standards-shaped publication artifacts. It does not serve records or authorize callers.

Registry Relay was retired in Registry Stack 0.39.0. Read the retirement decision for the scope, rationale, support boundary, where the 0.38.0 release and its documentation remain available, and bounded alternatives.

BReg owns its PostgreSQL records and API. Evidence Gateway owns bounded question answering, signing, and minimum disclosure against its configured sources. Manifest publishes static metadata. These components do not configure or deploy one another.

Registry Stack does not decide legal authority, data ownership, eligibility, or institutional approval. The responsible institutions still make those decisions.

  • The assertion provider is the institution that answers requests with signed facts through Evidence Gateway.
  • The data publisher is the institution that maintains records through BReg or publishes static metadata through Manifest.
  • The consumer or verifier is the relying service that calls a product API and verifies the answers it receives.
  • The operator is whoever runs the deployment.

One institution can hold several roles.