Create Status List
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.
Make sure you have set up your account with Credential Service and are logged in, using our guide below:
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:
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.
Using the
/credential-status/create/unencrypted
API, users have two options for creating an encrypted Status List on-ledger:- 1.Filling out a simple form using the
application/x-www-url-form-encoded
option on the Swagger UI. - 2.Compiling a Status List payload yourself using the
application/json
option on the Swagger UI.
post
/credential-status/create/unencrypted
Create an unencrypted StatusList2021 credential status list.
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 on the Swagger UI, users are able to choose between the following variables and options to create an unencrypted Status List on-ledger:Enter the Decentralized Identifier (DID) of the Status List publisher created in Step 2. For example:
did:cheqd:testnet:0ff9df5d-653b-4f77-a66c-0035abc34d63
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. An example of the JSON payload needed to be submitted is below:
{
"did": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
"statusListName": "cheqd-employee-credentials",
"length": 140000,
"encoding": "base64url"
}
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.
post
/credential-status/create/unencrypted
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.
Parameters
Query
statusPurpose*
string
The purpose of the status list. Can be either revocation or suspension. Once this is set, it cannot be changed. A new status list must be created to change the purpose.
Body
Example
Schema
{
"did": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
"statusListName": "cheqd-employee-credentials",
"length": 140000,
"encoding": "base64url"
}
application/x-www-form-urlencoded
Responses
200: OK
The request was successful.
400: Bad Request
A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
401: Unauthorized
Access token is missing or invalid
500: Internal Server Error
An internal error has occurred. Additional state information plus metadata may be available in the response body.
Last modified 24d ago