Error Codes
Link errors: common causes and troubleshooting.
Overview#
When a user encounters an error in Link, they are shown an error screen that displays suggestions for resolving the particular issue. For easier troubleshooting, we recommend you include the onError callback in your Link initialization.
The onError callback returns:
1LinkError ( 2 "userId": String, // ID of the user 3 "errorType": String (enum), // Error name 4 "errorMessage": String, // User message 5 "errorDetails": String // Error details 6)
Link errors#
callback_undefined#
The Callback experience type was selected for "If no results" when customizing a Link Flow, but the onCantFindItemClicked callback was not included in the Link initialization.
dds_not_supported#
The user's selected employer or payroll provider does not support deposit switching.
duplicate_account#
The user attempted to connect an already-connected account.
expired_user_token#
Link was initialized with an expired user token, or the user token expired during the Link session.
generic#
An unexpected error occurred. We are looking into it.
incompatible_dds_config#
The provided dds_config is not compatible with the selected employer or payroll system. Incompatibility may be due to some systems allowing only amount allocations, others only percent allocations, while others limit the maximum number of allowed allocations (max_value).
invalid_account_id#
An invalid accountId was used for direct login to an existing account when initializing Link.
invalid_dds_config#
The ddsConfig provided when initializing Link for a deposit switch is invalid.
invalid_items#
- Direct login was used for an Item that does not exist.
- Link search was constrained to Items that do not exist.
- Link was initialized with the optional
itemsinitialization parameter but an empty array was present.
invalid_user_token#
The user token provided in the Link initialization was not valid.