light-mode-image
Learn
API ReferenceStatus update

Retrieve mDoc status

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_RETRIEVE_STARTMOBILE_CREDENTIAL_STATUS_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_STATUS_RETRIEVE_FAIL
GET/v2/credentials/mobile/{credentialId}/status

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

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

credentialId*string

mDoc identifier

Formatuuid
credentialId*string

mDoc identifier

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v2/credentials/mobile/497f6eca-6276-4993-bfeb-53cbbbba6f08/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. Available status values depend on the Status List configuration format: **Draft 14 of the IETF Token Status List specification (1-bit encoding)**: * **valid** - Credential is valid * **invalid** - Credential is invalid (cannot be reversed) **Deprecated Legacy format (2-bit encoding)**: * **valid** - Credential is valid * **invalid** - Credential is invalid (cannot be reversed) * **suspended** - Credential is temporarily suspended The **suspended** status is deprecated and only available in legacy format. ### **Analytic events** * MOBILE_CREDENTIAL_STATUS_SET_START * MOBILE_CREDENTIAL_STATUS_SET_SUCCESS * MOBILE_CREDENTIAL_STATUS_SET_FAIL

Delete mDoc metadata DELETE

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