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 tokento use it in the header.
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| bank_slug | string | yes | Bank slug |
none
| 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" |
| 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 |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| description | string | yes | Description of the purpose of sharing the data |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| name | string | yes | Bank name |
| slug | string | yes | Bank slug |
| logo_url | string | yes | Bank logo URL |
| company_name | string | yes | Your company name |
| application_name | string | yes | Your application name (will be the same as company_name as default) |
| application_sharing_purposes | Sharing Purpose | no | Sharing purpose |
| application_sharing_third_parties | Third Party | yes | Sharing third parties |
| privacy_policy_url | string | yes | URL to Planky's Privacy Policy. Must be included on your Consent Screen |
| terms_and_condition_url | string | yes | URL to Planky's Terms and Conditions. Must be included on your Consent Screen |
| planky_customer_center_url | string | yes | URL to the Planky Customer Center. Must be included on your Consent Screen |
| requested_permissions | array | yes | Array of requested permissions |
| data_access_from | int | yes | Timestamp since when bank account data will accessed from the bank. Default is 5 years |
| data_access_to | int | yes | Timestamp till when bank account data will accessed from the bank. Default is 3 months |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| type | string | yes | Consent type. Allowed values: account_details, account_transactions, account_regular_payments, account_features_and_benefits, additional_information |
| title | string | yes | Human readable consent type |
| elements | array | yes | Array of elements for this consent |
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."
}
]
}'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://planky.com/privacy-policy",
"terms_and_condition_url": "https://planky.com/terms-and-conditions",
"friendlyscore_customer_center_url": "https://customers.planky.com",
"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://customers.planky.com'>Planky Customer Center</a>"
]
}
]
}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)