API
← Back HomeNPMDeveloper HubAPIBlog

List all institutions

Use this collection to retrieve a list of institutions. Each entry in the array is a separate institution object.

filter
optional

This list can be filtered by the following properties:

  • country

  • tier

  • serviceType

  • institutionType

  • stage

Only equals (eq) and not equals (ne) operations are currently supported.

GET /institutions

GET /institutions HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN

HTTP/1.11.1 200 OK
Content-TypeContent-Type::  application/jsonapplication/json

{
  "type": "list",
  "totalCount": 56,
  "data": [
    {
      "type": "institution",
      "id": "AU00000",
      "name": "Hooli Bank",
      "shortName": "Hooli",
      "institutionType": "Test Bank",
      "country": "Australia",
      "serviceName": "Personal Online Banking",
      "serviceType": "Personal Banking",
      "loginIdCaption": "Login",
      "passwordCaption": "Password",
      "tier": "4",
      "authorization": "user",
      "features": {
        "login":[
           "web"
         ],
        "mfaChallenge": [],
        "accounts": {
          "accountNo": [
            "web"
          ],
          "name": [
            "web"
          ],
          ...
        },
        "transactions": {
          "status": [
            "web"
          ],
          "description": [
            "web"
          ],
          ...
        },
        "profile": {
          "fullName": [
            "web"
          ],
          "firstName": [
            "web"
          ],
          ...
        }
      },
      "forgottenPasswordUrl": "https://hooli.com.au/forgotten...",
      "stage": "beta",
      "status": "under-maintenance",
      "stats": {
        "averageDurationMs": {
          "verifyCredentials": 3600,
          "retrieveAccounts": 4500,
          "retrieveTransactions": 2300,
          "retrieveMeta": 1200,
          "total": 11600
        }
      },
      "logo": {
        "type": "image",
        "colors": null,
        "links": {
          "square": "https://d388vpyfrt4zrj.cloudfront.net/AU00000.svg",
          "full": "https://d388vpyfrt4zrj.cloudfront.net/AU00000-full.svg"
        }
      },
      "links": {
        "self": "https://au-api.basiq.io/institutions/AU00000"
      }
    },
 }