Get Account Connect Url
POST
/public/v3/customers/{customer_id}/account-connect
Account Connect is the simple way to get a ready-to-use UX/UI for sharing data with banks, without the need to handle the full API integration UX/UI yourself. You just need to provide a few details about the purpose of data sharing and any third-party companies involved (if the data will be shared with third parties), and the API will return a ready-to-use URL. You can also specify a redirect URL in the query parameters. After the bank connection process is complete, we will redirect the customer back to the provided URL.
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| customer_id | string | yes | Customer ID |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| redirectUrl | string | no | Redirect URL |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| application_sharing_third_parties | Third Party | no | Third party companies that will receive shared customer data. The end customer must be informed on the Consent Screen about which companies will receive their data. Send an empty array if you will not share data with any third party companies. |
| application_sharing_purposes | Sharing Purpose | no | Purposes for sharing the data. Send an empty array to use the default sharing purpose description. The default description is "Apply bank transaction data to improve your financial credibility" |
Array of third-party companies that will receive shared customer data. Send an empty array if you will not share data with any third-party companies.
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| company_name | string | yes | Third Party Company name |
| company_address | string | no | Third Party Company address |
| company_city | string | no | Third Party Company city |
| company_country | string | no | Third Party Company country |
| company_phone | string | no | Third Party Company phone |
| company_email | string | no | Third Party Company email |
| company_website | string | no | Third Party Company website |
Purposes for sharing the data. Send an empty array to use the default sharing purpose description. The default description is"Apply bank transaction data to improve your financial credibility".
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| description | string | yes | Description of the purpose of sharing the data |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| url | string | yes | URL of the One Time Javascript URL |
| created_at | integer | yes | Timestamp of creation |
| expires_in | integer | yes | Timestamp of expiration |
| flow | array<string> | yes | Returns always: open-banking |
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --location --request POST 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/account-connect?redirectUrl=http://your-website.comt' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
"application_sharing_third_parties" : [
{
"company_name" : "Rippin Inc",
"company_address" : "415 Nelson Springs",
"company_city" : "South Hayleefurt",
"company_country" : "Rwanda",
"company_phone" : "245-219-4687",
"company_email" : "Ethan98@gmail.com",
"company_website" : "https://diego.org"
}
],
"application_sharing_purposes": [
{
"description": "Quo aut aut dolor ea accusamus tempora fugiat aut quae."
}
]
}'1
2
3
4
5
6
7
8
{
"url": "https://connect.planky.com/abc-123-456-789",
"created_at": 1741334694,
"expires_in": 3600,
"flow": [
"open_banking"
]
}}Was this article helpful?
Friendly Score UK Ltd.
84 Brook Street
London W1K 5EH
Call us on +44 20 3709 6726
Company registered in England
Company number 09168668, ICO ZA111687
VAT registration number 206 9758 80
Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)