Institutions endpoints
Fetch data about supported institutions
The interface for these endpoints has changed in a recent API release. If you are using an API version prior to 2020-09-14, make sure to select the version you are using from the API dropdown at the top of the page. For more information, see API versioning.
Introduction
Institutions endpoints support querying all institutions, as well as looking up a single institution to retrieve up-to-date information about its health status. For non-programmatic access to institution information, the status dashboard provides a browsable view of institutions, supported products, and institution health.
Institution coverage
To see which institutions are supported, or to look up the status of a specific institution, use the Institution status dashboard. You can also query this information programmatically via the /institutions/get
and /institutions/search
endpoints.
Plaid supports over 11,500 institutions across North America and Europe. Supported countries are:
- United States (US)
- Canada (CA)
- United Kingdom (GB)
- Ireland (IE)
- France (FR)
- Spain (ES)
- Netherlands (NL)
- Germany (DE) (for Payment Initiation only)
By default, you receive access to institutions in all countries in Sandbox and Development, and to United States and Canada in Production. To gain access to additional countries in Production, file a product access Support ticket.
For a list of which products are supported for each country, see Global coverage. Beta products (Income, Transfer, and Deposit Switch) are currently US only.
/institutions/get
Get details of all supported institutions
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.
Request fields and example
client_id string 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. | ||||||
secret string 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. | ||||||
count requiredinteger The total number of Institutions to return. Minimum: 1 Maximum: 500 | ||||||
offset requiredinteger The number of Institutions to skip. Minimum: 0 | ||||||
country_codes required[string] Specify an array of Plaid-supported country codes this institution supports, 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.Min items: 1 Possible values: US , GB , ES , NL , FR , IE , CA , DE , IT | ||||||
options object An optional object to filter /institutions/get results.
|
1// Pull institutions2const request: InstitutionsGetRequest = {3 count: 10,4 offset: 0,5 country_codes: ['US'],6};7try {8 const response = await plaidClient.institutionsGet(request);9 const institutions = response.data.institutions;10} catch (error) {11 // Handle error12}
Response fields and example
institutions [object] A list of Plaid institutions
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total integer The total number of institutions available via this endpoint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1{2 "institutions": [3 {4 "country_codes": [5 "US"6 ],7 "institution_id": "ins_1",8 "name": "Bank of America",9 "products": [10 "assets",11 "auth",12 "balance",13 "transactions",14 "identity",15 "liabilities"16 ],17 "routing_numbers": [18 "011000138",19 "011200365",20 "011400495"21 ],22 "oauth": false,23 "status": {24 "item_logins": {25 "status": "HEALTHY",26 "last_status_change": "2019-02-15T15:53:00Z",27 "breakdown": {28 "success": 0.9,29 "error_plaid": 0.01,30 "error_institution": 0.0931 }32 },33 "transactions_updates": {34 "status": "HEALTHY",35 "last_status_change": "2019-02-12T08:22:00Z",36 "breakdown": {37 "success": 0.95,38 "error_plaid": 0.02,39 "error_institution": 0.03,40 "refresh_interval": "NORMAL"41 }42 },43 "auth": {44 "status": "HEALTHY",45 "last_status_change": "2019-02-15T15:53:00Z",46 "breakdown": {47 "success": 0.91,48 "error_plaid": 0.01,49 "error_institution": 0.0850 }51 },52 "identity": {53 "status": "DEGRADED",54 "last_status_change": "2019-02-15T15:50:00Z",55 "breakdown": {56 "success": 0.42,57 "error_plaid": 0.08,58 "error_institution": 0.559 }60 },61 "investments": {62 "status": "HEALTHY",63 "last_status_change": "2019-02-15T15:53:00Z",64 "breakdown": {65 "success": 0.89,66 "error_plaid": 0.02,67 "error_institution": 0.0968 },69 "liabilities": {70 "status": "HEALTHY",71 "last_status_change": "2019-02-15T15:53:00Z",72 "breakdown": {73 "success": 0.89,74 "error_plaid": 0.02,75 "error_institution": 0.0976 }77 }78 },79 "investments_updates": {80 "status": "HEALTHY",81 "last_status_change": "2019-02-12T08:22:00Z",82 "breakdown": {83 "success": 0.95,84 "error_plaid": 0.02,85 "error_institution": 0.03,86 "refresh_interval": "NORMAL"87 }88 },89 "liabilities_updates": {90 "status": "HEALTHY",91 "last_status_change": "2019-02-12T08:22:00Z",92 "breakdown": {93 "success": 0.95,94 "error_plaid": 0.02,95 "error_institution": 0.03,96 "refresh_interval": "NORMAL"97 }98 }99 }100 }101 ],102 "request_id": "tbFyCEqkU774ZGG",103 "total": 11384104}
Was this helpful?
/institutions/get_by_id
Get details of an institution
Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
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.
Request fields and example
client_id string 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. | ||||
secret string 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_id requiredstring The ID of the institution to get details about Min length: 1 | ||||
country_codes required[string] Specify an array of Plaid-supported country codes this institution supports, 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.Possible values: US , GB , ES , NL , FR , IE , CA , DE , IT | ||||
options object Specifies optional parameters for /institutions/get_by_id . If provided, must not be null .
|
1const request: InstitutionsGetByIdRequest = {2 institution_id: insitutionID,3 country_codes: ['US'],4};5try {6 const response = await plaidClient.institutionsGetById(request);7 const institution = response.data.institution;8} catch (error) {9 // Handle error10}
Response fields and example
institution object Details relating to a specific financial institution
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1{2 "institution": {3 "country_codes": [4 "US"5 ],6 "institution_id": "ins_109512",7 "name": "Houndstooth Bank",8 "products": [9 "auth",10 "balance",11 "identity",12 "transactions"13 ],14 "routing_numbers": [15 "011000138",16 "011200365",17 "011400495"18 ],19 "oauth": false,20 "status": {21 "item_logins": {22 "status": "HEALTHY",23 "last_status_change": "2019-02-15T15:53:00Z",24 "breakdown": {25 "success": 0.9,26 "error_plaid": 0.01,27 "error_institution": 0.0928 }29 },30 "transactions_updates": {31 "status": "HEALTHY",32 "last_status_change": "2019-02-12T08:22:00Z",33 "breakdown": {34 "success": 0.95,35 "error_plaid": 0.02,36 "error_institution": 0.03,37 "refresh_interval": "NORMAL"38 }39 },40 "auth": {41 "status": "HEALTHY",42 "last_status_change": "2019-02-15T15:53:00Z",43 "breakdown": {44 "success": 0.91,45 "error_plaid": 0.01,46 "error_institution": 0.0847 }48 },49 "identity": {50 "status": "DEGRADED",51 "last_status_change": "2019-02-15T15:50:00Z",52 "breakdown": {53 "success": 0.42,54 "error_plaid": 0.08,55 "error_institution": 0.556 }57 },58 "investments": {59 "status": "HEALTHY",60 "last_status_change": "2019-02-15T15:53:00Z",61 "breakdown": {62 "success": 0.89,63 "error_plaid": 0.02,64 "error_institution": 0.0965 },66 "liabilities": {67 "status": "HEALTHY",68 "last_status_change": "2019-02-15T15:53:00Z",69 "breakdown": {70 "success": 0.89,71 "error_plaid": 0.02,72 "error_institution": 0.0973 }74 }75 },76 "investments_updates": {77 "status": "HEALTHY",78 "last_status_change": "2019-02-12T08:22:00Z",79 "breakdown": {80 "success": 0.95,81 "error_plaid": 0.02,82 "error_institution": 0.03,83 "refresh_interval": "NORMAL"84 }85 },86 "liabilities_updates": {87 "status": "HEALTHY",88 "last_status_change": "2019-02-12T08:22:00Z",89 "breakdown": {90 "success": 0.95,91 "error_plaid": 0.02,92 "error_institution": 0.03,93 "refresh_interval": "NORMAL"94 }95 }96 },97 "primary_color": "#004966",98 "url": "https://plaid.com",99 "logo": null100 },101 "request_id": "m8MDnv9okwxFNBV"102}
Was this helpful?
/institutions/search
Search institutions
Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
Versioning note: API versions 2019-05-29 and earlier allow use of the public_key
parameter instead of the client_id
and secret
parameters to authenticate to this endpoint. The public_key
parameter has since been deprecated; all customers are encouraged to use client_id
and secret
instead.
Request fields and example
client_id string 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. | |||||||
secret string 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. | |||||||
query requiredstring The search query. Institutions with names matching the query are returned Min length: 1 | |||||||
products required[string] Filter the Institutions based on whether they support all products listed in products . Provide null to get institutions regardless of supported products. Note that when auth is specified as a product, if you are enabled for Instant Match or Automated Micro-deposits, institutions that support those products will be returned even if auth is not present in their product array.Min items: 1 Possible values: assets , auth , balance , employment , identity , income_verification , investments , liabilities , payment_initiation , standing_orders , transactions , transfer | |||||||
country_codes required[string] Specify an array of Plaid-supported country codes this institution supports, 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.Possible values: US , GB , ES , NL , FR , IE , CA , DE , IT | |||||||
options object An optional object to filter /institutions/search results.
|
1const request: InstitutionsSearchRequest = {2 query: institutionID,3 products: ['transactions'],4 country_codes: ['US'],5};6try {7 const response = await plaidClient.institutionsSearch(request);8 const institutions = response.data.institutions;9} catch (error) {10 // Handle error11}
Response fields and example
institutions [object] An array of institutions matching the search criteria
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1{2 "institutions": [3 {4 "country_codes": [5 "US"6 ],7 "institution_id": "ins_118923",8 "name": "Red Platypus Bank - Red Platypus Bank",9 "products": [10 "assets",11 "auth",12 "balance",13 "transactions",14 "identity"15 ],16 "routing_numbers": [17 "011000138",18 "011200365",19 "011400495"20 ],21 "oauth": false,22 "status": {23 "item_logins": {24 "status": "HEALTHY",25 "last_status_change": "2019-02-15T15:53:00Z",26 "breakdown": {27 "success": 0.9,28 "error_plaid": 0.01,29 "error_institution": 0.0930 }31 },32 "transactions_updates": {33 "status": "HEALTHY",34 "last_status_change": "2019-02-12T08:22:00Z",35 "breakdown": {36 "success": 0.95,37 "error_plaid": 0.02,38 "error_institution": 0.03,39 "refresh_interval": "NORMAL"40 }41 },42 "auth": {43 "status": "HEALTHY",44 "last_status_change": "2019-02-15T15:53:00Z",45 "breakdown": {46 "success": 0.91,47 "error_plaid": 0.01,48 "error_institution": 0.0849 }50 },51 "identity": {52 "status": "DEGRADED",53 "last_status_change": "2019-02-15T15:50:00Z",54 "breakdown": {55 "success": 0.42,56 "error_plaid": 0.08,57 "error_institution": 0.558 }59 },60 "investments": {61 "status": "HEALTHY",62 "last_status_change": "2019-02-15T15:53:00Z",63 "breakdown": {64 "success": 0.89,65 "error_plaid": 0.02,66 "error_institution": 0.0967 },68 "liabilities": {69 "status": "HEALTHY",70 "last_status_change": "2019-02-15T15:53:00Z",71 "breakdown": {72 "success": 0.89,73 "error_plaid": 0.02,74 "error_institution": 0.0975 }76 }77 },78 "investments_updates": {79 "status": "HEALTHY",80 "last_status_change": "2019-02-12T08:22:00Z",81 "breakdown": {82 "success": 0.95,83 "error_plaid": 0.02,84 "error_institution": 0.03,85 "refresh_interval": "NORMAL"86 }87 },88 "liabilities_updates": {89 "status": "HEALTHY",90 "last_status_change": "2019-02-12T08:22:00Z",91 "breakdown": {92 "success": 0.95,93 "error_plaid": 0.02,94 "error_institution": 0.03,95 "refresh_interval": "NORMAL"96 }97 }98 }99 }100 ],101 "request_id": "Ggmk0enW4smO2Tp"102}