API ReferenceStatus update
Retrieve mDoc status
GET
/v2/credentials/mobile/{credentialId}/statusRetrieves the status of an existing mDoc by providing its credentialId.
Roles
adminissuermanaged-issuer
Analytics Events
MOBILE_CREDENTIAL_STATUS_RETRIEVE_STARTMOBILE_CREDENTIAL_STATUS_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_STATUS_RETRIEVE_FAIL
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
credentialId*string
mDoc identifier
Format
uuidcredentialId*string
mDoc identifier
Format
uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/v2/credentials/mobile/3948c40e-6e19-4ffc-933c-91f643f24264/status"{ "status": "valid"}How would you rate this page?
Update mDoc status POST
Sets the status of an existing mDoc by providing its `credentialId` and the new status. MATTR VII implements Draft 14 of the IETF Token Status List specification, which uses 1-bit encoding. The available status values are: * **valid** - Credential is valid * **invalid** - Credential is invalid (cannot be reversed)
Delete mDoc metadata DELETE
Deletes all stored data for an existing mDoc that matches the provided ID. Removed credential data cannot be recovered.