Skip to main content

​
Add a new member (default)

Opens Connect to let the user add a new financial institution connection. No additional configuration required — this is the default behavior. 
{
  "widget_type": "connect_widget"
}

​
Update credentials for an existing member

Opens Connect directly to the credential entry screen for a specific member, useful when a member’s connection_status requires updated credentials. 
{
  "widget_type": "connect_widget",
  "current_member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
  "update_credentials": true
}

​
Verify account numbers (verification mode)

Opens Connect in verification mode, which guides the user through connecting an account to retrieve account and routing numbers for ACH purposes. Background aggregation is disabled by default in this mode. 
{
  "widget_type": "connect_widget",
  "mode": "verification"
}

​
Add a member and verify in one flow

Combines account connection and verification in a single widget session. 
{
  "widget_type": "connect_widget",
  "mode": "verification",
  "include_transactions": false
}

​
Aggregation mode (explicit)

Opens Connect in standard aggregation mode. Use this when you want to be explicit about the mode, though this is the default. 
{
  "widget_type": "connect_widget",
  "mode": "aggregation"
}