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.

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.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`query`	String	Yes	The search query. Institutions with names matching the query are returned
`products[]`	Array	No	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.
`client_id`	String	No	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.
`options`	Object	No	An optional object to filter `/institutions/search` results.
`options.payment_initiation`	Object	No	Additional options that will be used to filter institutions by various Payment Initiation configurations.
`options.payment_initiation.payment_id`	String	No	A unique ID identifying the payment
`options.payment_initiation.consent_id`	String	No	A unique ID identifying the payment consent
`options.include_auth_metadata`	Boolean	No	When `true`, returns metadata related to the Auth product indicating which auth methods are supported. Default value: false
`options.oauth`	Boolean	No	Limit results to institutions with or without OAuth login flows. Note that institutions will have `oauth` set to `true` if some Items associated with that institution are required to use OAuth flows; institutions in a state of migration to OAuth will have the `oauth` attribute set to `true`.
`options.include_optional_metadata`	Boolean	No	When true, return the institution's homepage URL, logo and primary brand color.
`options.include_payment_initiation_metadata`	Boolean	No	When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported. Default value: false
`country_codes[]`	Array	Yes	Specify which country or countries to include institutions from, 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.
`secret`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.