Retrieve Bank Consents
GET {{base_url}}/banking/v2/consents
Bank consents can be retrieved by filtering by bankId. This filter can be used in combination with companyId to search your application users' consents.
The consent response will include the date of authorisation and the status.
Query parameters
| Field | Type | Description |
|---|
| bankId | integer | Unique identifier for the bank |
| pageId | string | Page offset of results |
Attributes
| Field | Type | Description |
|---|
| companyId | string | Unique identifier for the company |
| permissions | string | {READALLBANKDATA (download all bank data), READACCOUNTSDETAIL (download account details only)} |
| expiryDate | datetime | Date when the consent expires |
| consentId | string | Unique consent id returned by the bank |
| bankId | integer | Unique id for the bank |
| authorisedDate | datetime | Date when authorisation was provided by the user |
| status | string | Status of consent {Authorised, AwaitingAuthorisation, Rejected} |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid bankId | 403 Forbidden | |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | Page offset of results |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
Authorization | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"results":[{"companyId":"CompanyID1234","permissions":"READALLBANKDATA","consentId":"ConsentID12","bankId":6,"status":"AwaitingAuthorisation"},{"companyId":"CompanyID5678","expiryDate":"2021-01-06T17:28:14.759Z","permissions":"READACCOUNTSDETAIL","consentId":"ConsentID34","bankId":6,"authorisedDate":"2020-10-08T17:28:14.759Z","status":"Authorised"},{"companyId":"CompanyID9878","permissions":"READALLBANKDATA","consentId":"ConsentID98","bankId":6,"status":"Rejected"}],"links":{}}