Skip to main content
POST
/
v2
/
open-banking
/
connect
Create a Connect URL
curl --request POST \
  --url https://api-sandbox.argyle.com/v2/open-banking/connect \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "webhook": "https://your-webhook-backend.com"
}
'
{
  "open_banking_link": "https://connect_url_link.com"
}

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
​
open_banking_link
string

Connect URL for the user.