Create Status List v2021
Create Status List 2021 Resource on cheqd.
Users are able to create Verifiable Credential Status List v2021 entries on-ledger, in order to revoke or suspend Verifiable Credentials. This is a derivation from the core spec made by cheqd to support a more decentralized and resilient approach to storing Status Lists.
Step 1: Set up your account
Make sure you have set up your account with cheqd Studio and are logged in, using our guide below:
Step 2: Create a DID
Before you can create a Status List, you need to create a DID which is used to link the Status List on-ledger. Use the API in the page below to create a DID:
Step 3: Select the unencrypted Status List API
When creating a Status List, a user will have the following options:
For the purpose of this tutorial, we will assume the user is creating an unencrypted Status List. For encrypted Status Lists, follow the tutorial here.
Step 4: Create unencrypted Status List
Using the /credential-status/create/unencrypted
API, users have two options for creating an encrypted Status List on-ledger:
Filling out a simple form using the
application/x-www-url-form-encoded
option within an API client of your choice.Compiling a Status List payload yourself using the
application/json
option within an API client of your choice.
Create an unencrypted StatusList2021 credential status list.
This endpoint creates an unencrypted StatusList2021 credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted; and with purpose as either revocation or suspension.
DID of the StatusList2021 publisher.
The name of the StatusList2021 DID-Linked Resource to be created.
The length of the status list to be created. The default and minimum length is 140000 which is 16kb.
The encoding format of the StatusList2021 DiD-Linked Resource to be created.
Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.
Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.
The request was successful.
true
Option 1. Choose from a few variables and we will compile the Status List for you
This is the easiest way to create unencrypted Status Lists on cheqd and is recommended for users who are not overly familiar with compiling JSON objects.
Using the application/x-www-url-form-encoded
option, users are able to choose between the following variables and options to create an unencrypted Status List on-ledger:
Option 2. Publish a JSON payload yourself
Instead of using simple form variables, you can create an encrypted Status List using a JSON payload yourself using the application/json
option on the Swagger UI.
Request format
An example of the JSON payload needed to be submitted is below:
Step 5: Hit the API
Once the Issuer has populated the requisite information for the unencrypted Status List request, they can use the API below to submit it to the ledger.
Create an unencrypted StatusList2021 credential status list.
This endpoint creates an unencrypted StatusList2021 credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted; and with purpose as either revocation or suspension.
DID of the StatusList2021 publisher.
The name of the StatusList2021 DID-Linked Resource to be created.
The length of the status list to be created. The default and minimum length is 140000 which is 16kb.
The encoding format of the StatusList2021 DiD-Linked Resource to be created.
Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.
Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.
The request was successful.
true
Last updated