Skip to main content

Create a credential schema

Where this task sits in the credentials workflow:

Credentials workflow - Issue

Credential schemas are a crucial part of the digital identity credentials lifecycle. A credential schema defines the kind of credential you will be issuing; in it, you determine the credential format, the revocation method (if any), and the attributes about which you, as an issuer, will be making claims. And it's just as important for verifying as well since proof schemas, used to request proofs from wallet holders, are composed of parts of credential schemas.

In this task you will design a credential schema with which you can start issuing credentials or create proof schemas for verifying use cases.

Prerequisites​

  • You are logged in to the Desk

To create a credential schema​

  1. On the left sidebar, choose Credential schemas.

  2. On the top-right of the Credential schemas page, choose + New credential schema.

    → Credential schema setup opens.

  3. Complete the credential setup, then choose Next step:

    • Credential schema – Name the credential to be issued using this schema. For example: "Driver's License", "Gym Membership", or "Residence Permit".

    • (Optional) Wallet key storage type: Choose whether to request that the holder's wallet uses a particular key storage technology.

      • Software: Wallet will use an encrypted internal database.
      • Hardware: Wallet will use the native Secure Element (Secure Enclave for iOS and Keystore for Android).
      • Remote Secure Element: Wallet will use a remote hardware security module (HSM) solution.
      info

      The trial environment uses Ubiqu Remote Secure Element for its HSM implementatation. This is not available through the open source repositories.

    • Credential format – Choose a credential format.

    • Revocation method: Choose a revocation method and select the box to enable suspension.

  4. Complete the schema setup by adding attributes, then choose Next step:

    • Attribute key – The attribute about which a claim or request will be made; for example, "Name", "Birthdate", "Age".
    • Attribute type – The type of data accepted for this attribute. This is used in data validation. The types available are extensively customizable to fit any use case, but the selections here are for getting started.
    • Required – Leave the box checked if a value is required for issuing with this credential.

  5. Review the credential schema, then choose Save.

🎉 Congratulations! You've successfully created a credential schema!

You can now start issuing credentials with this schema. If you want to verify this credential, move next to creating a proof schema.

Or you could suspend or revoke one of the credentials you issued earlier.