Learn

Compact Credentials

Delete Compact Credential metadata

Deletes all credential metadata from the tenant for a specific credential by providing its ID. If the credential was set to be revocable, it will be permanently revoked upon metadata deletion.

Note that only metadata of revocable credentials or credentials issued via the OpenID4VCI flow is saved.

Deleted metadata cannot be recovered.

SecuritybearerAuth
Request
path Parameters
id
required
string

Credential ID

Responses
204

Credential metadata deleted

400

Invalid id parameter format

404

Credential ID not found

delete/v2/credentials/compact/{id}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
Retrieve all Compact Credential revocation lists
Returns a list of all Compact Credential revocation lists on the tenant.


Analytic events


    

  • CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_START
    • 

  • CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_SUCCESS
    • 

  • CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Responses 
200
Revocation lists retrieved


get/v2/credentials/compact/revocation-lists
Request samples 
Response samples 
application/json
[
  • {
    }
]
Retrieve Compact Credential revocation list
Returns a Compact Credential revocation list by providing its ID.


Analytic events


    

  • CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_START
    • 

  • CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_SUCCESS
    • 

  • CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
listId
required
string
The unique identifier of the Revocation List you wish to retrieve.


 
Responses 
200
Revocation list retrieved


get/v2/credentials/compact/revocation-lists/{listId}
Request samples 
Update Compact Credential revocation status
Updates the credential status as revoked (invalid) or unrevoked (valid).


Analytic events


    

  • CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_START
    • 

  • CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_SUCCESS
    • 

  • CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Unique credential identifier.


 
Request Body schema: application/json
required
Update revocation status


isRevoked
required
boolean
When set to true the credential will be revoked. When set to false, the credential will be unrevoked.


 
Responses 
200
Revocation status updated


404
Id not found


post/v2/credentials/compact/{id}/revocation-status
Request samples 
application/json
{
  • "isRevoked": true
}
Response samples 
application/json
{
  • "id": "string",
  • "isRevoked": true
}
Retrieve Compact Credential revocation status
Retrieve the revocation status of a Compact Credential by providing its ID.


SecuritybearerAuth 
Request 
path Parameters
id
required
string
Unique credential identifier.


 
Responses 
200
Revocation status retrieved


404
Id not found


get/v2/credentials/compact/{id}/revocation-status
Request samples 
Response samples 
application/json
{
  • "isRevoked": true
}
➔ Next to Compact Semantic Credentials