Learn

JSON credentials

Retrieve all credential data

Returns all available data for existing credentials:

  • For credentials that were created with the persist flag set to true, the response contains both the credential and its metadata.
  • For credentials that were created with the persist flag set to false, the response only contains the metadata (id, tag, credentialStatus, issuanceDate).

Analytic events

  • CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_START
  • CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_SUCCESS
  • CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_FAIL
SecuritybearerAuth
Request
query Parameters
tag
string

Optional tag to filter on.

Example: tag=identifier123
type
string

Optional credential type to filter on.

Example: type=AlumniCredential
limit
number [ 1 .. 1000 ]

Range size of returned credential entries, default 100

Example: limit=2
cursor
string

Starting point for the range of credential entries

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Credentials data retrieved

400

Bad query parameters in request.

get/v2/credentials/web-semantic
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}
Retrieve credential data
Returns all available data for an existing credential that matches the provided ID:


    

  • For credentials that were created with the persist flag set to true, the response contains both the credential and its metadata.
    • 

  • For credentials that were created with the persist flag set to false, the response only contains the metadata (id, tag, credentialStatus, issuanceDate)
    • 



Analytic events


    

  • CREDENTIAL_WEB_SEMANTIC_RETRIEVE_START
    • 

  • CREDENTIAL_WEB_SEMANTIC_RETRIEVE_SUCCESS
    • 

  • CREDENTIAL_WEB_SEMANTIC_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Credential ID


 
Responses 
200
Credential data retrieved


400
Credential ID not in a UUID format


404
Not Found


get/v2/credentials/web-semantic/{id}
Request samples 
Response samples 
application/json
{}
Delete credential data
Deletes all stored data for an existing credential that matches the provided ID. If the credential is revocable, it will also be permanently revoked.




Removed credential data cannot be recovered.




Analytic events


    

  • CREDENTIAL_WEB_SEMANTIC_DELETE_START
    • 

  • CREDENTIAL_WEB_SEMANTIC_DELETE_SUCCESS
    • 

  • CREDENTIAL_WEB_SEMANTIC_DELETE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Credential ID


 
Responses 
204
Credential deleted and revoked if revocable


400
Invalid id parameter format


404
Credential ID not found


delete/v2/credentials/web-semantic/{id}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
Set credential revocation status
Sets the revocation status of the credential that matches the provided ID as true (revoked) or false (unrevoked).


Analytic events


    

  • CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_START
    • 

  • CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_SUCCESS
    • 

  • CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Credential ID


 
 Example:  a80a5e7e-1972-4be6-8a4e-2adf09badf24
Request Body schema: application/json
required
Setting the revocation status


isRevoked
required
boolean
Indicates whether the credential is revoked (true) or not (false).


 
Responses 
200
Revocation status updated


404
Not Found


post/v2/credentials/web-semantic/{id}/revocation-status
Request samples 
application/json
{
  • "isRevoked": true
}
Response samples 
application/json
{
  • "code": "NotFound",
  • "message": "Validation Error",
  • "details": [
    ]
}
Retrieve credential revocation status
Returns the revocation status of the credential matching the provided ID.


Analytic events


    

  • CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_START
    • 

  • CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_SUCCESS
    • 

  • CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Credential ID


 
 Example:  a80a5e7e-1972-4be6-8a4e-2adf09badf24
Responses 
200
Credential status


404
Not Found


get/v2/credentials/web-semantic/{id}/revocation-status
Request samples 
Response samples 
application/json
{
  • "isRevoked": false
}
Retrieve revocation list
Returns the revocation list matching the provided ID.


Request 
path Parameters
id
required
string <uuid> 
Revocation list ID. This value can be found within the credential you created. Look at the value for Credential.credential.credentialStatus.id, the string after https://tenant.vii.mattr.global/core/v1/revocation-lists/ is what you're looking for


 
 Example:  cc641396-3750-43c8-b8b8-f30d74eb3fb3
Responses 
200
Revocation list retrieved


404
Not Found


get/v2/credentials/web-semantic/revocation-lists/{id}
Request samples 
Response samples 
application/json
{}
Create a revocation message payload
Returns a message in JWM format that can be used to notify subjects based on their credential revocation status change.


To send a notification to the Subject DID holder, use the returned payload with the encrypt and send endpoints.


Analytic events


    

  • CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_START
    • 

  • CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_SUCCESS
    • 

  • CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Unique identifier for the credential whose status has changed.


 
 Example:  873277c0-a162-11ea-8a1d-a111119347e6
Request Body schema: application/json
Create a JWM message payload


from
required
string  non-empty 
The sender's DID URL, obtained from the id field of the first keyAgreement entry of the DID document. This must be a DID with a key type suitable for messaging (not a BLS key type).


 
to
required
Array of strings
The intended recipients DID URL.


 
Responses 
201
Revocation message payload created


post/v2/credentials/web-semantic/{id}/revocation-status/notification
Request samples 
application/json
{
  • "from": "did:web:organization.com",
  • "to": [
    ]
}
Response samples 
application/json
{
  • "id": "string",
  • "type": "string",
  • "to": [
    ],
  • "from": "did:web:organization.com",
  • "created_time": 0,
  • "body": {
    }
}
➔ Next to mDocs