Concepts

The Heirloom API allows issuers to issue Verifiable Credentials (VCs) to subjects with a set of claims conforming to specific schemas. The issuers and subjects are identified using Decentralized Identifiers (DIDs).

DIDs

DIDs are the core identity primitive that Heirloom uses to identify parties interacting with VCs.

Credentials

A VC is a packet of JSON data that contains claims that a given issuer wishes to make about a given subject. It is cryptographically signed using key material from the issuer’s DID.

Credential Types

Credential types are schemas that define what kind of data will be in a given credential. Heirloom has a number of predefined Credential Types to suit a multitude of use cases.

Collections

Collections are groupings of credentials of the same type. They are usually meant to represent a grouping of credentials that have a similar purpose/logical grouping/temporal grouping. For example with a University, they might have a collection represent all of the graduating degrees of a specific year.

Operations

Creating a DID

You will have a DID provisioned for your Organization account automatically. This will be the primary DID that will appear as the issuer and perform signing of VCs in the API.

Creating a Collection

To issue credentials, you must first create the Collection that houses those credentials. For this version of the API, Collections can only be created within Heirloom Creator UI.

  1. Make an account at creator.heirloom.io
  2. Check your inbox for an email with your Creator Login Credential
  3. Claim your Creator Login Credential on your mobile device
  4. On your computer, navigate to creator.heirloom.io/login
  5. Scan the QR to log in