Institutions

institutionsSearch

POST
/institutions/search

Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

InstitutionsSearchRequest defines the request schema for /institutions/search

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*string

The search query. Institutions with names matching the query are returned

products*array<>

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.

Items1 <= items
country_codes*array<>

Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.

options?

An optional object to filter /institutions/search results.

Response Body

application/json

application/json

curl -X POST "https://example.com/institutions/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string",    "products": [      "assets"    ],    "country_codes": [      "US"    ]  }'
{  "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"}