Reauth Reminder (reauthReminder)

Sent before an Open Banking connection's consent expires.

Id: reauthReminder

Event that notifies when an Open Banking connection requires re-consent or re-authentication. An Open Banking connection typically requires re-consent every 90 days.

When it is sent

  • Up to 5 days before the connection is due to expire
  • Repeated every 2 days (48 hours) until re-consent occurs

Payload

These fields are sent in the payload object of the webhook envelope.

NameTypeDescription
connectionIdstringThe ID of the connection
bankNamestringThe name of the bank
timeUntilReauthorizationInDaysnumberThe number of days until the connection will stop working
tppConsentbooleanIndicates whether re-consent is possible, otherwise re-authentication must be done

Example (JSON format)

{
  "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
  "eventType": "reauthReminder",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "connectionId": "1ffe704d39629a929c8e293880fb449a:7d235ab0-e951-487f-acde-73cae1a18be0",
    "bankName": "Test Bank",
    "timeUntilReauthorizationInDays": 5,
    "tppConsent": false
  }
}

This example uses the JSON format. JWT webhooks carry the same payload fields in a different envelope, and batched webhooks list events without payloads. See Webhook Format.

Related