Skip to main content
GET
/
v3
/
{customerId}
/
BankingServices
/
Institutions
Get Institutions
curl --request GET \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices/Institutions
{
  "Data": [
    {
      "Id": 1,
      "Localizations": [
        {
          "Language": "fr",
          "Name": "BMO",
          "Urls": [
            {
              "Type": "Main",
              "Url": "https://www.bmo.com/principal/particuliers"
            }
          ]
        },
        {
          "Language": "en",
          "Name": "BMO",
          "Urls": [
            {
              "Type": "Main",
              "Url": "https://www.bmo.com/main/personal"
            }
          ]
        }
      ],
      "Status": "Enabled",
      "Country": "CA"
    },
    {
      "Id": 2,
      "Localizations": [
        {
          "Language": "en",
          "Name": "Desjardins",
          "Urls": [
            {
              "Type": "Main",
              "Url": "https://www.desjardins.com/ca/index.jsp"
            }
          ]
        },
        {
          "Language": "fr",
          "Name": "Desjardins",
          "Urls": [
            {
              "Type": "Main",
              "Url": "https://www.desjardins.com/index.jsp"
            }
          ]
        }
      ],
      "Status": "Enabled",
      "Country": "CA"
    }
  ],
  "Count": 249
}
/Institutions allows retrieval of all available institutions and their details. This includes identifiers used by both Flinks Connect and Flinks API while handling connections. Each institution can be identified by its Id, localized Name and Url, and it is segmented by Country. The response is limited to a maximum of 1000 items, and the parameters skip, take and API response field Count must be used to control iterations.

Headers

​
x-api-key
string

Security feature that grants access to this endpoint.

Path Parameters

​
customerId
string
default:43387ca6-0391-4c82-857d-70d95f087ecb
required

Unique GUID provided by Flinks.

Query Parameters

​
skip
integer
default:0

The number of records to skip.

​
take
integer
default:10

The number of records to return.

​
countries
string

Return institutions filtered by country.

​
routingNumbers
string

Return institutions filtered by routing numbers.

Response

200 - application/json

Result

​
Data
object[]
​
Count
integer

Total count of institutions matching the query.