This guide is for developers looking to quickly start using the Credential Registry to publish credentials and related information.

Get Your Account

You will need a Credential Engine user account and an approved Organization Account to publish to the Registry:

  1. If you don't have one already, register your user account.
  2. If your organization already has an organization account, they can invite you to join it via your email address. Otherwise, you will need to create and submit an organization account from your dashboard after logging in.
    • Select the appropriate options for publishing to the Registry that apply to your organization.
  3. Once Credential Engine approves your organization, you will see your "Publishing/Search API Key" on your dashboard after logging in.

Review the Use Cases

Review the Use Cases to discover the types of problems that the Credential Transparency Description Language (CTDL) and the Registry aim to solve.

Learn CTDL

In order to publish to the Registry, you will need to familiarize yourself with CTDL. The CTDL Explorer provides a quick reference for learning what data resides where in CTDL records in the Registry. This will help you develop code that constructs records to be published.

Publish to the Registry

The Credential Engine Registry enables your organization to add descriptions of its Credentials to an increasing wealth of information that can be searched by anyone. Once you have your API key and a good sense of how to construct CTDL records, you are ready to start publishing via our API. Return to the Use Cases to familiarize yourself with the types of data that users will find helpful.