Skip to content
Registry StackDocsDocumentation preview

Registry Stack documentation

View as Markdown

Registry Stack helps an institution provide controlled access to data it already manages. You can expose a protected, read-only API or return a bounded claim without giving callers direct access to the source system.

Install registryctl, create the maintained sample project, start Registry Relay, and make one denied request and one allowed request.

Run your first registry API takes about 20 minutes and does not require a repository checkout.

Continue with Registry Notary after the first API works. The claim tutorial uses maintained synthetic data to make match, no-match, and denied requests through a running local service.

Verify a live registry-backed claim completes the local beginner path.

After the local sample works, replace it with one reviewed non-personal workbook. You will describe the sheet explicitly, choose which fields callers can receive, validate every row, and run the same protected checks.

Use your own spreadsheet is the shortest path from the sample to institution-owned data. The Connect your data overview points to the published explanation and reference material for more advanced source patterns.

  • Use Registry Relay when an authorized caller needs selected records or fields from a source you operate.
  • Use Registry Notary when the caller needs a bounded answer, status, or credential instead of the source record.

Registry Stack keeps source access, caller permissions, disclosure, generated service configuration, and runtime operation as separate review boundaries. The architecture overview explains how the products fit together after you complete a first task.