Skip to main content
POST
Create a Connect URL

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
user
string<uuid>
required

ID of the user object.

webhook
string<uri>
required

Webhook URL to receive Connect Events.

webhook_data
object

Optional data added to Connect Events webhook payloads.

experience
string

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_url
boolean

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

redirect_url
string<uri>

Redirect users after they complete the session.

Response

200 - application/json

Connect URL for the user.