1 of 7

Issue Credentials and Presentations

Learn how to issue and manage Verifiable Credentials and Presentations.

Verifiable Credentials are a tamper-evident data format for asserting a set of claims about a subject. You can issue and verify Verifiable Credentials and Presentations without building complex integrations, using our simple cheqd Studio APIs.

Learn about Verifiable Credentials and Presentations

If you want to learn more about what Verifiable Credentials and Presentations are, please go over to our learning site here.

What options do I have for issuing credentials anchored on cheqd?

There are many different ways to issue verifiable credentials signed by DIDs anchored on cheqd, with options for easy integration (e.g. cheqd Studio) and more bespoke integrations (e.g. Credo and Veramo). Below are a list of options for issuing credentials with cheqd underneath:

Partner SaaS products

You can use SaaS products from our partners to create best-in-class credential ecosystems, built on cheqd

Get started with cheqd Studio

Make sure you've set up your account with cheqd Studio, then you can start to:

Supported Credential types

cheqd supports all four major digital Credential types via its selection of SDKs and APIs. Below you can learn about these Credential formats:

Credential Coverage

Depending on what type of credentials you want to use, choose the SDK that suits your tech stack:

Issue Credential

Issue conformant W3C Verifiable Credentials over REST API

Using the /credential/create API, it is possible to issue Verifiable Credentials, signed by a cheqd DID, in a few clicks or lines of code.

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 an Issuer DID

Before you can issue a Verifiable Credential, you need to create an Issuer DID which is used to sign the Credential payload. Use the API in the page below to create an Issuer DID:

(Optional) Step 3: Create a Subject DID

Again, before you issue a Verifiable Credential, you need to know to whom you are issuing it. If you need to create a Subject DID, you can take a look at the page here:

Step 4: Compile your Credential body

Within the JSON object of the API request, you will need to input the issuer and subject information, as well as the attributes which you want to issue in the Credential. You may also want to add additional fields such as a credentialSchema.

Users have two options for compiling the Credential bodies and issuing Verifiable Credentials:

Filling out a simple form using the application/x-www-url-form-encoded option within an API client of your choice.
Compiling a Credential body yourself using the application/json option within an API client of your choice.

Option 1. Choose from a few variables and we will compile the Credential body for you

This is the easiest way to issue Credentials 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 issue Verifiable Credentials:

issuerDid (required)

subjectDid (required)

attributes (required)

credentialSchema (required for Verida wallet)

This is the Schema which the Credential body takes the form of. For the Verida wallet, to display a credential, it needs to have a schema associated with it.

@context (optional)

type (optional)

expirationDate (optional)

format (optional)

Format of the Verifiable Credential. Defaults to VC-JWT.

jwt (VC-JWT)
lds (JSON-LD)

credentialStatus (optional)

credentialStatus properties for VC revocation or suspension. Takes statusListName and statusListPurpose as inputs. If you have already created a Status List, you can include the same inputs here to map this issued credential within the created bitstring.

Additional options for specifying credentialStatus bitstring index

Below are a set of examples of alternative input parameters for users to specify the bitstring index of the issued Credential. The bitstring index is where exactly the issued credential will map to within the Status List. This should be noted and stored by the issuer to keep a record of which issued credentials are active, revoked or suspended:

Example Request Format: Random Bitstring index

Example Request Format: Specified Bitstring index

Example Request Format: Bitstring index within a given range

Example Request Format: Bitstring including omitted bits

Ensure that the "statusPurpose" and "statusListName" is the same as the existing Status List on-ledger.

Option 2. Publish a JSON payload yourself

Instead of using simple form variables, you can issue a Verifiable Credential using a JSON payload with the application/json option.

Request format

Below is an example of the request format for issuing a Verifiable Credential using a custom JSON payload, including some of the possible parameters:

Step 5: Issue a Credential using the API below

Execute the API below to issue a Verifiable Credential, signed by your issuer DID.

Alternatives

Below are a list of alternatives for using Credentials with cheqd support. Each offers a different set of protocols and underlying technical capabilities.

