light-mode-image
Learn
MATTR VII PlatformStatus update

Retrieve mDoc status

Retrieves the status of an existing mDoc by providing its credentialId.

Analytics Events

MOBILE_CREDENTIAL_STATUS_RETRIEVE_STARTMOBILE_CREDENTIAL_STATUS_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_STATUS_RETRIEVE_FAIL

Roles

adminissuer
GET/v2/credentials/mobile/{credentialId}/status
AuthorizationBearer <token>

In: header

Path Parameters

credentialIdstring

mDoc identifier

Formatuuid
credentialIdstring

mDoc identifier

Formatuuid

Response Body

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/3948c40e-6e19-4ffc-933c-91f643f24264/status"
{
  "status": "valid"
}
{
  "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?