Skip to main content

List institutions

This endpoint returns a list of institutions based on the specified search term or parameter.

GET
/institutions

Query Parameters

FieldRequiredType

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

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

supports_account_identification

Filter only institutions which support account identification.

Optional
Boolean

supports_account_statement

Filter only institutions which support account statements.

Optional
Boolean

supports_account_verification

Filter only institutions which support account verification.

Optional
Boolean

supports_transaction_history

Filter only institutions which support extended transaction history.

Optional
Boolean
Loading...