Connect URL
Create session links for bank authentications.
Connect URLs are temporary, user-specific links that redirect users to securely authenticate and authorize access to their bank data.
#Create a Connect URL
post/v2/open-banking/connect
Creates a new Connect URL for the specified user.
Request body
- #userstring (uuid)ID of the user object.required
- #webhookstring (url)required
Webhook URL to receive Connect Events.
- #webhook_dataobjectOptional data that will be added to Connect Events webhook payloads. Often used for identifier information.optional
- #single_use_urlbooleanoptional
If
truethe Connect URL link will expire after the user successfully connects their bank data and completes the session. - #redirect_urlstring (url)Redirect users to this URL after they complete the session.optional
Example Request
1curl --request POST \
2 --url https://api.argyle.com/v2/open-banking/connect \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data {
6 "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "webhook": "https://your-webhook-backend.com"
8 }Example Response
1{
2 "open_banking_link": "https://connect_url_link.com"
3}