Skip to main content

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

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

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​

The wallet marked the notification as read.

Response Headers
    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
    • 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.

    Loading...
    Last updated on