Skip to main content

List notification

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

Lists the wallet notifications for OID4VCI credential lifecycle events. You can filter the notifications by read status, by notification type and by a search term.

The search term matches the credential type (vct), the last W3C credential type, the mDoc docType, the display names of the credential configuration, and the issuer name.

The service always sorts the notifications by updatedAt, newest first. The sortOrder parameter has no effect on this operation.

Request​

Query Parameters

    offset integerrequired

    Default value: 0

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    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_pending, 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).

Header Parameters

    X-SandboxOrgId stringrequired

    Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.

    The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.

    X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.

    The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.

    Example: 6889e1a4c5b2f30001a3d710

Responses​

The wallet returns the notifications.

Response Headers
    Schema
      notification object[]required

      Notifications on the requested page. The array is empty when the wallet holds no notifications.

    • Array [
      • 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
    • 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.

    • ]
      • 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

    Loading...
    Last updated on