← Profiles
The connect widget uses the profiles to set the initial state of the widget. Below is the structure of the profiles object. Listed values are the defaults.
The client object is the client that the widget is connected to.
Client Flags
| Field | Type | Description | Required |
|---|---|---|---|
guid |
string |
This guid is used to look up client logo in logo header component. | Yes |
has_atrium_api |
boolean | null |
This field is for advance customizations. Use with cation. | No |
has_limited_institutions |
boolean | null |
This field is for advance customizations. Use with cation. | No |
oauth_app_name |
string |
This name is used in the copy on disclosure views and Connected view. | Yes |
The clientProfile object is the profile of the client.
Client Profile Flags
| Field | Type | Description | Required |
|---|---|---|---|
account_verification_is_enabled |
boolean | null |
When enabled, the widget will be able to run in verification mode. |
|
account_identification_is_enabled |
boolean | null |
When enabled, the widget will be able to run identification job. | No |
custom_copy_namespace |
string | null |
Customize individual copy/text throughout the widget. Create a file in the language directory, {namespace}_custom_copy-{lang}.json. namespace matches this field and locale matches to locale config below. Add entry to CLIENT_CUSTOM_COPY. |
No |
is_microdeposits_enabled |
boolean | null |
When enabled, the widget will be able to fallback to microdeposit solution if verification mode isn't supported for institution. Must also enable show_microdeposits_in_connect in widgetProfile. |
No |
locale |
'en' | 'es' | 'fr-ca' | null |
The connect widget supports multiple languages. Supported locale options: en, es, and fr-ca. |
No |
show_external_link_popup |
boolean | null |
When enabled, users will be notified when clicking a link that navigates away from the widget. | No |
tax_statement_is_enabled |
boolean | null |
When enabled, the widget will be able to run in tax mode. |
No |
use_cases_is_enabled |
boolean | null |
*More details coming soon. | No |
uses_custom_popular_institution_list |
boolean | null |
This field is for advance customizations. Use with cation. | No |
uses_oauth |
boolean | null |
When enabled, the widget will use OAuth to authenticate when available. *More details coming soon. | No |
The clientColorScheme object is the color scheme of the client.
Client Color Scheme Flags
| Field | Type | Description | Required |
|---|---|---|---|
primary_100 |
string | null |
Override color scheme of the widgets theme. | No |
primary_200 |
string | null |
Override color scheme of the widgets theme. | No |
primary_300 |
string | null |
Override color scheme of the widgets theme. | No |
primary_400 |
string | null |
Override color scheme of the widgets theme. | No |
primary_500 |
string | null |
Override color scheme of the widgets theme. | No |
primary_color |
string | null |
Override color scheme of the widgets theme. | No |
secondary_color |
string | null |
Override color scheme of the widgets theme. | No |
widget_brand_color |
string | null |
Override color scheme of the widgets theme. | No |
The user object is the user of the client.
User Flags
| Field | Type | Description | Required |
|---|---|---|---|
guid |
string |
This guid is sent in the body of the Microdeposit create and update calls. | Yes |
email |
string |
This email is sent with support tickets. | No |
The userProfile object is the profile of the user.
User Profile Flags
| Field | Type | Description | Required |
|---|---|---|---|
too_small_modal_dismissed_at |
string | null |
Used to determine when the modal was last dismissed. | No |
The widgetProfile object is the profile of the widget.
Widget Profile Flags
| Field | Type | Description | Required |
|---|---|---|---|
display_disclosure_in_connect |
boolean | null |
When enabled, the original "heavy" disclosure is used. When disabled(default), the new "light" disclosure is used. | No |
enable_manual_accounts |
boolean | null |
When enabled(default), the manual accounts option is shown. Supported in aggregation mode only. |
No |
enable_support_requests |
boolean | null |
When enabled(default), the support request options are shown. Supported in aggregation mode only. |
No |
show_microdeposits_in_connect |
boolean | null |
When enabled, the microdeposits option is shown. Supported in verification mode only. Must also enable is_microdeposits_enabled in clientProfile. |
No |
show_mx_branding |
boolean | null |
- | No |