light-mode-image
Learn
RevocationAPI Reference

Status List Configuration

Create a Status List configuration

POST/v2/credentials/mobile/status-lists/configurations

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

The Status list configuration payload

docType*string

Status list configurations are unique per docType on your tenant. This value must match the type set when creating an mDoc credential configuration.

Length1 <= length <= 1024
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.

Response Body

application/json

application/json

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-lists/configurations" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "983c0a86-204f-4431-9371-f5a22e506599",
  "docType": "Drivers License",
  "timeToLiveDuration": {
    "days": 1
  },
  "expiryDuration": {
    "days": 2
  }
}

{
  "code": "BadRequest",
  "message": "Validation Error",
  "details": [
    {
      "location": "body",
      "msg": "must be a Duration",
      "param": "timeToLiveDuration",
      "value": "abc"
    }
  ]
}

Retrieve all Status List configurations

GET/v2/credentials/mobile/status-lists/configurations

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

Response Body

application/json

application/json

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-lists/configurations"
{
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  "data": [
    {
      "id": "983c0a86-204f-4431-9371-f5a22e506599",
      "docType": "Drivers License",
      "timeToLiveDuration": {
        "days": 1
      },
      "expiryDuration": {
        "days": 2
      }
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve a Status List configuration

GET/v2/credentials/mobile/status-lists/configurations/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Status list configuration ID

Formatuuid
id*string

Status list configuration ID

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-lists/configurations/3948c40e-6e19-4ffc-933c-91f643f24264"
{
  "docType": "DriverLicense",
  "timeToLiveDuration": {
    "days": 1
  },
  "expiryDuration": {
    "days": 2
  }
}
{
  "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"
    }
  ]
}

Update a Status List configuration

PUT/v2/credentials/mobile/status-lists/configurations/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Status list configuration ID

Formatuuid
id*string

Status list configuration ID

Formatuuid

Request Body

application/json

The Status list configuration payload

body*unknown

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-lists/configurations/3948c40e-6e19-4ffc-933c-91f643f24264" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "983c0a86-204f-4431-9371-f5a22e506599",
  "docType": "Drivers License",
  "timeToLiveDuration": {
    "days": 1
  },
  "expiryDuration": {
    "days": 2
  }
}
{
  "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"
    }
  ]
}

Delete a Status List configuration

DELETE/v2/credentials/mobile/status-lists/configurations/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Status list configuration ID

Formatuuid
id*string

Status list configuration ID

Formatuuid

Response Body

application/json

application/json

curl -X DELETE "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-lists/configurations/3948c40e-6e19-4ffc-933c-91f643f24264"
Empty
{
  "code": "BadRequest",
  "message": "Status list configuration is in use by at least one status list"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Tutorial

Previous Page

Status List retrieval

Next Page

On this page

Create a Status List configurationRetrieve all Status List configurationsRetrieve a Status List configurationUpdate a Status List configurationDelete a Status List configuration