Retrieve all credential data
Returns all available data for existing credentials:
- For credentials that were created with the
persist
flag set totrue
, 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
query Parameters
Credentials data retrieved
Bad query parameters in request.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
{- "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
- "data": [
- {
- "id": "873277c0-a162-11ea-8a1d-a111119347e6",
- "credential": {
- "type": [
- "VerifiableCredential",
- "AlumniCredential"
], - "issuer": {
- "id": "did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5",
}, - "issuanceDate": "2020-05-02T12:06:29.156Z",
- "credentialSubject": {
- "id": "did:key:z6Mkvji7zrwyFATXUzGNBSCnrPaZy7H3BWUnihrHvZdkEd9y",
- "givenName": "Jamie",
- "familyName": "Doe"
}, - "proof": {
- "type": "Ed25519Signature2018",
- "created": "2020-05-02T12:06:29Z",
- "jws": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "proofPurpose": "assertionMethod",
- "verificationMethod": "did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5#z6Mkvji7zrwyFATXUzGNBSCnrPaZy7H3BWUnihrHvZdkEd9y"
}
}, - "tag": "identifier123",
- "issuanceDate": "2020-05-02T12:06:29.156Z"
}, - {
- "id": "9043aa74-eb08-11ea-adc1-0242ac120002",
- "tag": "identifier124",
- "credentialStatus": {
- "type": "RevocationList2020Status",
- "revocationListCredential": "https://tenant.vii.mattr.global/core/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3",
- "revocationListIndex": 1
}, - "issuanceDate": "2020-10-06T03:21:02.397Z"
}
]
}
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 totrue
, 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
Credential data retrieved
Credential ID not in a UUID format
Not Found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "id": "873277c0-a162-11ea-8a1d-a111119347e6",
- "credential": {
- "type": [
- "VerifiableCredential",
- "AlumniCredential"
], - "issuer": {
- "id": "did:web:organization.com",
- "name": "Example University"
}, - "issuanceDate": "2020-05-02T12:06:29.156Z",
- "credentialStatus": {
- "type": "RevocationList2020Status",
- "revocationListCredential": "https://tenant.vii.mattr.global/core/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3",
- "revocationListIndex": 4
}, - "credentialSubject": {
- "givenName": "Jamie",
- "familyName": "Doe"
}, - "proof": {
- "type": "Ed25519Signature2018",
- "created": "2020-05-02T12:06:29Z",
- "jws": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "proofPurpose": "assertionMethod",
- "verificationMethod": "did:web:organization.com"
}
}, - "tag": "identifier123",
- "credentialStatus": {
- "type": "RevocationList2020Status",
- "revocationListCredential": "https://tenant.vii.mattr.global/core/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3",
- "revocationListIndex": 4
}, - "issuanceDate": "2020-05-02T12:06:29.156Z"
}
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
Credential deleted and revoked if revocable
Invalid id parameter format
Credential ID not found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
- 404
{- "code": "string",
- "message": "string",
- "details": [
- {
- "value": "string",
- "msg": "Invalid value",
- "param": "id",
- "location": "body"
}
]
}
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
Revocation status updated
Not Found
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "isRevoked": true
}
- 404
{- "code": "NotFound",
- "message": "Validation Error",
- "details": [
- {
- "location": "path",
- "msg": "credential not revocable",
- "param": "id",
- "value": "a80a5e7e-1972-4be6-8a4e-2adf09badf24"
}
]
}
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
Credential status
Not Found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 404
{- "isRevoked": false
}
Retrieve revocation list
Returns the revocation list matching the provided ID.
path Parameters
Revocation list retrieved
Not Found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 404
{- "type": [
- "VerifiableCredential",
- "RevocationList2020Credential"
], - "issuer": "did:web:organization.com",
- "issuanceDate": "2020-05-02T12:06:29.156Z",
- "credentialSubject": {
- "type": "RevocationList2020",
- "encodedList": "H4sIAAAAAAAAA-3BMQEAAADCoPVPbQwfoAAAAAAAAAAAAAAAAAAAAIC3AYbSVKsAQAAA"
}, - "proof": {
- "type": "Ed25519Signature2018",
- "created": "2020-05-02T12:06:29Z",
- "jws": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "proofPurpose": "assertionMethod",
- "verificationMethod": "did:web:organization.com#CU6dJt9p8t"
}
}
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
path Parameters
Request Body schema: application/json
Create a JWM message payload
Revocation message payload created
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "from": "did:web:organization.com",
- "to": [
- "did:key:subjectDid1",
- "did:key:subjectDid2",
- "did:key:subjectDid3"
]
}
- 201
{- "id": "string",
- "type": "string",
- "to": [
- "did:key:subjectDid1",
- "did:key:subjectDid2",
- "did:key:subjectDid3"
], - "from": "did:web:organization.com",
- "created_time": 0,
- "body": {
- "revocationListCredential": "string",
- "revocationListIndex": "string",
- "isRevoked": true
}
}