MATTR VII Platform API

🪪 CREDENTIAL ISSUANCE

Establishing Trust

OID4VCI

Direct Issuance

mDocs Management

Create a Status list configuration POST Retrieve all Status list configurations GET Retrieve a Status list configuration GET Update a Status list configuration PUT Delete a Status list configuration DELETE

CWT Credentials Management

JSON Credentials Management

📱 CREDENTIAL HOLDING

✅ CREDENTIAL VERIFICATION

Establishing Trust

mDocs Verification

CWT Credentials Verification

JSON Credentials Verification

🌐 TRUST NETWORKS

Establishing Trust

Ecosystem

Participants

Policies

VICAL

RICAL

⚙️ PLATFORM MANAGEMENT

General

Configuration

MATTR VII Management API

Overview

API ReferenceStatus list configuration

Create a Status list configuration

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

Creates a Status list configuration, which defines a status list validity periods. mDocs can then be assigned to a specific Status list configuration.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The Status list configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/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  }}

How would you rate this page?

Sign a JSON credential POST

Returns a signed JSON credential generated from a provided valid payload.

Retrieve all Status list configurations GET

Retrieves all Status list configurations from your tenant.

API ReferenceStatus list configuration

Create a Status list configuration

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

Creates a Status list configuration, which defines a status list validity periods. mDocs can then be assigned to a specific Status list configuration.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_STARTMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_SUCCESSMOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The Status list configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

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*

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*

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`

curl -X POST "https://example.com/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  }}

How would you rate this page?

Sign a JSON credential POST

Returns a signed JSON credential generated from a provided valid payload.

Retrieve all Status list configurations GET

Retrieves all Status list configurations from your tenant.

Create a Status list configuration

Roles

Analytics Events

Authorization

Request Body

Response Body

201application/json

400application/json

Create a Status list configuration

Roles

Analytics Events

Authorization

Request Body

Response Body

201application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`