API Documentation
GET /institutions
List all financial institutions available, sorted alphabetically. The "id" fields in the response are to be used with the POST /accounts request.
The response of this endpoint is paginated. If the response is an empty list then you've reached the last page.
Headers
| NAME |
VALUE |
| Authorization |
Bearer {JWT} |
URL parameters
| NAME |
VALUE |
| offset |
integer. Default 0. |
| limit |
integer. Default 1000. Maximum allowed 1000. |
Response
| NAME |
VALUE |
| institutions |
JSON array. |
| institutions[].id |
string. To be used with POST /accounts. |
| institutions[].name |
Human readable name for the institutions. |
| institutions[].oauth |
boolean. True if the connection to this institution is according to OAuth RFC. |
| institutions[].logo |
URL for the institution icon. |
Response status
| CODE |
VALUE |
| 200 |
OK |
| 401 |
Not authorized |
| 403 |
Forbidden |
