Skip to main content

Partner Events

Events sent from the Bank App to DES via the iframe or WebView.

Complete Schema​

Loading ....

See below for more details on each event.

accountProvisioned​

Loading ....
// Example
{
  "event": "accountProvisioned",
  "message": {
    "requestId": "a2313192-e2dc-452e-b56c-2f23baf6eee1"
  }
}

This message is used to respond to onAccountProvisionRequested when the End User has completed all necessary steps to set up a savings account.

NOTE: Despite it's name, this event merely signals that account provisioning has started but is not necessarily yet completed in the backend.

To signal to DES that account provisioning is finally complete, use the Dreams API instead, see Account Provisioning In a single-account setup

Loading ....
// Example
{
  "event": "navigateTo",
  "message": {
    "location": "/dreams/123"
  }
}

This event can be used to make DES navigate to a certain part of experience. In the above example, DES will navigate to the details page of the dream with id 123.

onBackRequested​

Loading ....
// Example
{
  "event": "onBackRequested",
  "message": {}
}

Make DES navigate back to the previous screen. This is useful if you want to render your own top navigation bar and connect it to DES.

onSignOutRequested​

Loading ....
// Example
{
  "event": "onSignOutRequested",
  "message": {}
}

Force a sign out of the End User. The session cookie is revoked and reset, see Sign Out.

onTransferConsentCancelled​

Loading ....
{
  "event": "onTransferConsentCancelled",
  "message": {
    "requestId": "9876e07a-8aec-422c-845d-c70db7df14aa",
    "consentId": "0b723ca9-4b47-4b6e-84f6-03da8df17f3a",
    "reason": "Something went wrong"
  }
}

This message is sent in response to the onTransferConsentRequested event in case of an error or if the user cancels the flow.

  • requestId should be the same as in the onTransferConsentRequested event
  • consentId should be the same as in the onTransferConsentRequested event
  • reason can be any string denoting the reason for error or cancel (for monitoring and/or debugging purposes only).

onTransferConsentSucceeded​

Loading ....
// Example
{
  "event": "onTransferConsentSucceeded",
  "message": {
    "requestId": "9876e07a-8aec-422c-845d-c70db7df14aa",
    "consentId": "0b723ca9-4b47-4b6e-84f6-03da8df17f3a",
    "consentRef": "<your reference>"
  }
}

This message is sent in response to the onTransferConsentRequested event in case of success.

  • requestId should be the same as in the onTransferConsentRequested event
  • consentId should be the same as in the onTransferConsentRequested event
  • consentRef can be any string reference for the created consent (for monitoring and/or debugging purposes only).

sessionKeepAlive​

Loading ....
// Example
{
  "event": "sessionKeepAlive",
  "message": {}
}

When using Activity-renewed Sessions, this event is sent to make DES prolong the session for another session_inactivity_timeout.

updateToken​

Loading ....
// Example
{
  "event": "updateToken",
  "message": {
    "requestId": "a2313192-e2dc-452e-b56c-2f23baf6eee1",
    "idToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
  }
}

When using Token-renewed sessions, this event is used to respond to onIdTokenDidExpire.

  • requestId param is the same as received in the onIdTokenDidExpire event.
  • idToken is the new ID Token.