Get Bank Consent

GET

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

Parameters

Parameter	Data type	Required?	Description
customer_id	string	yes	Customer ID
bank_slug	string	yes	Bank slug - identifier of the bank

Query parameters

none

Request Body Parameters

none

Response Body Parameters

Parameter	Data type	Required?	Description
consent_id	string	yes	Consent ID provided by bank. Min 1 char.
creation_date_time	timestamp	yes	Creation timestamp
status	string	yes	Consent status, one of: Rejected, AwaitingAuthorisation, 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.

Request example

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}'

Response example:

{
  "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.

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)