List notification

GET 
/v2/config/digital-wallet/openid/notifications

Lists wallet notifications for OID4VCI credential offers, OpenID4VP verification requests, and status updates.

Request

Query Parameters

offset integerrequired

Number of records to skip for pagination.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

status string

Possible values: [read, unread]

Filter notifications by read or unread status.

notificationType string

Possible values: [credential_acked, credential_revoked, credential_expired]

Filter notifications by OID4VCI credential lifecycle event type.

search stringrequired

Search term to filter results by

sortOrder stringrequired

Possible values: [desc, asc]

Default value: desc

Sort order for the returned records (ascending or descending).

Responses

200

Response Headers

application/json

Schema

Schema

notification object[]
Array [
id stringrequired
Unique identifier for the notification.
notificationType stringrequired
Possible values: [credential_acked, credential_revoked, credential_expired]
Type of the OID4VCI notification event. credential_acked (holder acknowledged), credential_revoked (issuer revoked), credential_expired (credential expired).
notificationTypeRelatedId stringrequired
Identifier of the related resource (e.g. credential exchange ID).
notificationContent object
JSON object containing the notification payload details.
status string
Possible values: [read, unread]
Read status. unread for new notifications, read for viewed.
createdAt numberrequired
Unix timestamp (in seconds) when the notification was created.
updatedAt numberrequired
Unix timestamp (in seconds) when the notification was last modified.
]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "notification": [
    {
      "id": "string",
      "notificationType": "credential_acked",
      "notificationTypeRelatedId": "string",
      "notificationContent": {},
      "status": "read",
      "createdAt": 0,
      "updatedAt": 0
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  }
}

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...