Auth New Bank Connection

Start the process to auth and connect a new set of bank accounts to the given user.

This endpoint is intended to be called on your backend, and the URL in the result should then be sent to and opened in a user-facing setting — for example, opened in a web browser (popup, new tab, etc). The URL inside the result will render an HTML document for the user that will guide them through the flow of connecting their bank account. At the end of this flow, they will be redirected back to the URL provided in redirect_url.

When redirecting back to the redirect_url, a query string parameter of status will be included which will have a value of success or error to indicate whether the connection worked. If error, an additional error_reason parameter will be included with a human readable message explaining the error.

⚠️ Warning: The URL returned by this endpoint will expire after 10 minutes for security reasons. Therefore it's important not to embed the link in any communication (eg. emails) or store the link for later use. Instead, direct the user via an endpoint on your side, and when the user hits that endpoint, call this API and redirect the user to the URL it returns immediately.

⚠️ Warning: Do not open the URL given within a WebView on a mobile device. The URL given will ultimately deep-link to open a user's bank app when used on their mobile, but deep-links do not work within a WebView on Android. Strongly prefer opening in a separate browser as a standard URL, and using the redirect_url to deep-link back to your own app at the end of the flow.

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!