# 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`

```json
{
    "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
        }
    ]
}

```

<table><thead><tr><th width="177.00006103515625">Parameter</th><th width="117.199951171875">Type</th><th>Description</th></tr></thead><tbody><tr><td>Id</td><td>guid</td><td>A unique identifier representing the institution.</td></tr><tr><td>FullName</td><td>string</td><td>The full official name of the financial institution</td></tr><tr><td>ShortName</td><td>string</td><td>A shortened or commonly used name for the institution</td></tr><tr><td>Country</td><td>string</td><td>The country where the institution is available. Represented as a country name (e.g., "Canada").</td></tr><tr><td>ShowAsDefault</td><td>boolean</td><td>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.</td></tr><tr><td>AllowNewRequests</td><td>boolean</td><td>Specifies whether new connection requests to this institution are allowed. If false, the institution is currently unavailable for new connections.</td></tr><tr><td>MxOauthSupported</td><td>boolean</td><td>Indicates whether the institution supports OAuth-based authentication for secure connections.</td></tr></tbody></table>

### 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.

<figure><img src="https://1258268478-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKJSaSy1sLkMkigNL7ONH%2Fuploads%2Fxyqkzcw4qFcCosyio7AM%2Fimage.png?alt=media&#x26;token=9b074f02-5aec-4d41-9595-a61a80b477b7" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://1258268478-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKJSaSy1sLkMkigNL7ONH%2Fuploads%2FP6h9pEydARDbvhn13T1h%2Fimage.png?alt=media&#x26;token=13a77674-5ff2-4b09-b3de-f6a89a0fc6fd" alt=""><figcaption></figcaption></figure>