Update notification

PUT 
/v2/config/digital-wallet/openid/notification/:notificationId

Marks a wallet notification as read. The wallet accepts only the value read, because a notification cannot go back to the unread state.

Request

Path Parameters

notificationId uuidrequired
Unique identifier of an OID4VCI credential lifecycle notification. The value must be a UUID.
Example: 6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9

application/json

Body

required

New read status for the notification.

status stringrequired

Possible values: [read]

New status of the notification. The wallet accepts only read and refuses all other values.

Responses

200

The wallet marked the notification as read.

Response Headers

application/json

Schema

Schema

notification object

A wallet notification for an OID4VCI credential lifecycle event.

id stringrequired

Unique identifier of the notification.

notificationType stringrequired

Possible values: [credential_pending, credential_acked, credential_revoked, credential_expired]

Type of the OID4VCI notification event. credential_pending (deferred issuance in progress), credential_acked (the holder acknowledged the credential), credential_revoked (the issuer revoked the credential), credential_expired (the credential expired).

notificationTypeRelatedId stringrequired

Identifier of the resource that the notification is about, for example the credential identifier.

notificationContent object required

Payload of the notification. The wallet gives an array of objects that hold the credential, credentialConfigurations and issuer details. The value is null when the wallet holds no payload.

oneOf

MOD1

Array [

property name* any

]

status stringrequired

Possible values: [read, unread]

Read status of the notification. A new notification has the status unread. The update operation sets the status to read, and a notification cannot go back to unread.

createdAt numberrequired

Unix timestamp (in seconds) when the notification was created.

updatedAt numberrequired

Unix timestamp (in seconds) when the notification was last modified.

Example (from schema)

{
  "notification": {
    "id": "6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9",
    "notificationType": "credential_acked",
    "notificationTypeRelatedId": "b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45",
    "notificationContent": [
      {}
    ],
    "status": "unread",
    "createdAt": 1747011600,
    "updatedAt": 1747011600
  }
}

400

The notification ID is unknown, or the status is not read.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...