light-mode-image
Learn
API ReferenceMetadata

Delete mDoc metadata

Roles

adminissuermanaged-issuer

Analytics Events

USER_CREDENTIAL_DELETE_STARTUSER_CREDENTIAL_DELETE_SUCCESSUSER_CREDENTIAL_DELETE_FAIL
DELETE/v2/credentials/mobile/{id}

Deletes all stored data for an existing mDoc that matches the provided ID.

Removed credential data cannot be recovered.

Analytic events

  • USER_CREDENTIAL_DELETE_START
  • USER_CREDENTIAL_DELETE_SUCCESS
  • USER_CREDENTIAL_DELETE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

mDoc ID

Response Body

application/json

application/json

curl -X DELETE "https://example.vii.au01.mattr.global/v2/credentials/mobile/string"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Retrieve mDoc status GET

Retrieves the status of an existing mDoc by providing its `credentialId`. ### **Analytic events** * MOBILE_CREDENTIAL_STATUS_RETRIEVE_START * MOBILE_CREDENTIAL_STATUS_RETRIEVE_SUCCESS * MOBILE_CREDENTIAL_STATUS_RETRIEVE_FAIL

Update CWT credential revocation status POST

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