plaid2.model.institutions_search_request module

class plaid2.model.institutions_search_request.InstitutionsSearchRequest(*, options: Optional[InstitutionsSearchRequestOptions] = None, country_codes: List[str], products: Optional[List[str]] = None, query: str)[source]

Bases: BaseModel

country_codes: List[str]: Specify an array of Plaid-supported country codes this institution supports, 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.

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[InstitutionsSearchRequestOptions]: An optional object to filter /institutions/search results.

classmethod parse_obj(data: Any) → InstitutionsSearchRequest[source]: Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsSearchRequest[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

products: Optional[List[str]]: 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.

query: str: The search query. Institutions with names matching the query are returned