Revocation Status

Credentials can be revoked or unrevoked, and as such they contain a revocation status so that verifiers/issuers can check if the credential is still valid. Once a revocation registry has been created and credentials issued with it, you can check the revocation status. Verifiers will do this automatically.

Get Revocation Status

To check if an id is revoked or not, you can check its status with the registry id (regId) and revocation id (revId).

Parameters

NameInTypeRequiredDescription

regId

path

true

Revocation registry id.

revId

path

true

Credential revocation id.

GET /revocationStatus/{regId}/{revId} REQUEST


curl --location --request GET https://api.dock.io/revocationStatus/{regId}/{revId} \
  --header 'DOCK-API-TOKEN: API_KEY' \
  --data-raw ''

Responses

StatusMeaningDescriptionSchema

200

The request was successful and will return true, if the credential is revoked, false otherwise.

Inline

404

The request was unsuccessful, because the registry was not found.

402

Transaction limit reached or upgrade required to proceed

400

The request was unsuccessful, because you have not revoked or unrevoked the registered credential yet. Please try to revoke/unrevoke the registered credential and try again.

200 Response

{
  "type": true
}

Get Revocation Status Witness

The accumulator witness is utilized by the holder to generate a proof, which combines the witness with their revocation id associated with the credential id (revId) and the accumulator associated with the registry id (regId), allowing the verifier to validate the credential's status without directly accessing the revocation id on the blockchain.

Parameters

NameInTypeRequiredDescription

regId

path

true

Revocation registry id.

revId

path

true

Credential revocation id.

GET /revocationStatus/{regId}/{revId}/witness REQUEST


curl --location --request GET https://api.dock.io/revocationStatus/{regId}/{revId} \
  --header 'DOCK-API-TOKEN: API_KEY' \
  --data-raw ''

Responses

StatusMeaningDescriptionSchema

200

The request was successful and will return the membership witness.

Inline

404

The request was unsuccessful, because the registry was not found.

402

Transaction limit reached or upgrade required to proceed

400

The request was unsuccessful, because you have not revoked or unrevoked the registered credential yet. Please try to revoke/unrevoke the registered credential and try again.

200 Response

{
  "value": "0x81aa308882b663491e2b42803ad0855b030d92a586bc378bc844e1e003c8098a23f0d7d75b4fdbfb4b42cfc42aca8ad3"
}

Last updated