List institutions

Lists financial institutions available through the MX platform.

GET

/institutions

Query Parameters

Field	Required	Type
name This will list only institutions in which the appended string appears.	Optional	String
iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include US, CA, and MX (Mexico).	Optional	Array
include_blocked_institutions When set to true, returns all institutions regardless of their operational status. When false or omitted, only returns institutions that are currently operational.	Optional	Boolean
page Results are paginated. Specify current page.	Optional	Integer
records_per_page This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.	Optional	Integer
supported_products[] Filters institutions that support specific products. Values may include account_verification, identity_verification, transactions, transaction_history, statements, investments. For example, institutions that support account_verification and statements, ?supported_products[]=account_verification&supported_products[]=statements.	Optional	Array

Header Parameters

Field	Required	Type
Accept-Version MX Platform API version.	Required	String

Loading...