Institutions Overview - MX Documentation

Institutions are financial service providers such as banks, credit unions, and investment firms that users connect to aggregate their financial data.

Institution Fields

Field Name	Data Type	Description
`code`	String	A unique identifier for each institution. Defined by MX.
`created_at`	String	Date and time the institution was created, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`forgot_password_url`	String	The URL of the institution for helping users recover a forgotten password.
`forgot_username_url`	String	The URL of the institution for helping users recover a forgotten username.
`guid`	String	A unique identifier for the institution. Defined by MX.
`has_checking_accounts`	Boolean	(Deprecated) If the institution has checking accounts, this field will be true. Otherwise, this field will be false.
`has_credit_card_accounts`	Boolean	(Deprecated) If the institution has credit card accounts, this field will be true. Otherwise, this field will be false.
`has_investment_accounts`	Boolean	(Deprecated) If the institution has investment accounts, this field will be true. Otherwise, this field will be false.
`has_line_of_credit_accounts`	Boolean	(Deprecated) If the institution has line of credit accounts, this field will be true. Otherwise, this field will be false.
`has_loan_accounts`	Boolean	(Deprecated) If the institution has loan accounts, this field will be true. Otherwise, this field will be false.
`has_mortgage_accounts`	Boolean	(Deprecated) If the institution has mortgage accounts, this field will be true. Otherwise, this field will be false.
`has_savings_accounts`	Boolean	(Deprecated) If the institution has savings accounts, this field will be true. Otherwise, this field will be false.
`is_disabled_by_client`	Boolean	This indicates whether the institution has been disabled by the client.
`is_hidden`	Boolean	If the institution is available for creating new member connections, this field will be false. Otherwise, this field will be true.
`is_test`	Boolean	If the institution represents a test institution such as MX Bank, this field will be true. Otherwise, this field will be false.
`iso_country_code`	Array	The ISO country codes related to the institution.
`medium_logo_url`	String	The institution’s logo (medium size). This may be a generic logo if MX does not have a specific logo for the institution.
`name`	String	The name of the institution that is visible to the user.
`popularity`	Integer	The number of member connections to the institution.
`small_logo_url`	String	The institution’s logo (small size). This may be a generic logo if MX does not have a specific logo for the institution.
`supports_account_identification`	Boolean	Indicates whether account identification is available for this institution.
`supports_account_verification`	Boolean	Indicates whether account verification is available for this institution.
`supports_oauth`	Boolean	This indicates whether the institution supports OAuth authentication.
`supports_transaction_history`	Boolean	Indicates whether the institution allows access to up to 24 months of transaction data.
`trouble_signing_in_url`	String	The URL of the institution for helping users troubleshoot any other sign-in issue.
`updated_at`	String	Date and time the institution was updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`url`	String	The URL of the institution.

Credential Field Types

The “field_type” of the Institution Required Credential endpoint will return integers. See the table below for the name for each integer and its corresponding HTML element. See the Nexus Guide for more information

Credential Type	Definition
0	TEXT
1	PASSWORD
2	OPTIONS
3	LOGIN
12	TOKEN
13	IMAGE_DATA
14	IMAGE_OPTIONS

​Institution Fields

​Credential Field Types

Institution Fields

Credential Field Types