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
Roles: ["admin","issuer"]
SecuritybearerAuth
Request
Responses
201
Credential status updated
400
Bad Request
404
Not Found. The specified resource was not found.
post/v2/credentials/mobile/{credentialId}/status
Request samples
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
application/json
{- "status": "valid"
}
Response samples
- 201
- 400
- 404
application/json
{- "status": "valid"
}
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
Roles: ["admin","issuer"]
SecuritybearerAuth
Request
Responses
200
Credential status retrieved
400
Bad Request. The request was malformed or missing required parameters.
404
Not Found. The specified resource was not found.
get/v2/credentials/mobile/{credentialId}/status
Request samples
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
Response samples
- 200
- 400
- 404
application/json
{- "status": "valid"
}