Creating a Credential Type

Credential Types are templates for issuing or verifying credentials


A credential holds one or multiple claims. A claim can be a name or an email address. If the claim is wrapped by a digital signature of a trustworthy issuer the user can provider a list of claims to some service provider to identify and authenticate for some service.

For example can a credential type contain the fields Name and Email Address. This credential type can then be used to create verifiable credentials for user who use the credentials for password-less logins. In the login process the user shows the credential to the service provider who checks the data, checks the issuer and the issuer's signature, and finally grants access to the service because data is valid and the issuer can be trusted.

In API calls the credential type is referred by its ID. So, to create a verifiable credential the client application of the issuer sends a data record that contains the credential ID (`templateid`) to refer to the respective credential type, and the data fields containing the actual data to the API to request a creation of the respective verifiable credential:

  templateid: 18,
  data: {
    name: "Rheik van Eyck",
    email: ""

Creating a Claim Type

Login into the sideos administration console. If you don't have already an account, sign up with sideos (see Sign up & get started).

In the navigation bar go to Claims and click on Add new claim.

If a claim fitting the requirements is not available in the list, click on create new claim in the description above the table.

Complete the form by naming the new credential type in the field Name. Chose a Type from existing types you probably already defined. In our case the type email is probably not available, so we select Other from the bottom of the selection list.

Give the new type a name, e.g. name.

Select the Context for the new type. The options include DataFeedItem, Boolean, Number, and Image. For the name type which represents a string, the DataFeedItem is the right option.

Optional you can provide a description in the Description text box.

Save the claim by clicking on the Save button.

To create another claim type for the email claim, repeat the steps to create the email claim type.

Once we have the claim types for the name and email for our example we can create a credential type.

Creating a Credential Type

A credential type combines one or more claim type to build an identity context. A company badge for an employee for example may contain the name of the employee, the employee id number, the department, the role, the user id, contact data, emergency contacts, and permission sets as claims.

In the navigation bar go to Credentials and click on Create template. There may be already credentials in a company repository available. You can check by clinking on the button Pick from repository.

Lets assume you want to create a new credential type, so go ahead and click on the button Create template.

Complete the form by choosing an existing or entering a new type in the field Credential type.

Give the new type a name, e.g. User in the field Name.

Add claim types to the credential type by selecting proofs in the selection field Claim 1. In our example we would select the Name claim type. Then we add another claim type by clicking on the (+) button and select the Email claim type as Claim 2.

Optional you can provide a description in the Description text box.

You can save the new credential type as draft by clicking on the button Save as draft or save as completed by clicking on the button Save as complete.

Back in the list of defined credentials note the ID of your new credential type. In the Screenshot below the User credential type has ID 18.

Last updated