v1

latestOpenAPI 3.0.02026-07-2641723.8 KB

Create a Connect URL

Creates a new Connect URL for the specified user.

post/v2/open-banking/connect

Request body

userstring uuid required

ID of the user object.

webhookstring uri required

Webhook URL to receive Connect Events.

webhook_dataobject

Optional data added to Connect Events webhook payloads.

experiencestring

Experience ID that customizes the bank connection experience.

If an experience value is not provided, a default experience configured by the Argyle team will be applied.

single_use_urlboolean

If true, the Connect URL expires after the session completes.

redirect_urlstring uri

Redirect users after they complete the session.

Response

open_banking_linkstring

Connect URL for the user.