Supported Institutions

Our platform provides seamless connectivity to a wide range of financial institutions, enabling you to easily integrate financial data into your application. By utilizing our API, you can access a comprehensive list of institutions available for connection

Method: GET

http://api.aggregation.zumrails.com/api/institution/GetInstitutions

{
    "statusCode": 200,
    "message": "GET Request successful.",
    "result": [
        {
            "Id": "2a778283-d87a-4b8c-aa3e-af1ed16bc486",
            "FullName": "Zūm Rails Testing Bank",
            "ShortName": "ZumTest",
            "LogoData": "data:image/png;base64,iVBORw0KGgoAAAANSUhE..",
            "Url": "www.zumrails.com",
            "ConnectUsernameLabel": "Username",
            "ConnectPasswordLabel": "Password",
            "Country": "Canada",
            "ShowAsDefault": true,
            "AllowNewRequests": true,
            "MxOauthSupported": false
        }
    ]
}

Parameter	Type	Description
Id	guid	A unique identifier representing the institution.
FullName	string	The full official name of the financial institution
ShortName	string	A shortened or commonly used name for the institution
Country	string	The country where the institution is available. Represented as a country name (e.g., "Canada").
ShowAsDefault	boolean	Indicates whether the institution should be displayed by default in the institution list. If false, it will only be displayed when explicitly searched by the user.
AllowNewRequests	boolean	Specifies whether new connection requests to this institution are allowed. If false, the institution is currently unavailable for new connections.
MxOauthSupported	boolean	Indicates whether the institution supports OAuth-based authentication for secure connections.

Display single institution

When the institutionid parameter is provided, the Connector skips the institution selection step and navigates directly to the credentials page.

If the consent parameter is also provided:

• If consent=true, the consent page is displayed first, and the credentials page is shown after the user accepts the consent.

• If consent=false, the credentials page is displayed immediately, without showing the consent page.

You can use the Connector Configuration page to configure the institutionid and generate a customized Connector UI URL or Connector SDK payload.

Steps to Configure a Single Institution

1. Open the Connector Configuration page.

2. Select Configure the user experience.

3. Enter the institution ID in the Display Single Institution (one ID only) field.

4. Click Apply to preview the configuration.

5. Click Copy to generate the URL or JSON payload.

After clicking Copy, a sample URL and JSON configuration will be generated with the institutionid parameter included.