Search institutions
Allows you to search across the list of Institutions supported by your service providers. This endpoint is only available in production.
Query parameters
Unique key corresponding to a institution's position in the paginated list of results -- used to indicate that only institutions residing before this key will be retrieved.
Each institution carries a unique key. Reference Pagination
The before and after fields cannot be used in the same request.
Unique key corresponding to a institution's position in the paginated list of results -- used to indicate that only institutions residing after this key will be retrieved.
Each institution carries a unique key. Reference Pagination
The before and after fields cannot be used in the same request.
Comma separated list of service providers. If present, only institutions supported by at least one of the service providers will be included.
Note: Reference Supported Service Providers for the list of available bank linking providers.
Limits number of returned institutions.
Default value: 10
Minimum value: 1
Maximum value: 1000
If present, only institutions will be included whose name matches partially or fully.
If present, only institutions will be included whose type matches.
Comma separated list of regions. If present, only institutions supported by at least one of the regions will be included.
Response
Institution snapshot is returned