API ReferenceGuides
Introduction
Getting Started
Authentication
Changelog
Errors
Pagination

Core Resources

Institutions
Permissions
Linking Accounts
End User
Consents
Auth Session

Banking Api

Introduction
Accounts
Balance
Transactions
Products
Payee
Direct Debits
Scheduled Payments

Energy Api

Introduction
Accounts
Balances
DER
Invoices
Service Points
Usage
Billing
Concessions
Plans
Payment Schedule

Common api

Identity

Institutions

Institutions are commonly known as Data Holders within the Consumer Data Right, they are typically Banks, Credit Unions or Energy Providers who return information about End users. Their response contains media, names and identifiers which can be used for displaying specific information to your End Users. The Fiskil API supports many different institutions and continues to grow and work with more.

Institutions Endpoints

get/v1/institutions
get/v1/institutions/{id}

The Institutions model

Attributes

Expand all
icon
stringrequired

A URL to an icon for the institution

id
stringrequired

The id of the institution

industry
stringrequired

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

Enumerated Values -
banking
energy

is_accessible
booleanoptional

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

name
stringrequired

The name of the institution

priority
integerrequired

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

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
}
GET

/v1/institutions

List all Institutions

Returns a list of all Institutions that are currently supported by Fiskil.

Parameters

industryquerystring

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

Enumerated Values -
banking
energy

client_idquerystringrequired

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

institution_modequerystring

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

Enumerated Values -
recommended

Request
GET/v1/institutions
curl --request GET \
     --url https://api.fiskil.com/v1/institutions?industry={industry}&client_id={client_id}&institution_mode={institution_mode} \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8'
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
    },
    {
        "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
    },
    {
        "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
    }
]
GET

/v1/institutions/{id}

Retrieve an institution

Retrieve an institution based off its ID.

Parameters

idpathstringrequired

The ID of the institution to fetch details of

Request
GET/v1/institutions/{id}
curl --request GET \
     --url https://api.fiskil.com/v1/institutions/{id} \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8'
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
}

Was this page helpful?