institutions
public
v1
v2
v3

List institutions by client front-door

Gets a list of institutions a client subscribes to.

get/institutions

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/institutions
  • Auth: none required

Query parameters

industry'banking' | 'energy'

The type of the institution e.g. “banking” or “energy”

Example:energy
client_idstring required

Your team ID. You can get this from the settings menu of the Fiskil Console

Example:your-team-id
sess_idstring

The auth session id

Example:Et est quia enim ducimus.
institution_mode'recommended'

The institution mode. If set to recommended, will load recommended institution data only

Example:recommended

Response

OK response.

iconstring required

A URL to an icon for the institution

idstring required

The id of the institution

industry'banking' | 'energy' required

The industry of the institution e.g. “banking” or “energy”

is_accessibleboolean

Whether this institution is accessible by the teamID. Determines if institution can be used

logostring required

A URL to the logo of the institution

namestring required

The name of the institution

priorityinteger required

The order that this institution will appear in during an auth session

Example response

[
  {
    "icon": "https://eastpaclogo.com.au/eastpac-icon.svg",
    "id": "22",
    "industry": "banking",
    "is_accessible": true,
    "logo": "https://eastpaclogo.com.au/eastpac.svg",
    "name": "Eastpac",
    "priority": 1,
    "status": {
      "connections": {
        "status": "OUTAGE"
      }
    }
  },
  {
    "icon": "https://eastpaclogo.com.au/eastpac-icon.svg",
    "id": "22",
    "industry": "banking",
    "is_accessible": true,
    "logo": "https://eastpaclogo.com.au/eastpac.svg",
    "name": "Eastpac",
    "priority": 1,
    "status": {
      "connections": {
        "status": "OUTAGE"
      }
    }
  },
  {
    "icon": "https://eastpaclogo.com.au/eastpac-icon.svg",
    "id": "22",
    "industry": "banking",
    "is_accessible": true,
    "logo": "https://eastpaclogo.com.au/eastpac.svg",
    "name": "Eastpac",
    "priority": 1,
    "status": {
      "connections": {
        "status": "OUTAGE"
      }
    }
  },
  {
    "icon": "https://eastpaclogo.com.au/eastpac-icon.svg",
    "id": "22",
    "industry": "banking",
    "is_accessible": true,
    "logo": "https://eastpaclogo.com.au/eastpac.svg",
    "name": "Eastpac",
    "priority": 1,
    "status": {
      "connections": {
        "status": "OUTAGE"
      }
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.