Show Institutions

List of supported banking institutions by SynapseFI

Use this call to get all institutions available for bank logins.

API ENDPOINT

https://uat-api.synapsefi.com/v3.1/institutions

EXAMPLE REQUEST

GET /v3.1/institutions
HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER:|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
client.get_all_inst(page=5, per_page=5)
client.getInstitutions();
client.get_all_institutions(page: 5, per_page: 5)
$client->get_all_institutions();
data, err := client.GetInstitutions()

EXAMPLE RESPONSE

{
  "banks": [
    {
      "bank_code": "ally",
      "bank_name": "Ally Bank",
      "features": [
        "personal_auth",
        "recent_statement",
        "sync"
      ],
      "forgotten_password": "https://www.ally.com/",
      "is_active": true,
      "logo": "https://cdn.synapsepay.com/bank_logos/ally.png",
      "tx_history_months": 18
    },
    {
      ...
    },
    {
      ...
    }
  ],
  "error_code": "0",
  "http_code": "200",
  "success": true
}

Supported Features:

To determine available features for each bank, hit our Show Institutions API call and look under features.

Node Sync

Accounts that support Node Sync (sync) can be synced once every 4 hours and -- if successful -- will update the balance on the node and also pull any new transactions.

Node sync is in the GET node API call. To initiate a node sync, perform the GET request with a url parameter of force_refresh=yes.

Bank Transaction History

Select accounts also return transaction history. A tx_history_months value greater than 0 indicates support.

Just like Node sync, transaction data is in the GET node API call. To access the transactions data, simply perform the GET request with a url parameter of full_dehydrate=yes.‍

Transaction Analysis

GET node API call with full_dehydrate=yes also returns an analyzed transaction summary. This includes information like income streams, recurring withdrawals, recurring bank fees, and a general analysis of recurring credit card payments.

This provides insight into payments that are scheduled to be charged to the account even if they are not initiated through the user’s institution (for example, the card issuer is debiting the user’s account).

Bill Pay Data

Along with transaction data, we also return all the bills a user has linked to their bank. In the long term, our goal is to be able to provide a bill pay migration tool, that would allow customers to switch banks in matter of seconds, making it effortless for customers to be able to move from a external bank to a Synapse deposit account.

Recent Statements

We also return the most recent monthly statement associated with the user’s bank account. This acts like another document check that we can have on file for users for KYC purposes.