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 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 |
|---|---|---|---|
| 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 |
Was this article helpful?
Friendly Score UK Ltd.
41 Luke Street
London EC2A 4DP
Call us on +44 20 3996 3540
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)