Setup Verida Wallet

Setup your wallet to receive credentials.

cheqd Studio currently is setup to work with the Verida Wallet. In 2024, we will be building compatibility with a full suite of other digital identity wallets.

Verida Wallet

Subject DID

On the "Profile" tab, you will see your did:vda address under the section "DID".

For example: "did:vda:testnet:0xD7477C4a75143Af16A967381d09650A533Bd0DD7"

Rendering credentials

Credentials stored with the credential schema will automatically be rendered in the Verida Wallet as a credential. This custom display includes:

A scannable QR code
The profile icon of the Verida DID that issued / signed the credential
A tick of approval indicating the credential has been verified

Verify Credential

Verify a Credential using cheqd Studio.

Once you have issued your credential and have a JWT as part of the credential proof, you can use the /credential/verify API to check that the JWT has not been tampered.

Step 1: Obtain Credential to Verify

To verify a Credential, you can either pass the full Credential body or the JWT proof. These can be either obtained from a Credential that has been issued or from a Verifiable Presentation presented to the user.

Step 2: Configure Verification Parameters

The user is able to set verification parameters to filter whether they want to verify certain aspects of a Credential, including:

verifyStatus

true (indicates that the user wants to verify the Credential Status, requiring a credentialStatus property to be present in the Credential)
false (Default. Indicates that the user does not want to verify the Credential Status.

fetchRemoteContexts

When dealing with JSON-LD type Verifiable Credentials you also MUST provide the proper contexts within a Credential body. Set this to true ONLY if you want the @context URLs to be fetched in case they are a custom context.

true
false (default)

Step 3: Pass the Credential to the API

Simply paste the JWT or the full credential body into the request field of the /credential/verify API, and the API will give you a response including the following verification policies:

Whether the Credential has been tampered
Whether the Credential has a valid issuance date
Whether the Credential has expired
Whether the Credential Status is valid

Verify Presentation

Verify presentations on cheqd Studio.

A Verifiable Presentation is a collection of multiple Verifiable Credentials that are being presented by a holder to a verifier. In addition to checking whether the Credentials are untampered, Verifiable Presentation verification also checks that the holder subject DID is valid.

Step 1: Obtain Presentation to Verify

To verify a Credential, you can either pass the full VP-JWT string or a JSON object. These can be either obtained from a Verifiable Presentation presented to the user.

Step 2: Configure Verification Parameters

The user is able to set verification parameters to filter whether they want to verify certain aspects of a Presentation, including:

verifyStatus

true (indicates that the user wants to verify the Credential Statuses within the Presentatiuon, requiring a credentialStatus property to be present in at least one Credential within the Presentation)
false (Default. Indicates that the user does not want to verify the Credential Status.

fetchRemoteContexts

true
false (default)

Step 3: Execute the API

Use the API below to verify a Presentation

Revoke Credential

Using cheqd's innovative DID-Linked Resource module, cheqd is able to support decentralized and scalable Verifiable Credential revocation and suspension. Using this API, the user is able to choose whether they would like to publish the revocation status to the cheqd ledger or elsewhere.

Step 1: Locate the Credential Body or JWT to be revoked

It is best practice for issuers to keep a record of the Credentials they have issued, including the "statusListIndex" of the Credentials. From this record system, issuers should be able to fetch either the full Credential Body or the JWT proof of the Credential they want to revoke.

Step 2: Decide whether to publish update to the ledger

When revoking a Credential, issuers can decide whether they want to publish an updated Status List on-ledger, with the revoked credential index updated in the bitstring. The parameter below can be changed to reflect this:

publish

true (indicates the issuer wants to publish the updated Status List on ledger)
false (indicates the issuer wants to manually publish a Status List update)

Step 3: Paste the Credential Body or JWT into the API

Paste the Credential Body or JWT into the API below and execute the API to revoke the Credential.

Suspend or Unsuspend Credential

Users are also able to suspend Verifiable Credentials. The difference between revocation and suspension is that suspended Credentials may be unsuspended at a future date; whereas, revoked credentials are permanently revoked.

Step 1: Locate the Credential Body or JWT to be suspended

Step 2: Decide whether to publish update to the ledger

When suspending a Credential, issuers can decide whether they want to publish an updated Status List on-ledger, with the suspended credential index updated in the bitstring. The parameter below can be changed to reflect this:

publish

true (indicates the issuer wants to publish the updated Status List on ledger)
false (indicates the issuer wants to manually publish a Status List update)

Step 3: Paste the Credential Body or JWT into the API

Paste the Credential Body or JWT into the API below and execute the API to suspend the Credential.

Unsuspend (reinstate) Verifiable Credentials

If a Credential has been suspended, and an Issuer wants to unsuspend the Credential to make it once again valid, the Issuer can reinstate a suspended Credential.

Step 1: Locate the Credential Body or JWT to be unsuspended

Step 2: Decide whether to publish update to the ledger

When unsuspending or reinstating a Credential, issuers can decide whether they want to publish an updated Status List on-ledger, with the unsuspended credential index updated in the bitstring. The parameter below can be changed to reflect this:

publish

true (indicates the issuer wants to publish the updated Status List on ledger)
false (indicates the issuer wants to manually publish a Status List update)

Step 3: Paste the Credential Body or JWT into the API

Paste the Credential Body or JWT into the API below and execute the API to unsuspend the Credential.

Verify Credential

Verify a Credential using cheqd Studio.

Once you have issued your credential and have a JWT as part of the credential proof, you can use the /credential/verify API to check that the JWT has not been tampered.

Step 1: Obtain Credential to Verify

Step 2: Configure Verification Parameters

The user is able to set verification parameters to filter whether they want to verify certain aspects of a Credential, including:

verifyStatus

true (indicates that the user wants to verify the Credential Status, requiring a credentialStatus property to be present in the Credential)
false (Default. Indicates that the user does not want to verify the Credential Status.

fetchRemoteContexts

true
false (default)

Step 3: Pass the Credential to the API

Simply paste the JWT or the full credential body into the request field of the /credential/verify API, and the API will give you a response including the following verification policies:

Whether the Credential has been tampered
Whether the Credential has a valid issuance date
Whether the Credential has expired
Whether the Credential Status is valid

Verify a Verifiable Credential.

This endpoint verifies a Verifiable Credential passed to it. As input, it can take the VC-JWT as a string or the entire credential itself.

POST/credential/verify

Query parameters

verifyStatusboolean

If set to true the verification will also check the status of the credential. Requires the VC to have a credentialStatus property.

fetchRemoteContextsboolean

When dealing with JSON-LD you also MUST provide the proper contexts. Set this to true ONLY if you want the @context URLs to be fetched in case they are a custom context.

allowDeactivatedDidboolean

If set to true allow to verify credential which based on deactivated DID.

Body

credentialobject

Verifiable Credential to be verified as a VC-JWT string or a JSON object.

policiesobject

Custom verification policies to execute when verifying credential.

issuanceDateboolean

Policy to skip the issuanceDate (nbf) timestamp check when set to false.

expirationDateboolean

Policy to skip the expirationDate (exp) timestamp check when set to false.

audienceboolean

Policy to skip the audience check when set to false.

Response

The request was successful.

Body

verifiedboolean

issuerstring

signerobject

jwtstring

verifiableCredentialobject

Request

const response = await fetch('/credential/verify', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "verified": true,
  "polices": {},
  "issuer": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
  "signer": {
    "controller": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
    "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#key-1",
    "publicKeyBase58": "BTJiso1S4iSiReP6wGksSneGfiKHxz9SYcm2KknpqBJt",
    "type": "Ed25519VerificationKey2018"
  }
}

Issue Credential

Issue conformant W3C Verifiable Credentials over REST API

Using the /credential/create API, it is possible to issue Verifiable Credentials, signed by a cheqd DID, in a few clicks or lines of code.

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 an Issuer DID

Before you can issue a Verifiable Credential, you need to create an Issuer DID which is used to sign the Credential payload. Use the API in the page below to create an Issuer DID:

(Optional) Step 3: Create a Subject DID

Again, before you issue a Verifiable Credential, you need to know to whom you are issuing it. If you need to create a Subject DID, you can take a look at the page here:

Step 4: Compile your Credential body

Users have two options for compiling the Credential bodies and issuing Verifiable Credentials:

Filling out a simple form using the application/x-www-url-form-encoded option within an API client of your choice.
Compiling a Credential body yourself using the application/json option within an API client of your choice.

Option 1. Choose from a few variables and we will compile the Credential body for you

This is the easiest way to issue Credentials 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 issue Verifiable Credentials:

issuerDid (required)

This is the DID of the Credential issuer, created in . This needs to be a did:cheqd DID. For example:

did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0

subjectDid (required)

This is the DID of the Credential subject, created in . This needs to be a did:key or did:vda DID. For example:

did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK

attributes (required)

These are the claims or attributes attested to within the Verifiable Credential. This must be a JSON object, following the . For example:

{
  "name": "Bob",
  "gender": "male"
}

credentialSchema (required for Verida wallet)

This is the Schema which the Credential body takes the form of. For the Verida wallet, to display a credential, it needs to have a schema associated with it.

https://common.schemas.verida.io/health/pathology/tests/covid19/pcr/v0.1.0/schema.json

@context (optional)

This is an optional property that defines semantic information about the Credential, conforming to the . For example:

https://www.w3.org/2018/credentials/v1

type (optional)

This is an optional property that defines information about the type of Verifiable Credential, conforming to the . For example:

VerifiableCredential

expirationDate (optional)

This is an optional property that defines information about the expiration date of a Verifiable Credential, conforming to the . For example:

2023-06-08T13:49:28.000Z

format (optional)

Format of the Verifiable Credential. Defaults to VC-JWT.

jwt (VC-JWT)
lds (JSON-LD)

credentialStatus (optional)

Note that this is the same for and for . For example:

{
  "statusPurpose": "revocation",
  "statusListName": "employee-credentials"
}

Additional options for specifying credentialStatus bitstring index

Example Request Format: Random Bitstring index

{
  "statusPurpose": "revocation",
  "statusListName": "employee-credentials"
}

Example Request Format: Specified Bitstring index

{
  "statusPurpose": "revocation",
  "statusListName": "employee-credentials",
  "statusListIndex": 1543
}

Example Request Format: Bitstring index within a given range

{
  "statusPurpose": "revocation",
  "statusListName": "employee-credentials"
  "statusListRangeStart": 1000,
  "statusListRangeEnd": 2000
}

Example Request Format: Bitstring including omitted bits

{
  "statusPurpose": "revocation",
  "statusListName": "employee-credentials"
  "statusListRangeStart": 1000,
  "statusListRangeEnd": 2000,
  "indexNotIn": 1001. 1264. 1268, 1854
}

Ensure that the "statusPurpose" and "statusListName" is the same as the existing Status List on-ledger.

Option 2. Publish a JSON payload yourself

Instead of using simple form variables, you can issue a Verifiable Credential using a JSON payload with the application/json option.

Request format

Below is an example of the request format for issuing a Verifiable Credential using a custom JSON payload, including some of the possible parameters:

{
  "issuerDid": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
  "subjectDid": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK",
  "attributes": {
    "gender": "male",
    "name": "Bob"
  },
  "@context": [
    "https://schema.org"
  ],
  "type": [
    "Person"
  ],
  "credentialSchema": "https://common.schemas.verida.io/identity/kyc/FinClusive/individual-basic/v0.1.0/schema.json",
  "format": "jwt",
  "credentialStatus": {
    "statusPurpose": "revocation",
    "statusListName": "employee-credentials",
    "statusListIndex": 10
  }
}

Step 5: Issue a Credential using the API below

Execute the API below to issue a Verifiable Credential, signed by your issuer DID.

Alternatives

Below are a list of alternatives for using Credentials with cheqd support. Each offers a different set of protocols and underlying technical capabilities.

Issue a Verifiable Credential

This endpoint issues a Verifiable Credential. As input it takes the list of issuerDid, subjectDid, attributes, and other parameters of the credential to be issued.

POST/credential/issue

Body

issuerDid*string

DID of the Verifiable Credential issuer. This needs to be a did:cheqd DID.

Example: "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

subjectDid*string

DID of the Verifiable Credential holder/subject. This needs to be a did:key DID.

Example: "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"

attributes*object

JSON object containing the attributes to be included in the credential.

@contextarray of string

Optional properties to be included in the @context property of the credential.

itemsstring

typearray of string

Optional properties to be included in the type property of the credential.

itemsstring

expirationDatestring (date-time)

Optional expiration date according to the <a href=https://www.w3.org/TR/vc-data-model/#expiration> VC Data Model specification.

Example: "2023-06-08T13:49:28.000Z"

formatenum

Format of the Verifiable Credential. Defaults to VC-JWT.

Example: "jwt"

jwtjsonld

credentialStatusobject

Optional credentialStatus properties for VC revocation or suspension. Takes statusListName and statusListPurpose as inputs.

statusPurpose*enum

revocationsuspension

statusListName*string

statusListIndexnumber

statusListVersionstring (date-time)

statusListRangeStartnumber

statusListRangeEndnumber

indexNotInnumber

termsOfUsearray of object

Terms of use can be utilized by an issuer or a holder to communicate the terms under which a verifiable credential was issued.

refreshServicearray of object

RefreshService property MUST be one or more refresh services that provides enough information to the recipient's software such that the recipient can refresh the verifiable credential.

evidencearray of object

Evidence property MUST be one or more evidence schemes providing enough information for a verifier to determine whether the evidence gathered by the issuer meets its confidence requirements for relying on the credential.

Response

The request was successful.

Body

@contextarray of string

itemsstring

typearray of string

itemsstring

expirationDatestring (date-time)

Example: "2023-06-08T13:49:28.000Z"

issuerobject

idstring (DID)

Example: "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

credentialSubjectobject

idstring (DID)

Example: "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"

credentialStatusobject

idstring

Example:

"https://resolver.cheqd.net/1.0/identifiers/did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-suspension-1&resourceType=StatusList2021Suspension#20"

statusListIndexnumber

Example: 20

statusPurposeenum

Example: "suspension"

revocationsuspension

typeenum

StatusList2021Entry

issuanceDatestring (date-time)

Example: "2023-06-08T13:49:28.000Z"

proofobject

typestring

jwtstring

Request

Response

Issue a Verifiable Credential

This endpoint issues a Verifiable Credential. As input it takes the list of issuerDid, subjectDid, attributes, and other parameters of the credential to be issued.

POST/credential/issue

Body

issuerDid*string

DID of the Verifiable Credential issuer. This needs to be a did:cheqd DID.

Example: "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

subjectDid*string

DID of the Verifiable Credential holder/subject. This needs to be a did:key DID.

Example: "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"

attributes*object

JSON object containing the attributes to be included in the credential.

@contextarray of string

Optional properties to be included in the @context property of the credential.

itemsstring

typearray of string

Optional properties to be included in the type property of the credential.

itemsstring

expirationDatestring (date-time)

Optional expiration date according to the <a href=https://www.w3.org/TR/vc-data-model/#expiration> VC Data Model specification.

Example: "2023-06-08T13:49:28.000Z"

formatenum

Format of the Verifiable Credential. Defaults to VC-JWT.

Example: "jwt"

jwtjsonld

credentialStatusobject

Optional credentialStatus properties for VC revocation or suspension. Takes statusListName and statusListPurpose as inputs.

statusPurpose*enum

revocationsuspension

statusListName*string

statusListIndexnumber

statusListVersionstring (date-time)

statusListRangeStartnumber

statusListRangeEndnumber

indexNotInnumber

termsOfUsearray of object

Terms of use can be utilized by an issuer or a holder to communicate the terms under which a verifiable credential was issued.

refreshServicearray of object

RefreshService property MUST be one or more refresh services that provides enough information to the recipient's software such that the recipient can refresh the verifiable credential.

evidencearray of object

Response

The request was successful.

Body

@contextarray of string

itemsstring

typearray of string

itemsstring

expirationDatestring (date-time)

Example: "2023-06-08T13:49:28.000Z"

issuerobject

idstring (DID)

Example: "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

credentialSubjectobject

idstring (DID)

Example: "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"

credentialStatusobject

idstring

Example:

"https://resolver.cheqd.net/1.0/identifiers/did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-suspension-1&resourceType=StatusList2021Suspension#20"

statusListIndexnumber

Example: 20

statusPurposeenum

Example: "suspension"

revocationsuspension

typeenum

StatusList2021Entry

issuanceDatestring (date-time)

Example: "2023-06-08T13:49:28.000Z"

proofobject

typestring

jwtstring

Request

Response

Verify Presentation

Verify presentations on cheqd Studio.

Step 1: Obtain Presentation to Verify

To verify a Credential, you can either pass the full VP-JWT string or a JSON object. These can be either obtained from a Verifiable Presentation presented to the user.

Step 2: Configure Verification Parameters

The user is able to set verification parameters to filter whether they want to verify certain aspects of a Presentation, including:

verifyStatus

true (indicates that the user wants to verify the Credential Statuses within the Presentatiuon, requiring a credentialStatus property to be present in at least one Credential within the Presentation)
false (Default. Indicates that the user does not want to verify the Credential Status.

fetchRemoteContexts

true
false (default)

Step 3: Execute the API

Use the API below to verify a Presentation

Verify a Verifiable Presentation generated from credential(s).

This endpoint verifies the Verifiable Presentation generated from credential(s). As input, it can take the Verifiable Presentation JWT as a string or the entire Verifiable Presentation itself.

POST/presentation/verify

Query parameters

verifyStatusboolean

If set to true the verification will also check the status of the presentation. Requires the VP to have a credentialStatus property.

fetchRemoteContextsboolean

When dealing with JSON-LD you also MUST provide the proper contexts. * Set this to true ONLY if you want the @context URLs to be fetched in case they are a custom context.

allowDeactivatedDidboolean

If set to true allow to verify credential which based on deactivated DID.

Body

presentation*object

Verifiable Presentation to be verified as a VP-JWT string or a JSON object.

verifierDidstring

Provide an optional verifier DID (also known as 'domain' parameter), if the verifier DID in the presentation is not managed in the wallet.

makeFeePaymentboolean

Automatically make fee payment (if required) based on payment conditions to unlock encrypted StatusList2021 DID-Linked Resource.

policiesobject

Custom verification policies to execute when verifying presentation.

issuanceDateboolean

Policy to skip the issuanceDate (nbf) timestamp check when set to false.

expirationDateboolean

Policy to skip the expirationDate (exp) timestamp check when set to false.

audienceboolean

Policy to skip the audience check when set to false.

Response

The request was successful.

Body

verifiedboolean

issuerstring

signerobject

jwtstring

verifiableCredentialobject

Request

Response

Issue a Verifiable Credential

This endpoint issues a Verifiable Credential. As input it takes the list of issuerDid, subjectDid, attributes, and other parameters of the credential to be issued.

POST/credential/issue

Body

issuerDid*string

DID of the Verifiable Credential issuer. This needs to be a did:cheqd DID.

Example: "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

subjectDid*string

DID of the Verifiable Credential holder/subject. This needs to be a did:key DID.

Example: "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"

attributes*object

JSON object containing the attributes to be included in the credential.

@contextarray of string

Optional properties to be included in the @context property of the credential.

itemsstring

typearray of string

Optional properties to be included in the type property of the credential.

itemsstring

expirationDatestring (date-time)

Optional expiration date according to the <a href=https://www.w3.org/TR/vc-data-model/#expiration> VC Data Model specification.

Example: "2023-06-08T13:49:28.000Z"

formatenum

Format of the Verifiable Credential. Defaults to VC-JWT.

Example: "jwt"

jwtjsonld

credentialStatusobject

Optional credentialStatus properties for VC revocation or suspension. Takes statusListName and statusListPurpose as inputs.

statusPurpose*enum

revocationsuspension

statusListName*string

statusListIndexnumber

statusListVersionstring (date-time)

statusListRangeStartnumber

statusListRangeEndnumber

indexNotInnumber

termsOfUsearray of object

Terms of use can be utilized by an issuer or a holder to communicate the terms under which a verifiable credential was issued.

refreshServicearray of object

RefreshService property MUST be one or more refresh services that provides enough information to the recipient's software such that the recipient can refresh the verifiable credential.

evidencearray of object

Response

The request was successful.

Body

@contextarray of string

itemsstring

typearray of string

itemsstring

expirationDatestring (date-time)

Example: "2023-06-08T13:49:28.000Z"

issuerobject

idstring (DID)

Example: "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

credentialSubjectobject

idstring (DID)

Example: "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"

credentialStatusobject

idstring

Example:

"https://resolver.cheqd.net/1.0/identifiers/did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-suspension-1&resourceType=StatusList2021Suspension#20"

statusListIndexnumber

Example: 20

statusPurposeenum

Example: "suspension"

revocationsuspension

typeenum

StatusList2021Entry

issuanceDatestring (date-time)

Example: "2023-06-08T13:49:28.000Z"

proofobject

typestring

jwtstring

Request

Response

Issue a Verifiable Credential

This endpoint issues a Verifiable Credential. As input it takes the list of issuerDid, subjectDid, attributes, and other parameters of the credential to be issued.

POST/credential/issue

Body

issuerDid*string

DID of the Verifiable Credential issuer. This needs to be a did:cheqd DID.

Example: "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

subjectDid*string

DID of the Verifiable Credential holder/subject. This needs to be a did:key DID.

Example: "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"

attributes*object

JSON object containing the attributes to be included in the credential.

@contextarray of string

Optional properties to be included in the @context property of the credential.

itemsstring

typearray of string

Optional properties to be included in the type property of the credential.

itemsstring

expirationDatestring (date-time)

Optional expiration date according to the <a href=https://www.w3.org/TR/vc-data-model/#expiration> VC Data Model specification.

Example: "2023-06-08T13:49:28.000Z"

formatenum

Format of the Verifiable Credential. Defaults to VC-JWT.

Example: "jwt"

jwtjsonld

credentialStatusobject

Optional credentialStatus properties for VC revocation or suspension. Takes statusListName and statusListPurpose as inputs.

statusPurpose*enum

revocationsuspension

statusListName*string

statusListIndexnumber

statusListVersionstring (date-time)

statusListRangeStartnumber

statusListRangeEndnumber

indexNotInnumber

termsOfUsearray of object

Terms of use can be utilized by an issuer or a holder to communicate the terms under which a verifiable credential was issued.

refreshServicearray of object

RefreshService property MUST be one or more refresh services that provides enough information to the recipient's software such that the recipient can refresh the verifiable credential.

evidencearray of object

Response

The request was successful.

Body

@contextarray of string

itemsstring

typearray of string

itemsstring

expirationDatestring (date-time)

Example: "2023-06-08T13:49:28.000Z"

issuerobject

idstring (DID)

Example: "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

credentialSubjectobject

idstring (DID)

Example: "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"

credentialStatusobject

idstring

Example:

"https://resolver.cheqd.net/1.0/identifiers/did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-suspension-1&resourceType=StatusList2021Suspension#20"

statusListIndexnumber

Example: 20

statusPurposeenum

Example: "suspension"

revocationsuspension

typeenum

StatusList2021Entry

issuanceDatestring (date-time)

Example: "2023-06-08T13:49:28.000Z"

proofobject

typestring

jwtstring

Request

Response