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)
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, Bank Transfers, 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_idstringYour 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. | ||||||
secretstringYour Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body. | ||||||
countrequiredintegerThe total number of Institutions to return. Maximum: 500 | ||||||
offsetrequiredintegerThe number of Institutions to skip. | ||||||
country_codesrequired[string]Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. Min items: 1 Possible values: US, GB, ES, NL, FR, IE, CA | ||||||
optionsobjectAn optional object to filter /institutions/get results.
|
1
2
3
4
5
6
7
8
9
10
11
12
// Pull institutionsconst request: InstitutionsGetRequest = {count: 10,offset: 0,country_codes: ['US'],};try {const response = await plaidClient.institutionsGet(request);const institutions = response.data.institutions;} catch (error) {// Handle error}
institutions/get
Response fields and example
institutions[object]A list of Plaid Institution
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalintegerThe total number of institutions available via this endpoint | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request_idstringA unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
{"institutions": [{"country_codes": ["US"],"institution_id": "ins_1","name": "Bank of America","oauth": false,"products": ["assets","auth","balance","transactions","identity","liabilities"],"routing_numbers": ["011000138","011200365","011400495","011500010","011900254","021000322","021200339","026009593","031202084","051000017","052001633","053000196","053904483","054001204","061000052","063100277","064000020","071214579","072000805","073000176","081000032","081904808","082000073","101100045","103000017","107000327","111000025","121000358","122101706","122400724","123103716","125000024","323070380"]}],"request_id": "tbFyCEqkU774ZGG","total": 11384}
/institutions/get_by_id
Get details of an institution
Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
institutions/get_by_idRequest fields and example
client_idstringYour 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. | ||||
secretstringYour 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_idrequiredstringThe ID of the institution to get details about | ||||
country_codesrequired[string]Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. Possible values: US, GB, ES, NL, FR, IE, CA | ||||
optionsobjectSpecifies optional parameters for /institutions/get_by_id. If provided, must not be null.
|
1
2
3
4
5
6
7
8
9
10
const request: InstitutionsGetByIdRequest = {institution_id: insitutionID,country_codes: ['US'],};try {const response = await plaidClient.institutionsGetById(request);const institution = response.data.institution;} catch (error) {// Handle error}
institutions/get_by_id
Response fields and example
institutionobjectDetails relating to a specific financial institution
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request_idstringA unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
{"institution": {"country_codes": ["US"],"institution_id": "ins_109512","name": "Houndstooth Bank","products": ["auth","balance","identity","transactions"],"routing_numbers": ["110000000"],"oauth": false,"status": {"item_logins": {"status": "HEALTHY","last_status_change": "2019-02-15T15:53:00Z","breakdown": {"success": 0.9,"error_plaid": 0.01,"error_institution": 0.09}},"transactions_updates": {"status": "HEALTHY","last_status_change": "2019-02-12T08:22:00Z","breakdown": {"success": 0.95,"error_plaid": 0.02,"error_institution": 0.03,"refresh_interval": "NORMAL"}},"auth": {"status": "HEALTHY","last_status_change": "2019-02-15T15:53:00Z","breakdown": {"success": 0.91,"error_plaid": 0.01,"error_institution": 0.08}},"balance": {"status": "HEALTHY","last_status_change": "2019-02-15T15:53:00Z","breakdown": {"success": 0.89,"error_plaid": 0.02,"error_institution": 0.09}},"identity": {"status": "DEGRADED","last_status_change": "2019-02-15T15:50:00Z","breakdown": {"success": 0.42,"error_plaid": 0.08,"error_institution": 0.5}},"investments": {"status": "HEALTHY","last_status_change": "2019-02-15T15:53:00Z","breakdown": {"success": 0.89,"error_plaid": 0.02,"error_institution": 0.09},"liabilities": {"status": "HEALTHY","last_status_change": "2019-02-15T15:53:00Z","breakdown": {"success": 0.89,"error_plaid": 0.02,"error_institution": 0.09}}},"investments_updates": {"status": "HEALTHY","last_status_change": "2019-02-12T08:22:00Z","breakdown": {"success": 0.95,"error_plaid": 0.02,"error_institution": 0.03,"refresh_interval": "NORMAL"}},"liabilities_updates": {"status": "HEALTHY","last_status_change": "2019-02-12T08:22:00Z","breakdown": {"success": 0.95,"error_plaid": 0.02,"error_institution": 0.03,"refresh_interval": "NORMAL"}},"primary_color": "#004966","url": "https://plaid.com","logo": null}},"request_id": "m8MDnv9okwxFNBV"}
/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.
institutions/searchRequest fields and example
client_idstringYour 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. | ||||||
secretstringYour Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body. | ||||||
queryrequiredstringThe search query. Institutions with names matching the query are returned | ||||||
productsrequired[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, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer | ||||||
country_codesrequired[string]Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. Possible values: US, GB, ES, NL, FR, IE, CA | ||||||
optionsobjectAn optional object to filter /institutions/search results.
|
1
2
3
4
5
6
7
8
9
10
11
const request: InstitutionsSearchRequest = {query: institutionID,products: ['transactions'],country_codes: ['US'],};try {const response = await plaidClient.institutionsSearch(request);const institutions = response.data.institutions;} catch (error) {// Handle error}
institutions/search
Response fields and example
institutions[object]An array of institutions matching the search criteria
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request_idstringA unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{"institutions": [{"country_codes": ["US"],"institution_id": "ins_118923","name": "Red Platypus Bank - Red Platypus Bank","oauth": false,"products": ["assets","auth","balance","transactions","identity"],"routing_numbers": []}],"request_id": "Ggmk0enW4smO2Tp"}
