Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.43.0.
If an application knows what it must establish about a person but not which institution can answer, Registry Discovery tells it which Evidence types meet that requirement and which Registry Evidence services assert them.
What an application gets
Section titled “What an application gets”An application asks two questions over plain HTTP. It resolves a requirement, such as adult status in one jurisdiction, to the alternative sets of Evidence types that satisfy it. Then it searches for services that assert a type and reads each provider’s public endpoint and the SHA-256 of the exact description the provider published. It saves the record and binding it chose, with the index revisions it chose under, as a selection: inert public metadata it can compare later. The Discovery namespace of the Registry Stack client does this from Rust, Node.js, or Python.
What an operator maintains
Section titled “What an operator maintains”An operator keeps one project directory: the HTTPS origins it approved, one per provider; mapping
files that say which Evidence types meet which requirement; and a runtime file. discoveryctl
checks the project offline, then fetches each approved description once and writes an immutable,
digest-sealed package. discovery serves that one package read-only, needs no database, and
never contacts a provider while it runs. A new revision means a new package and a restart.
What Discovery refuses to decide
Section titled “What Discovery refuses to decide”Discovery is a curated index, not a trust broker. It holds no credentials, proxies no call, and vouches for no provider. Listing a service only means the operator approved its origin and the provider published that description. Whether to trust an endpoint stays with the application’s own Evidence configuration, and the application calls the provider directly. How Registry Discovery works explains that boundary.
When it is not the right product
Section titled “When it is not the right product”An application that already knows its provider needs no index. Discovery describes only Registry Evidence services; Registry Manifest describes a registry’s datasets and services for catalogues.
Where to start
Section titled “Where to start”Publish and consume a Registry Discovery index packages and serves an index on your machine and finds one provider in about 15 minutes. Package and run a Registry Discovery index takes it to HTTPS origins and a pinned package.