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:

LinkError (
    "userId": String,           // ID of the user
    "errorType": String (enum), // Error name
    "errorMessage": String,     // User message
    "errorDetails": String      // Error details
)

Link errors

`callback_undefined`

User message
Error details
Common causes
Troubleshooting

This page does not exist. Reach out to [Company name] for help.

Reason: callback undefined (onCantFindItemClicked)

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.

Include the onCantFindItemClicked callback in your Link initialization.

`dds_not_supported`

User message
Error details
Common causes
Troubleshooting

[Company name] does not allow for automated deposit switching changes.Please contact [Company name] and ask them to enable this feature.

`duplicate_account`

User message
Error details
Common causes
Troubleshooting

This User ID is already associated with a connected account. Please try a different User ID to connect another account.

`expired_user_token`

User message
Error details
Common causes
Troubleshooting

The service is experiencing connection problems. Please try again later.

User ID: <ID of the user> (see user ID)Reason: expired userToken

Create a new user token, and either:

Re-initialize Link with the new user token.
Pass the new user token to the onTokenExpired callback to continue the existing Link session.

`generic`

User message
Error details
Common causes
Troubleshooting

The service is experiencing connection problems. Please try again later.

`incompatible_dds_config`

User message
Error details
Common causes
Troubleshooting

Your deposit settings cannot be updated.If you earn income through another employer or payroll provider, try searching for it.

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).

Reduce or remove the amount, percent, and/or max_value constraints used in the provided dds_config.

Use the Items endpoint to retrieve details on the specific Item’s deposit switching capabilities and limits.
See our deposit switching guide for recommended dds_config values for different actions.

`invalid_account_id`

User message
Error details
Common causes
Troubleshooting

The page does not exist. Reach out the [Company] for help.

An invalid accountId was used for direct login to an existing account when initializing Link.

Use the accounts API endpoint with the user’s id as a query parameter to see a list of valid accountId’s for the user.

`invalid_dds_config`

User message
Error details
Common causes
Troubleshooting

The service is experiencing connection problems. Please try again later.

The ddsConfig provided when initializing Link for a deposit switch is invalid.

Review the unencrypted target deposit destination.
Check the target deposit destination was encrypted correctly before being used as the ddsConfig.

`invalid_items`

User message
Error details
Common causes
Troubleshooting

This page does not exist. Reach out to [Company name] for help.

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 items initialization parameter but an empty array was present.

`invalid_user_token`

User message
Error details
Common causes
Troubleshooting

The service is experiencing connection problems. Please try again later.

Overview

Workflows

POS & LOS Systems

Day 1 Certainty® and AIM

Document Processing

Console

Link

API

Overview

Link errors

`callback_undefined`

`dds_not_supported`

`duplicate_account`

`expired_user_token`

`generic`

`incompatible_dds_config`

`invalid_account_id`

`invalid_dds_config`

`invalid_items`

`invalid_user_token`

Overview

Workflows

POS & LOS Systems

Day 1 Certainty® and AIM

Document Processing

Console

Link

API

​Overview

​Link errors

​callback_undefined

​dds_not_supported

​duplicate_account

​expired_user_token

​generic

​incompatible_dds_config

​invalid_account_id

​invalid_dds_config

​invalid_items

​invalid_user_token

Overview

Link errors

`callback_undefined`

`dds_not_supported`

`duplicate_account`

`expired_user_token`

`generic`

`incompatible_dds_config`

`invalid_account_id`

`invalid_dds_config`

`invalid_items`

`invalid_user_token`