institutionsGet

POST {{baseUrl}}/institutions/get

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 Body

{"count"=>"<integer>", "offset"=>"<integer>", "country_codes"=>["<string>"], "client_id"=>"5fd43aad1186c30013d6f3e2", "secret"=>"<string>", "options"=>{"products"=>["<string>", "<string>"], "routing_numbers"=>["<string>", "<string>"], "oauth"=>"<boolean>", "include_optional_metadata"=>"<boolean>", "include_auth_metadata"=>false, "include_payment_initiation_metadata"=>false}}

HEADERS

RESPONSES

status: OK

{"institutions":[{"institution_id":"\u003cstring\u003e","name":"\u003cstring\u003e","products":["\u003cstring\u003e","\u003cstring\u003e"],"country_codes":["\u003cstring\u003e","\u003cstring\u003e"],"routing_numbers":"\u003carray,null\u003e","oauth":"\u003cboolean\u003e","url":"\u003cstring,null\u003e","primary_color":"\u003cstring,null\u003e","logo":"\u003cstring,null\u003e","status":{"item_logins":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"transactions_updates":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"auth":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"balance":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"identity":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"investments_updates":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"liabilities_updates":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"liabilities":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"investments":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"health_incidents":"\u003carray,null\u003e"},"auth_metadata":{"supported_methods":{"instant_auth":"\u003cboolean\u003e","instant_match":"\u003cboolean\u003e","automated_micro_deposits":"\u003cboolean\u003e"}}},{"institution_id":"\u003cstring\u003e","name":"\u003cstring\u003e","products":["\u003cstring\u003e","\u003cstring\u003e"],"country_codes":["\u003cstring\u003e","\u003cstring\u003e"],"routing_numbers":"\u003carray,null\u003e","oauth":"\u003cboolean\u003e","url":"\u003cstring,null\u003e","primary_color":"\u003cstring,null\u003e","logo":"\u003cstring,null\u003e","status":{"item_logins":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"transactions_updates":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"auth":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"balance":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"identity":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"investments_updates":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"liabilities_updates":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"liabilities":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"investments":{"breakdown":{"success":"\u003cnumber\u003e","error_plaid":"\u003cnumber\u003e","error_institution":"\u003cnumber\u003e","refresh_interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"health_incidents":"\u003carray,null\u003e"},"auth_metadata":{"supported_methods":{"instant_auth":"\u003cboolean\u003e","instant_match":"\u003cboolean\u003e","automated_micro_deposits":"\u003cboolean\u003e"}}}],"total":"\u003cinteger\u003e","request_id":"\u003cstring\u003e"}