institutionsSearch

POST {{baseUrl}}/institutions/search

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 Body

{"query"=>"<string>", "products"=>["<string>"], "country_codes"=>["<string>", "<string>"], "client_id"=>"5fd43aad1186c30013d6f3e2", "secret"=>"<string>", "options"=>{"oauth"=>"<boolean>", "include_optional_metadata"=>"<boolean>", "include_auth_metadata"=>false, "include_payment_initiation_metadata"=>false, "payment_initiation"=>{"payment_id"=>"<string>"}}}

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"}}}],"request_id":"\u003cstring\u003e"}