By clicking "Accept", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage and assist in our marketing efforts. More info

Custom Credential Schema Builder Guide

By
Dock
Updated on
December 4, 2023

This no-code feature allows you to create custom credential schemas so you can conveniently choose which data you want to include if they are not available in our pre-built schemas such as University Degree or Proof of Employment.

A schema is like a template for credentials that issuers use. It includes specific details such as name, license number, or email. It's like a pre-made form that helps them create credentials more easily. For example, when an issuer wants to give you a digital ID card, the schema provides fields for your full name, license number, email, and other important details.

Setting up a Custom Credential Schema 

1. Select Schemas and click Create schema

Select "Create schema"

2. Add a Schema name and it’s optional if you want to add a Schema description. For this example, we will make a credential schema for the Business Communicators Association, which is a professional association with different types of memberships.

3. In Credential attributes, add the type of information you want to appear on the credential schema. 

You can do this in two ways: 

a) By manually setting up what kind information you want to appear 

b) Importing an existing credential schema from another source

You can define credential fields by adding manually or importing an existing template

Adding Credential Fields Manually

1. First we’ll go over how to manually set up your credential schema. Click Create manually. 

The first step to creating a custom Verifiable Credential manually

2. Now you will see the type of information you can add on the credential. You will add one field at a time.

You can add Verifiable Credential fields one by one

You can choose what format the field will appear in and which fields are required or optional. The options Nested Object and URI are more advanced features that developers or technical people would use. 

Choose a format for each credential field

3. For our example, this is the information we want to appear for the Business Communicators Association’s membership certificates:

  • Name
  • Membership Type
  • Member Number
  • Issue Date 
  • Expiry Date

These are the membership types: Student Membership, Professional Membership, and Corporate Membership.  

Enter the details of each field: 

  • Write Name in the first box, select the Text format, select Required, and add the Member’s full name in the description. Select Add Field
How to set up the name field of the credential

4. This is how we fill in the last two fields for Membership Type and Membership Number.

  • Type Membership Type, select Text from the drop-down, select Required, and click Add Field
  • Type Membership Number, select Number from the drop down, select Required, and click Add Field
Setting up member type and number on the credential

To remove a field, simply select the X icon on the bottom right of the field. 

Click X to remove a credential field

Note: On this page, you don’t need to add an Issue Date and Expiry Date field because these fields will automatically appear on all schemas.

5. Once you’ve added all the fields, select Publish at the top and on the message that appears afterwards. Then you can see the new Business Communicators Association schema when you click on the Schema menu.

Publish a new schema

6. Now when you issue new credential documents, you will see your schemas added to the list. Another way to view the new schema is by selecting Credentials in the menu and Issue credentials.

See the new schema

Click here to see the full guide on how to issue credentials and go here to see how to make a custom design for your credentials with the Designer tool.

Adding Credential Fields by Importing an Existing Credential Schema

1. You can import an existing credential schema into Dock. The first step is to go to https://ui.schema.affinidi.com/schemas.

2. Select a schema like EmploymentVC for example

EmploymentVC is an example custom credential template

3. Click on the schema to see the data fields

Credential details

4. Copy the URL by clicking on Issue VC with this schema and clicking on the copy icon

Copy the credential template URL

5. Paste the URL in the Credential Schema and select Import Schema

Add the credential URL

6. Even though you will see all of the fields automatically populate, you have to double check to make sure that the format for the drop down menus for each field is selected. Add and remove whatever fields you want. Select Publish once this is done.

Acceleblock schema

7. Now you can see the imported credential on the schema list.

Edit a Credential Schema

1. Select Schemas, go to the schema you want to edit, click on the three dots, and select Copy and edit.

Edit a schema

2. Update the Schema Name so you can tell the difference between this updated version and the original one. For this example, I will rename it Business Communicators Association With Designation. Then click Publish after you've edited all of the fields.

3. The schema copy has been created.

See the new schema version

View a Credential Schema

To view the fields on the credential, go to Schemas, click on the three dots of the credential you want to view, and click View schema.

View the schema details

Delete a Credential Schema

1. Go to schema, click on the three dots of the credential you want to delete, and click Delete schema.

Delete a schema

2. Confirm the deletion

Confirm the schema deletion

Issuing With the Custom Credential Schema Without a Custom Design 

1. You can start issuing with your custom credential schema in these two ways:

a) Go to schemas, click on the three dots of the schema you want to issue with, and select Issue with this.

Select "issue with this" from the schema you want to use.

Then click Continue without design.

Select continue without design

b) The other option is to go to Credentials, click on Issue Credentials, then select one of your custom schemas, and select Continue without design

Select "Issue Credentials"

Select continue without design

3. Select which credential features you want to include. See this full Issuer Guide for more details on each of these features. For this example, I am choosing these options: 

  • Persisting credential: Access the credential through a URL or QR code
  • Issuer profile (DID): Issue the credential from the Business Communicators Association credential profile
  • Generate PDF
  • Use Dock BBS+: Turns on advanced privacy features that allow recipients to choose which specific data on their credential they want to present to verifiers instead of presenting the whole credential (e.g. presenting their license number and university degree but not their personal email address and date of birth)
Select the custom verifiable credential features you want

4. Once you’ve selected your credential features, you select Add Manually

Select "Add manually" to start adding Verifiable Credential recipients

5. Now you will see the credential fields you set up in the custom schema. Fill in the details and select Add Recipient.

Add recipient details

6. You will see the recipient has been added and select Issue Credentials.

Select "Issue Credentials" once the recipients have been added

7. Select Download Credentials

Select "Download Credentials"

8. If you chose to generate a PDF version of the credential, you can view it after you download the credentials

This is the PDF format of the custom Verifiable Credential

Issuing Custom Schemas With a Custom Design

You can make a custom design for your custom schema with the Designer tool. Click here to see the full guide on how to use all of the features of the Designer tool.

1. Go to Credentials and select Issue Credentials

Select "Issue Credentials"

2. Select the schema you want to use. For this case, we will choose the custom credential we created.

Choose the Verifiable Credential template you want to use

3. Select Create new design

Select "Create new design"

4. To add the fields from your custom credential, click on Attributes and click on Add custom attribute.

Start adding fields to your credential by selecting "Attributes" and 'Add custom attribute"

5. Select your custom credential schema

Choose the custom Verifiable Credential template

6. Select each field one by one

Add each credential field one by one

7. Format each field the way you want it to appear on the credential by changing the font, size, and color. 

Custom Verifiable Credential design

8. When you’re done, select Save & Issue on the top right.

Select "Save & Issue" on the top right

9. Follow the usual issuance steps. Click here for the full issuer guide

Verifiable Credential details

10. Select the credential features you want (PDF, access via URL etc.) and select Issue Credentials.

Select "Issue Credentials"

11. PDF view of the custom designed credential

PDF version of the credential with the custom design