Get Consent status

GET

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

Get the status of the customer consent for bank account data

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

Parameters

ParameterData typeRequired?Description
bank_slugstringyesBank slug

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
consent_idstringyesID of the customer consent for bank account data
creation_date_timeintyesCreation timestamp of the consent
statusstringyesStatus of the customer consent. Allowed values: Authorised, AwaitingAuthorisation, Rejected, Revoked
status_update_date_timeintyesUpdate timestamp of the consent
permissionsarrayyesArray of permissions which were requested
expiration_date_timeintnoTimestamp of consent expiration. Can be null.
transaction_from_date_timeintyesTimestamp since when bank account data will accessed from the bank. By default Planky tries to pull 5 years of the data. Note that banks can restrict data history to a specific period.
transaction_to_date_timeintyesTimestamp till when bank account data will accessed from the bank. By default it is 3 months.

Request example

Response example:

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)