Direct Connection Users

You can ask users to connect to open banking on your own product via the D•One co-branded Direct Connection journey. The user journey begins on your product. The user is then asked to connect on the D•One co-branded connection journey, and is then retuned to your product.

⚠️

Be aware If you're integrating via a marketplace, you won't need to manage this journey—it's handled entirely by the marketplace. Please visit marketplace integration page.

The user flow

The journey begins when you ask a user to connect their bank account on your product. They will be directed to the D•One co-branded Direct Connection journey which features your branding colours and logo. In this flow, they will provide consent, and connect their bank account. They will then be redirected back to your product.

Integration Options

There are two ways to integrate the Direct Connection journey with your product. In both cases, you will need to create a user and then create a session. The session creates a connectionURL, which is used to launch the journey.

1. Embedded Integration (Recommended)

For a seamless user experience, you can embed the Direct Connection journey directly into your website using our Embedded Connection Journey package. This approach keeps users on your domain throughout the entire connection process.

The package will handle launching the journey in an iframe and communication between the iframe and your website. It will also report back to you when the user exits the journey or faces an error, allowing you to handle these cases accordingly. When the user completes the journey, the package will redirect them to the partnerRedirectUrl.

2. Click-out Integration

You can redirect the user to the connectionUrl in a new tab or window to connect their bank account. The user will be redirected to the partnerRedirectUrl when they have completed the journey.

Users

A User object represents a user and should be reused whenever performing actions against the D•One API for the same individual.

Sessions

Sessions are short lived objects representing a user journey on the D•One Open Banking journey. When a session is created two URLs are returned. These URLs can be used for both embedded and click-out integration methods.

The two URLs returned are as follows:

• connectionUrl
  • This is recommended if this is the user's first time using our service as it will take them through connecting a bank account for the first time.
• managementUrl
  • This is recommended if this is not the user's first time using our service as it will take them directly to a list of their current Open Banking connections. The user can then add more bank accounts, re-authenticate their bank accounts, or unlink current connected bank accounts.

The URLs will have a partnerToken attached to the query string which is used to authenticate the user when they enter the D•One journey.

Sessions have a token associated with them which are only valid for 48 hours. After the time elapses the token will expire and the URL will no longer work; a new one will need to be generated.

When a user is done with the D•One journey, they will be returned to the partnerRedirectUrl, provided when the session was created. A sessionTerminationToken will be appended to this URL which can be used to re-identify the user using this token along with the complete session endpoint. The userId will be returned.

An overview of the call sequences can be seen below.