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 tokento use it in the header.

Parameters

Parameter	Data type	Required?	Description
bank_slug	string	yes	Bank slug

Query parameters

Parameter	Data type	Required?	Description
url	string	yes	URL to which we will redirect the customer back to your application

Request Body Parameters

Parameter	Data type	Required?	Description
application_sharing_third_parties	Third Party	no	Third 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_purposes	Sharing Purpose	no	Purposes 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

Parameter	Data type	Required?	Description
url	string	yes	Bank flow URL. You must direct the customer to their online banking provider via this URL.
consent_id	string	yes	ID of the Bank consent
state	string	yes	Unique state for current process
transaction_from_date_time	int	yes	Timestamp since when bank account data will accessed from the bank
transaction_to_date_time	int	yes	Timestamp till when bank account data will accessed from the bank

Third Party

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

Sharing Purpose

Parameter	Data type	Required?	Description
description	string	yes	Description of the purpose of sharing the data

Request example

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:

{
    "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.

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)