API Reference
Status update
Update mDocs status
Update mDoc status
Sets the status of an existing mDoc by providing its credentialId
and the new status. Status can only be valid, suspended or invalid.
Once an mDoc's status is updated to invalid, it cannot be updated again to any other value.
Analytic events
- MOBILE_CREDENTIAL_STATUS_SET_START
- MOBILE_CREDENTIAL_STATUS_SET_SUCCESS
- MOBILE_CREDENTIAL_STATUS_SET_FAIL
POST
/v2/credentials/mobile/{credentialId}/status
AuthorizationBearer <token>
In: header
Path Parameters
credentialIdstring
mDoc identifier
Format
uuid
Credential status payload
statusstring
mDoc status.
Value in
"valid" | "suspended" | "invalid"
curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/mobile/3948c40e-6e19-4ffc-933c-91f643f24264/status" \ -H "Content-Type: application/json" \ -d '{ "status": "valid" }'
{
"status": "valid"
}
{
"code": "BadRequest",
"message": "Validation Error",
"details": [
{
"location": "params",
"msg": "Invalid value",
"param": "credentialId",
"value": "abc"
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Retrieve mDocs status
Retrieve mDoc 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
GET
/v2/credentials/mobile/{credentialId}/status
AuthorizationBearer <token>
In: header
Path Parameters
credentialIdstring
mDoc identifier
Format
uuid
credentialIdstring
mDoc identifier
Format
uuid
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?