For field names, types, and descriptions, see the response schema on each endpoint page, such as Read Institution, List Institutions, and List Institution Credentials.
institution objects on the MX platform.
For example, the mortgage division of a financial institution might use a separate system than its everyday banking division, which is different from its credit card division.
Only MX can create an institution. Each institution can offer multiple connection methods such as:
- An email and a password
- A username and a password
- OAuth (some institutions don’t support OAuth)
member, you must also call List Institution Credentials to retrieve the set of required credentials for each institution and request them from the user.
You can Read an Institution to see what products each institution supports.
The list of institutions can change at any time.
Caching our Institutions List and Credentials
You can use the List Institutions endpoint to retrieve a list of all institutions currently available in the MX platform. To avoid frequent calls that return all supported institutions, we recommend caching the institution list and the required credentials for each institution daily. This ensures you pick up new institutions and any changes to existing ones, such as updated required credentials when MX switches to a new data provider. We aim to maintain the same institutionguid even if we change data providers, but in rare cases, it may change.
