CLIENT_CONFIG.md

← Config

The connect widget uses the config to set the initial state and behaviors of the widget. Below is the structure of the config object. Listed values are the defaults.

config

The config object is the config that the widget is initialized with.

Client Flags

Field	Type	Description	Required	Default
client_redirect_url	string	This determines the redirect destination at the end of OAuth when used with is_mobile_webview: true or oauth_referral_source: APP.	No	null
color_scheme	"light" | "dark" | null	Load the widget with the specified color_scheme.	No	"light"
current_institution_code	string | null	Load the widget into the credential view for the specified institution.	No	null
current_institution_guid	string | null	Load the widget into the credential view for the specified institution.	No	null
current_member_guid	string | null	Load the widget into a specific member that contains an error or requires multifactor authentication. The widget will determine the best view to load based on the member's current state.	No	null
current_microdeposit_guid	string | null	-	No	null
disable_background_agg	boolean | null	This determines whether background aggregation is enabled or disabled for the member created by the Connect Widget.	No	null
disable_institution_search	boolean | null	This determines whether the institution search is displayed within the Connect Widget. This option must be used with current_institution_code, current_instituion_guid, or current_member_guid. Set up listener for mx/connect/backToSearch postMessage to handle when user will navigate back to search.	No	false
enable_app2app	boolean | null	This indicates whether OAuth app2app behavior is enabled for institutions that support it. When set to false, the widget will not direct the end user to the institution's mobile application. This setting currently only affects Chase institutions.	No	true
include_identity	boolean | null	This determines whether an account owner identification (AOI, previously called identity verification) is run in addition to the process specified by the mode. The AOI runs after the primary process is complete.	No	null
include_transactions	boolean | null	This determines whether transaction data are retrieved.	No	null
iso_country_code	string | null	This configures the widget to render institutions that have a certain country code. For example "CA" or "US"	No	null
is_mobile_webview	boolean | null	This configures the widget to render in a mobile WebView. JavaScript event postMessages are replaced with URL updates.	No	false
mode	"aggregation" | "verification" | null	mode is the most important option for the Connect Widget. This determines what kind of process Connect will run, which affects how you should set many other options.	No	"aggregation"
oauth_referral_source	"BROWSER" | "APP" | null	This determines how MX will respond to the result of an OAuth flow. When set to APP, MX will redirect to the URI specified in the ui_message_webview_url_scheme. When set to BROWSER, MX will send a postMessage but not redirect. If is_mobile_webview is true, this defaults to APP.	No	"BROWSER"
ui_message_version	integer | null	This determines which version of postMessage events are triggered. All new implementations must use version 4.	No	1
ui_message_webview_url_scheme	string | null	This is a client-defined scheme used in OAuth redirects in WebViews; also used in URL updates when these replace postMessages in WebViews.	No	"mx"
update_credentials	boolean | null	Load the widget into a view that allows them to update the current member. Optionally used with current_member_guid. This option should be used sparingly. The best practice is to use current_member_guid and let the widget resolve the issue.	No	false
widget_type	string	This should always be set to connect.	Yes	-

<-- Back to README