Link Errors

Learn about errors your users may see in Link.

Overview

This page provides common causes and troubleshooting suggestions for these Link errors:

  • invalid_link_items
  • invalid_pd_config
  • invalid_link_key
  • invalid_user_token
  • generic

All errors (except generic) occur due to invalid Link configuration and are not expected to reach the production environment.

Link errors are returned with onError callback function.

The function will be passed the type of the error that occurred.

Some error messages shown to the user have placeholders for [Link item name] and [Company name]. In such cases, for the screens samples below, they were replaced by Starbox and GoodLoans, respectively.

invalid_link_items

Message to the users

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

Error details

N/A

Common causes

  • The user was deep linked to a Link item that does not exist (see Deep linking for additional information).

  • A constrained list of Link items was provided in the Link configuration, but all of the provided Link items do not exist.

Troubleshooting steps

Check if the Link item is available by calling GET /link-items/:id endpoint each time before initializing Link when deep linking or constraining a Link item list.

In the case where you are keeping a map of available Link items on the backend, occasionally call GET /link-items endpoint to sync the newest updates.

invalid_pd_config

Message to the users

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

Error details

Reason: invalid PD config.

Common causes

The pay distribution config provided when initializing Link is invalid.

Troubleshooting steps

  • Check the configuration parameters of the provided pay distribution config (see Pay distribution configuration for additional information).
  • Check that the pay distribution config is encrypted correctly using the Argyle encryption endpoint (see Link integration for additional information).

invalid_link_key

Message to the user

Please make sure your linkKey is correct.

Error details

N/A

Common causes

The Link key used when initializing Link is invalid.

Troubleshooting steps

Check if you are using an appropriate Link key for the selected environment. There are separate Link keys for the sandbox and production environment. Link keys can be found in the API keys section of the Argyle Console.

invalid_user_token

Message to the user

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

Error details

Reason: invalid userToken.

Common causes

User token provided during Link initialization is not a valid JWT token and could not be decoded.

Troubleshooting steps

  • Check if the used userToken is the same provided by /user-tokens endpoint or via onUserCreated callback (see Callbacks for additional information).
  • Check if the user token is not modified (e.g. additionally encoded) before being passed to Argyle during Link initialization.

generic

Message to the user

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

Error details

N/A

Common causes

Something unexpected happened. Argyle is investigating.

Troubleshooting steps

Please contact our support team for more details.