Skip to main content
Notifications

List notifications

GET/v4/config/ows/holder/notifications

Lists the wallet notifications, newest change first. The wallet makes a notification when a held credential is pending (credential_pending), received (credential_acked), revoked (credential_revoked) or expired (credential_expired). Filter by read status, type or a search term: search finds text, without regard to case, in the vct, the last W3C credential type, the mDoc docType, the display names of the credential configuration and the issuer name. For new notifications as they come, use Stream notifications (SSE).

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:notifications:read

Query parameters

  • offsetinteger

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

    At least 0.

    Default:0

  • limitinteger

    Maximum number of records to return per page.

    Default:10

  • statusenum<string>

    Gives only the notifications with this read status: unread or read.

    Available options:read,unread

  • notificationTypeenum<string>

    Gives only the notifications of this type: credential_pending, credential_acked (received), credential_revoked or credential_expired.

    Available options:credential_pending,credential_acked,credential_revoked,credential_expired

  • searchstring

    Text to search for. The description of the operation says which fields it searches.

  • sortOrderenum<string>

    Sort order: desc (default, newest first) or asc (oldest first). Any other value is desc.

    Available options:desc,asc

    Default:desc

Response

application/json

A page of notifications.

  • notificationobject[]

    The notifications of the page, ordered by updatedAt. Empty when no notification matches.

  • paginationobject

    The position of the page in the list.