Skip to main content

Registry Services

The Credential Type Registry is the publication and discovery layer in the SIROS ID wallet ecosystem. It makes credential type metadata — such as display names, claim definitions, and rendering hints — available to wallets, issuers, and verifiers so they can present credentials consistently.

The public registry is hosted at registry.siros.org and is built using registry-cli.

What the Registry Does

Organizations that issue digital credentials define Verifiable Credential Type Metadata (VCTM) files describing how each credential type looks and what claims it contains. The registry:

  1. Discovers VCTM files from configured sources (GitHub repositories, local directories).
  2. Aggregates them into a single, browsable catalogue.
  3. Publishes the catalogue as a static HTML site with a TS11-compliant JSON API, an OpenAPI specification, and optional JWS-signed responses.

The result is a public (or private) catalogue that any compatible client can query.

Using the Registry

There are two ways to get credential type metadata into your wallet deployment:

  • Use the public registry at registry.siros.org. This is the easiest option — it automatically discovers credential metadata from GitHub repositories tagged with the vctm topic. If your credential types are published in public GitHub repos, they will appear in the catalogue without any extra setup.

  • Run your own registry with registry-cli. Running registry-cli locally lets you choose exactly which sources to include, mix public and private repositories, and serve credential metadata to a private wallet deployment that is not connected to the public internet. This is useful for testing, for organisations that need to keep their credential types confidential, or for air-gapped environments.

Both options produce the same TS11-compliant JSON API, so wallets and backends can switch between them by changing a single URL.

How registry.siros.org is Built

The public instance at registry.siros.org is produced by running registry-cli build against a set of source repositories — primarily those tagged with the vctm topic on GitHub. A CI pipeline rebuilds and deploys the site whenever source metadata changes. The site is hosted as a static site on GitHub Pages.

The build process is fully reproducible: anyone can point registry-cli at the same sources and get an equivalent catalogue. See the registry-cli page for setup instructions.

Role in the Wallet Ecosystem

The registry sits between credential publishers and credential consumers:

  • Issuers / credential designers publish VCTM files in Git repositories. The registry discovers and aggregates them.
  • go-wallet-backend fetches and caches metadata from the registry so wallets can render credentials with the correct display names, logos, and claim labels.
  • Verifiers can look up claim schemas to understand what a presented credential contains.
Don't confuse the "registries"

The SIROS ecosystem uses the word "registry" in several places:

ComponentRoleDescription
registry-cliPublisherCLI tool that builds the credential type catalogue.
registry.siros.orgCatalogueThe public static site produced by registry-cli.
go-wallet-backend registryConsumerService in go-wallet-backend that fetches and caches metadata from registry.siros.org.
VC registry (vc/cmd/registry)Token Status ListsA completely separate service managing credential revocation. Not related to credential type metadata.

Further Reading