Institutions

The institution object represents a financial institution (such as a bank, credit union etc). You can use this object to obtain a list of supported institutions or to get general information about each institution.

Attributes
`type`	Value is "institution".

`id`	A string that uniquely identifies the institution.

`name`	The full name of the institution.

`shortName`	Short name of institution.

`institutionType`	An enum identifying the institution type. Possible values include:

	`Bank` `Bank (Foreign)` `Test Bank` `Credit Union` `Financial Services` `Superannuation`

`country`	Country in which this institution operates. English short name used by ISO 3166/MA.

`serviceName`	Name of the supported service (as defined by the institution).

`serviceType`	Institution* connector: an enum identifying the service type. Possible values include:

	`Personal Banking` `Business Banking` `Card Access` `Test`

`authorization`	Institution* connector: an enum identifying the authorization type. Possible values include:

	`user` - this means you can create a web connection to this institution, we recommend that you only onboard customers to institutions with this authorization type. `user-token` - this means you can create a web connection to this institution by passing a user token instead of user credentials [new] `other` - this means that another authorization method is used for this institution e.g we have a direct API integration which is not publicly available (e.g Regional Australia Bank).

`stage`	Institution* connector: an enum identifying the stage. Possible values include:

	`live` - connector is mature `beta` - connector is complete however is not yet mature new `alpha` - connector is partially complete

`status`	Institution* connector: an enum identifying the status. Active connectors can continue to be used in every status. Possible values include:

	`operational` `under-maintenance` (all `beta` connectors are under continuous improvement until they mature into `live` connectors) `degraded-performance` `partial-outage` `major-outage`

`loginIdCaption`	Institution* connector: caption used by institution to request login id.

`secondaryLoginIdCaption`	Institution* connector: caption used by institution to request secondary login id.

`passwordCaption`	Institution* connector: caption used by institution to request password.

`securityCodeCaption`	Institution* connector: caption used by institution to request security code.

`forgottenPasswordUrl`	Institution* connector: url to forgotten password page

`colors`	Object that contains institution colours (e.g. primary).

`tier`	Institution's tier - a representation of it's business and market share in the relevant country/region. Values range from 1 to 4. Tier 1 are Institutions with the highest impact on the market. For example, CBA is a Tier 1 Bank, Suncorp is a Tier 2 Bank, etc.

`logo`	Object that contains main colors, and URLs of square and full institution logo image, returned in SVG format.

Stats
averageDurationMs	Institution connector statistics are evaluated every 24 hours - to provide average statistics for Jobs occurring in the previous 7 days in milliseconds. Stats are provided for for each job step plus the total.

	`verifyCredentials` `retrieveAccounts` `retrieveTransactions` `retrieveMeta` `total`

Features
`login`	Bank authentication or verify credentials step is supported for this institution connector

`accounts`	Describes the support of Accounts attributes by institution for each data source

	`accountNo` `name` `currency` `balance` `availableFunds` `lastUpdated` `accountHolder` `meta` - mortgage meta data

`transactions`	Describes the support of Transactions attributes by institution for each data source

	`description`\ `date` `amount`\ `balance` `class`

`profile`	Describes the support of Connection with profile data attributes by institution for each data source

	`firstName` `lastName` `middleName` `emailAddresses` `physicalAddresses`

Links
`links`	A links object containing the following members:

	`self` link to the requested institution

{
  "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"
         ],
        "accounts": {
          "accountNo": [
            "web"
          ],
          "name": [
            "web"
          ],
          "currency": [
            "web"
          ],
          "balance": [
            "web"
          ],
          "availableFunds": [
            "web"
          ],
          "lastUpdated": [
            "web"
          ],
          "accountHolder": [
            "web"
          ],
          "meta": [
            "web"
          ]
        },
        "transactions": {
          "status": [
            "web"
          ],
          "description": [
            "web"
          ],
          "date": [
            "web"
          ],
          "amount": [
            "web"
          ],
          "balance": [
            "web"
          ],
          "class": [
            "web"
          ]
        },
        "profile": {
          "fullName": [
            "web"
          ],
          "firstName": [
            "web"
          ],
          "lastName": [
            "web"
          ],
          "middleName": [
            
          ],
          "phoneNumbers": [
            "web"
          ],
          "emailAddresses": [
            "web"
          ],
          "physicalAddresses": [
            "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"
      }
    },
    {
      "type": "institution",
      "id": "AU01001",
      "name": "National Australia Bank Limited*",
      "shortName": "NAB",
      "institutionType": "Bank",
      "country": "Australia",
      "serviceName": "NAB Connect",
      "serviceType": "Personal Banking",
      "loginIdCaption": "NAB ID",
      "passwordCaption": "Password",
      "tier": "1",
      "authorization": "user",
      "features": {
        "login":[
           "web"
         ],
        "accounts": {
          "accountNo": [
            "web",
            "pdf",
            "csv"
          ],
          "name": [
            "web",
            "pdf",
            "csv"
          ],
          "currency": [
            "web",
            "pdf",
            "csv"
          ],
          "balance": [
            "web",
            "pdf",
            "csv"
          ],
          "availableFunds": [
            "web",
            "pdf",
            "csv"
          ],
          "lastUpdated": [
            "web",
            "pdf",
            "csv"
          ],
          "accountHolder": [
            "pdf",
            "csv"
          ],
          "meta": [
            "web",
            "pdf"
          ]
        },
        "transactions": {
          "status": [
            "web",
            "pdf",
            "csv"
          ],
          "description": [
            "web",
            "pdf",
            "csv"
          ],
          "date": [
            "web",
            "pdf",
            "csv"
          ],
          "amount": [
            "web",
            "pdf",
            "csv"
          ],
          "balance": [
            "web",
            "pdf",
            "csv"
          ],
          "class": [
            "web",
            "pdf",
            "csv"
          ]
        },
        "profile": {
          "fullName": [
            "web"
          ],
          "firstName": [
            "web"
          ],
          "lastName": [
            "web"
          ],
          "middleName": [
            
          ],
          "phoneNumbers": [
            "web"
          ],
          "emailAddresses": [
            "web"
          ],
          "physicalAddresses": [
            "web",
            "pdf"
          ]
        }
      },
      "forgottenPasswordUrl": "https://www2.my.commbank.com.au...",
      "stage": "live",
      "status": "operational",
      "stats": {
        "averageDurationMs": {
          "verifyCredentials": 3600,
          "retrieveAccounts": 4500,
          "retrieveTransactions": 2300,
          "retrieveMeta": 1200,
          "total": 11600
        }
      },
      "logo": {
        "type": "image",
        "colors": null,
        "links": {
          "square": "https://d388vpyfrt4zrj.cloudfront.net/AU01001.svg",
          "full": "https://d388vpyfrt4zrj.cloudfront.net/AU01001-full.svg"
        }
      },
      "links": {
        "self": "https://au-api.basiq.io/institutions/AU01001"
      }
    }
  ]
}