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

Get Your Account

You will need a Credential Engine user account and an approved Organization Account to publish to search 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 searching 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 search 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 queries to send to the search API.

Build Queries

The Credential Engine Registry offers an increasing wealth of information about Credentials and all of the things it takes to earn them. Once you have your API key and a good sense of what data lives where, you are ready to start sending queries to our search API. Return to the Use Cases to familiarize yourself with some real queries, then move on to the Query Helper to start writing your own.

Get the Starter Code

When you're ready to start writing code to generate queries, you can take advantage of our Starter Code to get started quickly, and finally graduate to having your own standalone application send search queries to our search API for the benfit of your own site or app's users.