Step 5: Create Consent Screen

POST

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

Creates all the necessary metadata and consent descriptions to build the Consent Screen that will be displayed back to the customer

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

none

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
metadataMetadatayesConsent Screen Metadata
consentsConsentyesReady to use consent descriptions

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

Metadata

ParameterData typeRequired?Description
namestringyesBank name
slugstringyesBank slug
logo_urlstringyesBank logo URL
company_namestringyesYour company name
application_namestringyesYour application name (will be the same as company_name as default)
application_sharing_purposesSharing PurposenoSharing purpose
application_sharing_third_partiesThird PartyyesSharing third parties
privacy_policy_urlstringyesURL to FriendlyScore's Privacy Policy. Must be included on your Consent Screen
terms_and_condition_urlstringyesURL to FriendlyScore's Terms and Conditions. Must be included on your Consent Screen
friendlyscore_customer_center_urlstringyesURL to the FriendlyScore Customer Center. Must be included on your Consent Screen
requested_permissionsarrayyesArray of requested permissions
data_access_fromintyesTimestamp since when bank account data will accessed from the bank. Default is 5 years
data_access_tointyesTimestamp till when bank account data will accessed from the bank. Default is 3 months

Consent

ParameterData typeRequired?Description
typestringyesConsent type. Allowed values: account_details, account_transactions, account_regular_payments, account_features_and_benefits, additional_information
titlestringyesHuman readable consent type
elementsarrayyesArray of elements for this consent

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}}/consent \ --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 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 { "metadata": { "name": "Natwest Sandbox", "slug": "natwest-sandbox", "logo_url": "https://api.friendlyscore.com/bank-logos/x3/nationwide@3x.png", "company_name": "Special", "application_name": "Special", "application_sharing_purposes": [ { "description": "Optio nisi eius." } ], "application_sharing_third_parties": [ { "company_name": "Rohan, Feest and O'Connell", "company_address": "011 Zander Rest", "company_city": "New Jacques", "company_country": "Virgin Islands, U.S.", "company_phone": "522-424-1201", "company_email": "Antonette_Predovic24@hotmail.com", "company_website": "http://franz.com" } ], "privacy_policy_url": "https://friendlyscore.com/privacy-policy", "terms_and_condition_url": "https://friendlyscore.com/terms-and-conditions", "friendlyscore_customer_center_url": "https://friendlyscore.com/customer-center", "requested_permissions": [ "ReadAccountsBasic", "ReadAccountsDetail", "ReadBalances", "ReadBeneficiariesBasic", "ReadBeneficiariesDetail", "ReadDirectDebits", "ReadTransactionsCredits", "ReadTransactionsDebits", "ReadTransactionsDetail" ], "data_access_from": 1547473284, "data_access_to": 1649943684 }, "consents": [ { "type": "account_details", "title": "Your account details", "elements": [ "Your account number, sort code and balance", "Any other name by which you refer to this account" ] }, { "type": "account_transactions", "title": "Your account transactions", "elements": [ "Incoming and outgoing transactions " ] }, { "type": "account_regular_payments", "title": "Your regular payments", "elements": [ "Direct debits and standing orders", "Other payee agreements" ] }, { "type": "account_features_and_benefits", "title": "Your account features and benefits", "elements": [ "Fees, charges and interest rates", "Credit interest and overdraft limits", "Offers available on your account" ] }, { "type": "additional_information", "title": "Additional information", "elements": [ "By consenting, your account information will be shared with Special so they will have access to your account information.", "Special needs your account information for Apply Bank transaction data to improve your financial credibility", "You are giving permission to view your account information for 90 days.", "We will collect your account information from your bank for the previous 36 months", "You can stop sharing your account information at any time by cancelling consent via your online banking or by visiting <a href='https://friendlyscore.com/customer-center'>FriendlyScore Customer Center</a>" ] } ] }

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)