Get Bank Consent
GET
/public/v3/customers/{customer_id}/bank/{bank_slug}/consent/account
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| customer_id | string | yes | Customer ID |
| bank_slug | string | yes | Bank slug - identifier of the bank |
none
none
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| consent_id | string | yes | Consent ID provided by the bank. Min 1 char. |
| creation_date_time | timestamp | yes | Creation timestamp |
| status | string | yes | Consent status, one of: Rejected, Awaiting Authorisation, Authorised, Revoked |
| status_update_date_time | timestamp | yes | Status update timestamp |
| expiration_date_time | timestamp | yes | Specified timestamp when the permissions will expire. If it is null, the permissions will not expire. |
| transaction_from_date_time | timestamp | yes | Specified 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_time | timestamp | yes | Specified 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. |
| consent_reconfirmation_date | timestamp | yes | Specified timestamp for the consent reconfirmation date. Consent must be reconfirmed by the end customer every 90 days. The bank feed will not be updated if you do not reconfirm with end customer consent every 90 days. |
1
2
3
curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/bank/{bank_slug}/consent/account' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}'1
2
3
4
5
6
7
8
9
10
{
"consent_id": "string-123",
"creation_date_time": 1724074149,
"status": "Authorised",
"status_update_date_time": 1724074175,
"expiration_date_time": null,
"transaction_from_date_time": 1708349349,
"transaction_to_date_time": 1732022949,
"consent_reconfirmation_date": 1737115749
}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)