plaid

Get details of all supported institutions

Changed on

Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated.

If there is no overlap between an institution's enabled products and a client's enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.

post/institutions/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/institutions/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

countinteger required

The total number of Institutions to return.

offsetinteger required

The number of Institutions to skip.

country_codesCountryCode[] required

Specify which country or countries to include institutions from, using the ISO-3166-1 alpha-2 country code standard.

In API versions 2019-05-29 and earlier, the country_codes parameter is an optional parameter within the options object and will default to [US] if it is not supplied.

Response

OK

totalinteger required

The total number of institutions available via this endpoint

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property /// became optional for the status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • e07a869352e8Revision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property /// to the response with the status