Skip to main content

Notification Service

The Notification Service API provides translation-ready, template-based notifications to end users across configurable delivery channels.

To send a notification, specify the recipient, the delivery channel, the template to use, and any data needed to populate the template. The service handles rendering and delivery.

For setup, see Configuring Wallet Provider - User notifications.

Example call​

{
  "channel": "SMTP",
  "user": "user-subject-id",
  "template": {
    "name": "CREDENTIAL_LOGIN_DEACTIVATED",
    "locale": "en"
  }
}

User​

Pass the sub claim from the wallet user's authentication token.

During wallet onboarding, when user authentication is enabled, the wallet user's authentication token is included in the call to POST /ssi/wallet-unit/v1/{id}/activate. The sub is stored and retrievable as userSub from the list and detail endpoints for /api/wallet-instance/v1.

Templates​

Each template name maps to a pre-defined notification event. The message content is determined entirely by the template and locale — no dynamic values are injected. The data field is reserved for future templates that support dynamic value injection.

Translations​

Use locale to specify the language the notification is rendered in.

No response body​

The Notification Service returns 204 No Content on success. There is no delivery confirmation or status polling.