Create Verifier Pays Issuer flow

How a Verifier pays an Issuer to decrypt an encrypted Status List.

cheqd Studio supports payments for verifying Credential Status. This is an innovative feature that is also commonly known as cheqd's Payment Rails. Using the API in this tutorial, there are multiple ways for a Verifier to pay an Issuer to unlock and verify a Credential's status.

Step 1: Set up an account

A Verifier will need a cheqd Studio account to take advantage of the /credential-status/check API and easily use cheqd's Credential Payments. Make sure you are set up and are logged in, using our guide below:

Set Up Your Account

Set up your account with cheqd Studio and log in to start using the APIs.

Step 2: Set parameters for check

Using the /credential-status/check API, users have two options for checking whether a particular Credential index is revoked or suspended:

1. Filling out a simple form using the application/x-www-url-form-encoded option on the Swagger UI.

2. Compiling the JSON transaction yourself using the application/json option on the Swagger UI.

This is the easiest way to check whether a particular credential index is revoked or suspended.

Check a StatusList2021 or BitstringStatusList index for a given Verifiable Credential.

post

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/credential-status/check

This endpoint checks a StatusList2021 or BitstringStatusList index for a given Verifiable Credential and reports whether it is revoked or suspended. It offers a standalone method for checking an index without passing the entire Verifiable Credential or Verifiable Presentation.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

listTypestring · enumRequired

The type of Status List.

Possible values:

statusPurposestring · enumRequired

The purpose of the status list. Can be either revocation or suspension.

Possible values:

Body

application/x-www-form-urlencodedapplication/json

didstring · uriRequired

DID of the StatusList2021 publisher.

statusListNamestringRequired

The name of the StatusList2021 DID-Linked Resource to be checked.

indexintegerOptional

Credential status index to be checked for revocation or suspension.

indicesinteger[]Optional

List of credential status indices to be checked for revocation or suspension.

indexRangeStartintegerOptional

Start of the credential status index range to be checked for revocation or suspension.

indexRangeEndintegerOptional

End of the credential status index range to be checked for revocation or suspension.

statusListCredentialstringOptional

Optional Resolvable DID URL of the BitstringStatusList credential to be checked.

statusSizenumberOptional

Optional size of the BitstringStatusList.

Default: 2

statusMessagearrayOptional

Array of status messages for each bit in the BitstringStatusList.

makeFeePaymentbooleanOptional

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

Default: true

Responses

200

The request was successful.

application/json

Responseone of

or

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

post

/credential-status/check

HTTPcURLJavaScriptPython

POST /credential-status/check?listType=StatusList2021&statusPurpose=revocation HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 201

"did='https://example.com'&statusListName='text'&index=1&indices=[1]&indexRangeStart=1&indexRangeEnd=1&statusListCredential='text'&statusSize=2&statusMessage=[]&makeFeePayment=true"

application/x-www-form-urlencodedapplication/json

{
  "checked": true,
  "revoked": false
}

Using the application/x-www-url-form-encoded option on the Swagger UI, users are able to choose between the following variables to compile your DID:

statusPurpose

The purpose of the status list that has already been created on-ledger. Can be:

• revocation

• suspension

did

DID of the StatusList2021 publisher, or the DID linked to the Status List resources. For example:

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

statusListName

The name of the existing Status List resource to be checked. For example:

employmentCredentialRevocationList

index

The index within the bitstring that the user wants to query. For example:

10

Option 1: Automatically paying an Issuer to unlock a Credential Status

To automatically make a payment to an Issuer in order to verify an encrypted Status List, there is an additional variable:

makeFeePayment

This will automatically make the fee payment to the issuer (if required) based on payment conditions to unlock encrypted StatusList2021 DID-Linked Resource. This can be set to:

• true (automatically make fee payment)

• false (do not automatically make fee payment)

If there is sufficient CHEQ in the account of the Verifier, this will automatically make a payment to the Issuer and meet the Access Control Conditions.

Step 3: Hit the API

In the same action, the Credential Service will perform a verification check on the Credential Status and pay the issuer the fee specified in the Payment Conditions.

Check a StatusList2021 or BitstringStatusList index for a given Verifiable Credential.

post

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/credential-status/check

This endpoint checks a StatusList2021 or BitstringStatusList index for a given Verifiable Credential and reports whether it is revoked or suspended. It offers a standalone method for checking an index without passing the entire Verifiable Credential or Verifiable Presentation.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

listTypestring · enumRequired

The type of Status List.

Possible values:

statusPurposestring · enumRequired

The purpose of the status list. Can be either revocation or suspension.

Possible values:

Body

application/x-www-form-urlencodedapplication/json

didstring · uriRequired

DID of the StatusList2021 publisher.

statusListNamestringRequired

The name of the StatusList2021 DID-Linked Resource to be checked.

indexintegerOptional

Credential status index to be checked for revocation or suspension.

indicesinteger[]Optional

List of credential status indices to be checked for revocation or suspension.

indexRangeStartintegerOptional

Start of the credential status index range to be checked for revocation or suspension.

indexRangeEndintegerOptional

End of the credential status index range to be checked for revocation or suspension.

statusListCredentialstringOptional

Optional Resolvable DID URL of the BitstringStatusList credential to be checked.

statusSizenumberOptional

Optional size of the BitstringStatusList.

