Get Bank Consent

GET

/public/v3/customers/{customer_id}/bank/{bank_slug}/consent/account

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID
bank_slugstringyesBank slug - identifier of the bank

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
consent_idstringyesConsent ID provided by bank. Min 1 char.
creation_date_timetimestampyesCreation timestamp
statusstringyesConsent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked
status_update_date_timetimestampyesStatus update timestamp
expiration_date_timetimestampyesSpecified timestamp when the permissions will expire. If it is null, the permissions will not expire.
transaction_from_date_timetimestampyesSpecified timestamp for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction
transaction_to_date_timetimestampyesSpecified timestamp for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.

Request example

1 curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/bank/{bank_slug}/consent/account'

Response example:

1 2 3 4 5 6 7 8 9 { "consent_id": "string", "creation_date_time": "1553077496", "status": "string", "status_update_date_time": "1553077496", "expiration_date_time": "1553077496", "transaction_from_date_time": "1553077496", "transaction_to_date_time": "1553077496" }

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)