MATTR VII Platform API

🪪 CREDENTIAL ISSUANCE

Establishing Trust

OID4VCI

Direct Issuance

mDocs Management

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

Create Webhook POST Retrieve all Webhooks GET Retrieve Webhook GET Update Webhook PUT Delete Webhook DELETE Retrieve Webhook JWKs GET

MATTR VII Management API

Overview

API ReferenceWebhooks

Update Webhook

PUT/v1/webhooks/{webhookId}

Updates an existing Webhook by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_UPDATE_STARTWEBHOOK_UPDATE_SUCCESSWEBHOOK_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Update Webhook

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/webhooks/41458e5a-9092-40b7-9a26-d4eb43c5792f" \  -H "Content-Type: application/json" \  -d '{    "events": [      "OpenIdCredentialIssued"    ],    "url": "https://example.com"  }'

{  "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",  "events": [    "OpenIdCredentialIssued"  ],  "url": "https://example.com",  "disabled": false}

How would you rate this page?

Retrieve Webhook GET

Retrieve a specific Webhook by providing its ID.

Delete Webhook DELETE

Deletes a Webhook by providing its ID.

API ReferenceWebhooks

Update Webhook

PUT/v1/webhooks/{webhookId}

Updates an existing Webhook by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_UPDATE_STARTWEBHOOK_UPDATE_SUCCESSWEBHOOK_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Update Webhook

TypeScript Definitions

Use the request body type in TypeScript.

events*array<>

This array includes the event types that will trigger this Webhook. The following events are currently supported:

OpenIdCredentialIssued: Triggered upon completion of an OID4VCI issuance flow and includes credential data.
OpenIdCredentialIssuedSummary: Triggered upon completion of an OID4VCI issuance flow but does not include credential data.

url*string

This is the URL that will receive the Webhook events data payload when they are triggered by MATTR VII for the specified events:

Must be a valid URL.
Must use the HTTPS protocol.
Must not be an IP address.
Must not include query parameters or have fragments.
Non-ASCII characters are normalized.
Must return a 2xx response, otherwise it will go through a retry cycle and eventually fail.

Formaturi

disabled?boolean

Indicates whether or not the Webhook is disabled. When set to true the webhook is disabled, and notifications for events associated with it will not be sent. If no value is provided, defaults to false.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/webhooks/41458e5a-9092-40b7-9a26-d4eb43c5792f" \  -H "Content-Type: application/json" \  -d '{    "events": [      "OpenIdCredentialIssued"    ],    "url": "https://example.com"  }'

{  "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",  "events": [    "OpenIdCredentialIssued"  ],  "url": "https://example.com",  "disabled": false}

How would you rate this page?

Retrieve Webhook GET

Retrieve a specific Webhook by providing its ID.

Delete Webhook DELETE

Deletes a Webhook by providing its ID.

Update Webhook

Roles

Analytics Events

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Update Webhook

Roles

Analytics Events

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Update Webhook

Roles

Analytics Events

200application/json

400application/json

404application/json

Update Webhook

Roles

Analytics Events

200application/json

400application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`