plaid

Get details of an institution

Changed on

Returns a JSON response containing details on a specified financial institution.

Institutions that Plaid does not support for new connections are still returned by this endpoint, so that an institution_id stored on an existing Item can still be looked up. These institutions are not returned by /institutions/get or /institutions/search, and attempting to create a new Item for one of them returns an INSTITUTION_NO_LONGER_SUPPORTED error. Use connection_availability to tell the two cases apart.

Versioning note: API versions 2019-05-29 and earlier allow use of the public_key parameter instead of the client_id and secret to authenticate to this endpoint. The public_key has been deprecated; all customers are encouraged to use client_id and secret instead.

post/institutions/get_by_id

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/institutions/get_by_id
  • 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.

institution_idstring required

The ID of the institution to get details about

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

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