Learn

mDocs

Delete mDoc metadata

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
SecuritybearerAuth
Request
path Parameters
id
required
string

mDoc ID

Responses
204

mDoc metadata deleted

400

Invalid id parameter format

404

mDoc not found

delete/v2/credentials/mobile/{id}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
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
    • 



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


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
    • 



SecuritybearerAuth 
Request 
path Parameters
credentialId
required
string <uuid> 
mDoc identifier


 
 Example:  3948c40e-6e19-4ffc-933c-91f643f24264
Responses 
200
Credential status retrieved


400
Bad Request


404
Not Found


get/v2/credentials/mobile/{credentialId}/status
Request samples 
Response samples 
application/json
{
  • "status": "valid"
}
Create a Status list configuration
Creates a Status list configuration, which defines a status list validity periods. mDocs can then be assigned to a specific Status list configuration.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_FAIL
    • 



SecuritybearerAuth 
Request 
Request Body schema: application/json
required
The Status list configuration payload


docType
required
string  [ 1 .. 1024 ] characters 
Status list configurations are unique per docType on your tenant. This value must match the type set when creating an mDoc credential configuration.


 
timeToLiveDuration
required
object
Defines how long relying parties can cache Status list tokens of this docType before it is recommended to retrieve a new Status list token from the tenant. Cannot exceed expiryDuration.


 
expiryDuration
required
object
Defines how long relying parties can cache Status list tokens of this docType before they expire. Once a Status list token expires, relying parties can no longer use it to check credentials status and must retrieve a new one from the tenant. Regardless of the value of this parameter, Status list tokens expiry cannot exceed the validity of the IACA that is used to sign the Status list token.


 
Responses 
201
Status list configuration created


400
Bad Request


post/v2/credentials/mobile/status-lists/configurations
Request samples 
application/json
{
  • "docType": "DriverLicense",
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}
Response samples 
application/json
{
  • "id": "983c0a86-204f-4431-9371-f5a22e506599",
  • "docType": "Drivers LIcense",
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}
Retrieve all Status list configurations
Retrieves all Status list configurations from your tenant.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_FAIL
    • 



SecuritybearerAuth 
Request 
query Parameters
limit
number  [ 1 .. 1000 ] 
 Default:  100
Range size of the list, default 100


 
 Example:  limit=2
cursor
string
Starting point for the list


 
 Example:  cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses 
200
Status list configurations retrieved


400
Bad Request


get/v2/credentials/mobile/status-lists/configurations
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}
Retrieve a Status list configuration
Retrieves an existing Status list configuration by providing its ID.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Status list configuration ID


 
 Example:  3948c40e-6e19-4ffc-933c-91f643f24264
Responses 
200
Status list configuration retrieved


400
Bad Request


404
Not Found


get/v2/credentials/mobile/status-lists/configurations/{id}
Request samples 
Response samples 
application/json
{
  • "docType": "DriverLicense",
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}
Update a Status list configuration
Updates an existing Status list configuration, allowing you to adjust the expiry and TTL (Time To Live) settings.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Status list configuration ID


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


timeToLiveDuration
object
Defines how long relying parties can cache Status list tokens of this docType before it is recommended to retrieve a new Status list token from the tenant. Cannot exceed expiryDuration.


 
expiryDuration
object
Defines how long relying parties can cache Status list tokens of this docType before they expire. Once a Status list token expires, relying parties can no longer use it to check credentials status and must retrieve a new one from the tenant. Regardless of the value of this parameter, Status list tokens expiry cannot exceed the validity of the IACA that is used to sign the Status list token.


 
Responses 
200
Status list configuration updated


400
Bad Request


404
Not Found


put/v2/credentials/mobile/status-lists/configurations/{id}
Request samples 
application/json
{
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}
Response samples 
application/json
{
  • "id": "983c0a86-204f-4431-9371-f5a22e506599",
  • "docType": "Drivers LIcense",
  • "timeToLiveDuration": {
    },
  • "expiryDuration": {
    }
}
Delete a Status list configuration
Permanently deletes an existing Status list configuration.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Status list configuration ID


 
 Example:  3948c40e-6e19-4ffc-933c-91f643f24264
Responses 
204
Status list configuration deleted


404
Not Found


delete/v2/credentials/mobile/status-lists/configurations/{id}
Request samples 
Response samples 
application/json
{
  • "code": "BadRequest",
  • "message": "Status list configuration is in use by at least one status list"
}
Retrieve all Status lists
Retrieves all existing status lists from your tenant.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_FAIL
    • 



SecuritybearerAuth 
Responses 
200
Status lists retrieved


get/v2/credentials/mobile/status-lists
Request samples 
Response samples 
application/json
{
  • "data": [
    ]
}
Retrieve a Status list
Retrieves an existing Status list and its signed token by providing its ID.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
statusListId
required
string <uuid> 
Status list unique identifier


 
Responses 
200
Status list retrieved


400
Bad Request


404
Not Found


get/v2/credentials/mobile/status-lists/{statusListId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
  • "statusListConfigurationId": "0bd642d3-4a3b-4ce2-9f8f-151a73becaae",
  • "listSize": 100000,
  • "list": "0oRZAu6jEHRtYXR0ci1zdGF0dXNs..."
}
Retrieve a Status list token
Retrieves the Status list token in CWT format. This public end point returns a token which contains a compressed, signed list of credential statuses. Relying parties
can use this token to check the revocation status of an mDoc that references this Status list.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_FAIL
    • 



Request 
path Parameters
statusListId
required
string <uuid> 
Status list identifier


 
Responses 
200
Status list token retrieved


404
Not Found


410
Status list expired


get/v2/credentials/mobile/status-lists/{statusListId}/token
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
Status list distribution
Retrieves an object that details all existing Status lists tokens on the tenant. This public endpoint allows a relying party to consume and cache status lists. Each list
in the response includes a URL where its token can be retrieved. Status list tokens that were signed by expired IACAs are excluded from the response.


Analytic events


    

  • MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_START
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_SUCCESS
    • 

  • MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_FAIL
    • 



Responses 
200
Status lists retrieved


get/v2/credentials/mobile/status-lists/distribution
Request samples 
Response samples 
application/json
{}
➔ Next to CWT credentials