Suspend an Accreditation

Suspend a Verifiable Accreditation issued to a DID.

Suspend a Verifiable Accreditation.

post

This endpoint suspends a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and credentialStatus property present in the VC.

Authorizations

Query parameters

publishbooleanRequired

Set whether the StatusList2021 or BitstringStatusList resource should be published to the ledger or not. If set to false, the StatusList2021 or BitstringStatusList publisher should manually publish the resource.

Default: true

Body

application/x-www-form-urlencodedapplication/json

didUrlstringOptional

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

Example: did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-issuer-logo&resourceType=CredentialArtwork

didstringOptionalExample: did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e

resourceIdstringOptionalExample: 398cee0a-efac-4643-9f4c-74c48c72a14b

resourceNamestringOptionalExample: cheqd-issuer-logo

resourceTypestringOptionalExample: CredentialArtwork

symmetricKeystringOptional

The symmetric key used to encrypt the StatusList2021 DID-Linked Resource. Required if the StatusList2021 DID-Linked Resource is encrypted.

Responses

200

The request was successful.

application/json

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

HTTPcURLJavaScriptPython

POST /trust-registry/accreditation/suspend HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 336

"didUrl='did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-issuer-logo&resourceType=CredentialArtwork'&did='did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e'&resourceId='398cee0a-efac-4643-9f4c-74c48c72a14b'&resourceName='cheqd-issuer-logo'&resourceType='CredentialArtwork'&symmetricKey='text'"

application/x-www-form-urlencodedapplication/json

{
  "revoked": true
}