Step 6: Create Bank Flow URL

POST

/public/v3/webflow/banks/{bank_slug}/redirect

Create Bank Flow URL. You must direct the customer to their online banking provider via this URL.

For endpoint authorization use Authorization: AppUserToken {customer_token} header. Create customer token to use it in the header.

Parameters

ParameterData typeRequired?Description
bank_slugstringyesBank slug

Query parameters

ParameterData typeRequired?Description
urlstringyesURL to which we will redirect the customer back to your application

Request Body Parameters

ParameterData typeRequired?Description
application_sharing_third_partiesThird PartynoThird party companies that you are going to share customer data with. End Customer must be informed on the Consent Screen with whom are you going to share data. Set to null if you are not going to share data with any third party companies.
application_sharing_purposesSharing PurposenoPurposes of sharing the data. Set to null to use the default sharing purpose description. The default description is "Apply Bank transaction data to improve your financial credibility"

Response Body Parameters

ParameterData typeRequired?Description
urlstringyesBank flow URL. You must direct the customer to their online banking provider via this URL.
consent_idstringyesID of the Bank consent
statestringyesUnique state for current process
transaction_from_date_timeintyesTimestamp since when bank account data will accessed from the bank
transaction_to_date_timeintyesTimestamp till when bank account data will accessed from the bank

Third Party

ParameterData typeRequired?Description
company_namestringyesThird Party Company name
company_addressstringnoThird Party Company address
company_citystringnoThird Party Company city
company_countrystringnoThird Party Company country
company_phonestringnoThird Party Company phone
company_emailstringnoThird Party Company email
company_websitestringnoThird Party Company website

Sharing Purpose

ParameterData typeRequired?Description
descriptionstringyesDescription of the purpose of sharing the data

Request example

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/webflow/banks/{{bank_slug}}/redirect?url=http://example.com:8081/redirect \ --header 'Authorization: AppUserToken {customer_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ "application_sharing_third_parties" : [ { "company_name" : "Quitzon, Shields and Cremin", "company_address" : "7813 Fahey Plain", "company_city" : "Milochester", "company_country" : "Turks and Caicos Islands", "company_phone" : "931-689-5007", "company_email" : "example@example.com", "company_website" : "https://example.com" } ], "application_sharing_purposes": [ { "description": "Blanditiis neque natus qui eius occaecati distinctio." } ] }'

Response example:

1 2 3 4 5 6 7 { "url": "https://bank-url.example.com/redirect", "consent_id": "abc", "state": "abc", "transaction_from_date_time": "1547477571", "transaction_to_date_time": "1649947971" }

Was this article helpful?

Friendly Score UK Ltd.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

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: 781963)