Default: 2

statusMessagearrayOptional

Array of status messages for each bit in the BitstringStatusList.

makeFeePaymentbooleanOptional

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

Default: true

Responses

200

The request was successful.

application/json

Responseone of

or

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

post

/credential-status/check

HTTPcURLJavaScriptPython

POST /credential-status/check?listType=StatusList2021&statusPurpose=revocation HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 201

"did='https://example.com'&statusListName='text'&index=1&indices=[1]&indexRangeStart=1&indexRangeEnd=1&statusListCredential='text'&statusSize=2&statusMessage=[]&makeFeePayment=true"

application/x-www-form-urlencodedapplication/json

{
  "checked": true,
  "revoked": false
}

Response format

The response format below will indicate clearly whether the check is successful and whether the Credential index in question is revoked / suspended or not.

{
  "checked": true,
  "revoked": false
}

Option 2: Manually Paying an Issuer to unlock a Credential Status

If a Verifier does not want to automatically pay the Issuer using the API, they can choose to make a manual payment to unlock the Credential Status information to build a higher level of trust within the Credential presented to them.

Step 1: Locating Issuers' payment address and conditions

If a Verifier wants to unlock access to the Resource, to gain access to additional information about a Credential presented to them, such as the Credential Status, firstly, the Verifier will be presented Credential, including a link to the Status List within the "credentialStatus" section of the Credential body.

Through following the link in"credentialStatus" section of the Credential body. the The Verifier will be directed to an on-ledger Resource, identifiable through a DID URL, for example:

https://resolver.cheqd.net/1.0/identifiers/did:cheqd:testnet:322761ea-587d-454a-a955-745200301b99?resourceName=revocation-list-encrypted-inverse-timelock&resourceType=StatusList2021Revocationresolver.cheqd.net

Example of encrypted Status List identifiable via a DID URL

This on-ledger Resource will contain:

• An encrypted potion of the Resource, such as a Status List bitstring. identified by the "encodedList" property.

• Unencrypted metadata about the Resource, including the issuers' payment address "feePayerAddress" and and the Payment Conditions, "feePaymentAmount" and "intervalInSeconds".

This gives the verifier requisite information they need in order to pay the Issuer to unlock the Credential Status. You can learn more about Access Control Conditions below.

Understanding Access Control Conditions

Learn what different Payment Conditions mean and how they affect a Verifier when verifying Credentials.

Step 2: Pay the Issuer

Using one of cheqd's supported wallets, Verifiers can make a payment of the amount specified in the "feePaymentAmount" to the "feePayerAddress".

This payment should be made in CHEQ.

Note that the "feePaymentAmount" may be specified in ncheq. This is lowest denomination of the CHEQ token, "nano" CHEQ which is 1 x 10^-9 CHEQ.

Step 3: Hit the API

cheqd Studio will perform a verification check on the Credential Status and pay the issuer the fee specified in the Payment Conditions.

Note the "intervalInSeconds" which is the amount of time after making the payment that the Verifier has to hit the API and request access to the encrypted Status List.

Check a StatusList2021 or BitstringStatusList index for a given Verifiable Credential.

post

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/credential-status/check

This endpoint checks a StatusList2021 or BitstringStatusList index for a given Verifiable Credential and reports whether it is revoked or suspended. It offers a standalone method for checking an index without passing the entire Verifiable Credential or Verifiable Presentation.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

listTypestring · enumRequired

The type of Status List.

Possible values:

statusPurposestring · enumRequired

The purpose of the status list. Can be either revocation or suspension.

Possible values:

Body

application/x-www-form-urlencodedapplication/json

didstring · uriRequired

DID of the StatusList2021 publisher.

statusListNamestringRequired

The name of the StatusList2021 DID-Linked Resource to be checked.

indexintegerOptional

Credential status index to be checked for revocation or suspension.

indicesinteger[]Optional

List of credential status indices to be checked for revocation or suspension.

indexRangeStartintegerOptional

Start of the credential status index range to be checked for revocation or suspension.

indexRangeEndintegerOptional

End of the credential status index range to be checked for revocation or suspension.

statusListCredentialstringOptional

Optional Resolvable DID URL of the BitstringStatusList credential to be checked.

statusSizenumberOptional

Optional size of the BitstringStatusList.

Default: 2

statusMessagearrayOptional

Array of status messages for each bit in the BitstringStatusList.

makeFeePaymentbooleanOptional

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

Default: true

Responses

200

The request was successful.

application/json

Responseone of

or

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

post

/credential-status/check

HTTPcURLJavaScriptPython

POST /credential-status/check?listType=StatusList2021&statusPurpose=revocation HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 201

"did='https://example.com'&statusListName='text'&index=1&indices=[1]&indexRangeStart=1&indexRangeEnd=1&statusListCredential='text'&statusSize=2&statusMessage=[]&makeFeePayment=true"

application/x-www-form-urlencodedapplication/json

{
  "checked": true,
  "revoked": false
}

Response format

The response format below will indicate clearly whether the check is successful and whether the Credential index in question is revoked / suspended or not.

{
  "checked": true,
  "revoked": false
}

Alternatively, if Verifiers have made the payment manually they can also use the /credential/verify API in the tutorial below:

Verify Credential

Verify a W3C Verifiable Credential using the cheqd Studio APIs.