Learn

mDocs status

Specifies paths and operations for managing 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
Roles: ["admin","issuer"]
SecuritybearerAuth
Request
path Parameters
credentialId
required
string <uuid>

mDoc identifier

Example: 3948c40e-6e19-4ffc-933c-91f643f24264
Request Body schema: application/json
required

Credential status payload

status
required
string

mDoc status.

Enum: "valid" "suspended" "invalid"
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
application/json
{
  • "status": "valid"
}
Response samples
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
path Parameters
credentialId
required
string <uuid>

mDoc identifier

Example: 3948c40e-6e19-4ffc-933c-91f643f24264
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 
Response samples 
application/json
{
  • "status": "valid"
}
➔ Next to mDocs metadata