Link Errors

Overview

When a link's state field is error, the error_code field will have one of these values.

`user_error`

The most common kind of error, this indicates that the user has failed to select an institution, or has failed to authenticate with that institution, or has abandoned the linking process for so long that it has timed out and failed for lack of action by the user.

`incomplete`

This indicates the link is partially complete, but is waiting on some form of user interaction, such as granting permissions or accepting terms. An incomplete link can be completed in a later session; it will not “time out” or enter another error state automatically. However, it cannot be used to get data while in the incomplete state.

`institution_error`

The institution is experiencing some kind of error that is beyond the user’s or MoneyKit’s control. Examples of this error are when the institution’s website or app is down for maintenance (or is experiencing an unplanned outage).

`provider_error`

The provider that MoneyKit is using is experiencing some kind of error that is beyond the user’s or MoneyKit’s control. Examples of this error are when the provider’s systems are down or having system failures.

`system_error`

This indicates an unexpected error on MoneyKit’s systems. System errors are immediately alerted and triaged, and in most cases will be corrected quickly.

`auth_expired`

This indicates that the link’s lifetime on the institution has expired. An expired link must be reconnected to become usable again.

`no_accounts`

This indicates that the link has no accounts with the requested type of product data.

`user_setup_required`

This indicates that the user must log into the institution and take some action to restore access to their account.

`invalid_credentials`

This indicates that the user has submitted incorrect credentials for their selected institution.

`user_oauth_denied`

This indicates that the user has denied access to their data via the OAuth flow.

`user_input_incorrect`

This indicates that the user has submitted an invalid answer to a security question or code after submitting credentials.