Some LinkMoney errors are analogous to common Plaid errors. In general, these errors are thrown because something has gone wrong during an initial account link or during a routine data pull from an institution. Some Plaid errors are user-facing and require user interaction to resolve. Others are development errors from misconfiguration. Still others are unexpected errors that can arise during the account aggregation process.
The Error Object
| Field | Type | Description | Required |
|---|---|---|---|
string | A broad categorization of the error. error_type will always be one of the values in the error_type table. | ||
string | The particular error code. error_code will always be one of the values in the error_code table. | ||
string | A developer-friendly representation of the error code. This may change over time and therefore has no set list of values. | ||
string | A user-friendly representation of the error code. This may change and therefore has no set list of values. If the Item error cannot be remediated by user action, this field will be null. | ||
string | The request ID of the webhook. | ||
string[] | If the error is the result of a known problem in LinkMoney (say, a temporary outage or a common problem), a causes array may be included to explain the reason behind the error. | ||
Number | The status corresponds with conventional HTTP statuses, and is included when the error was the result of an unsuccessful HTTP request. | ||
string | If the error is the result of a common development problem with LinkMoney, a link to a relevant troubleshooting article is included. | ||
string | If the error is the result of a common development problem with LinkMoney, a blurb is included with steps for resolving the error. |
Error Types
Error Types are broad, high-level descriptors of errors. Based on the Responsibility column, you can see which errors are caused by which stakeholders. This allows LinkMoney to quickly identify which party is best suited to resolve the particular error. The responsibility also determines which additional fields are included in the Error object - for example, an error with a Developer responsibility could include suggested_action to help the developer rectify known implementation problems.
| Value | Description | Responsibility |
|---|---|---|
Indicates that a request is malformed and cannot be processed. | Developer | |
Indicates that a request was valid, but the output is unusable. | Developer | |
Indicates that all of the expected fields in the request were included, but the values were incorrect in some way. | Developer | |
Indicates errors for a particular institution. | Institution | |
Indicates that an excessive number of requests were made in a short period of time. | Developer | |
Indicates either unexpected API errors or downtime due to scheduled maintenance. | LinkMoney | |
Indicates that an Item may be invalid or may not yet be supported by LinkMoney. | User | |
Indicates an error related to asset endpoints | LinkMoney | |
Indicates a ReCAPTCHA challenge was presented or failed during the link process. | LinkMoney | |
Indicates that an error occurred during OAuth authentication. | LinkMoney |
Error Codes
Error codes provide more specific information about the type of error that was encountered, when possible. The error_code is generally more useful than the error_type as it has a fixed set of possible values and provides a more detailed description of the error which can be used for in-depth troubleshooting.
| Value | Error Type | Description | Audience |
|---|---|---|---|
Item Error | The financial institution indicated that the credentials provided were invalid. | User | |
Item Error | Three Possible Problems:
1. The institution indicated that the provided response for the selected device and OTP code was invalid.
2. The institution indicated that the provided response for MFA Questions was invalid.
3. The institution indicated that the provided response for MFA Selections was invalid. | User | |
Item Error | The financial institution indicated that the user's password or MFA information has changed. They will need to reauthenticate via Link's update mode. | User | |
Item Error | The user did not provide sufficient authorization in order to link their account via an OAuth login flow. | UserLinkMoney | |
Item Error | The financial institution indicated that the user's account is locked. The user will need to work with the institution directly to unlock their account. | User | |
Item Error | Returned when the user requires a form of MFA that Plaid does not support for a given financial institution. | UserLinkMoney | |
Item Error | Returned when the method used to send MFA credentials was deemed invalid by the institution. | ||
Item Error | Returned when there are no open accounts associated with the Item. | User | |
Item Error | Plaid is unable to support this user's accounts due to restrictions in place at the financial institution. | UserDeveloper | |
Item Error | This item was deleted while the operation was in progress. | ||
Item Error | |||
Item Error | The username entered during update mode did not match the original username. | ||
Item Error | The Link flow in update mode was entered for an Item that is already in a good state. No further action is required. | ||
Item Error | Returned from POST /auth/get when there are no valid checking or savings account(s) for which account and routing numbers could be retrieved. | User | |
Item Error | Returned from POST /investments/holdings/get, POST /investments/transactions/get, or Link initialized with the Investments product, when there are no valid investment account(s) for which holdings or transactions could be retrieved. | User | |
Item Error | Returned from POST /investments/holdings/get or POST /investments/transactions/get when there are no valid investment account(s) for which holdings or transactions could be retrieved. | User | |
Item Error | Returned from POST /liabilities/get when there are no valid liability account(s) for which liabilities could be retrieved. | User | |
Item Error | Returned when a data request has been made for an Item for a product that it does not support. Use the /item/get endpoint to find out which products an Item supports. | Developer | |
Item Error | The Item you requested cannot be found. This Item does not exist, has been previously removed via /item/remove, or has had access removed by the user | User | |
Item Error | A requested product was not enabled for the current access token. Please ensure it is included when when initializing Link and create the Item again. | Developer | |
Item Error | Returned when a data request has been made for a product that is not yet ready. | DeveloperLinkMoney | |
Item Error | The user did not grant necessary permissions for their account. | Developer | |
Institution Error | The financial institution is down, either for maintenance or due to an infrastructure issue with their systems. | InstitutionLinkMoney | |
Institution Error | The financial institution is not available this time. | LinkMoney | |
Institution Error | Institution not enabled in this environment | LinkMoneyDeveloper | |
Institution Error | This institution was not found. Please check the ID supplied | LinkMoneyDeveloper | |
Institution Error | The financial institution is failing to respond to some of our requests. Your user may be successful if they retry another time. | LinkMoneyInstitution | |
Institution Error | LinkMoney no longer supports this financial institution. | InstitutionLinkMoney | |
Institution Error | Your application is not yet registered with the institution. | LinkMoneyInstitution | |
Institution Error | You are not authorized to create Items for this institution at this time. | LinkMoneyDeveloper | |
API Error | LinkMoney was unable to process the request | LinkMoney | |
API Error | LinkMoney's systems are undergoing maintenance and API operations are disabled | LinkMoney | |
Invalid Request Error | The request was missing one or more required fields. | Developer | |
Invalid Request Error | The request included a field that is not recognized by the endpoint. | Developer | |
Invalid Request Error | One or more of the request body fields were improperly formatted or an invalid type. | Developer | |
Invalid Request Error | /link/token/create was called with invalid configuration settings | Developer | |
Invalid Request Error | The request uses fields that are not compatible with the API version being used. | Developer | |
Invalid Request Error | The request body was invalid. | Developer | |
Invalid Request Error | The request was missing a required header. | Developer | |
Invalid Request Error | The endpoint requested does not exist. | Developer | |
Invalid Request Error | The endpoint requested is not available in the API version being used. | DeveloperLinkMoney | |
Invalid Request Error | The requested endpoint is only available in Sandbox. | Developer | |
Invalid Request Error | The provided account number was invalid. | Developer | |
Invalid Input Error | Developer | ||
Invalid Input Error | |||
Invalid Input Error | Developer | ||
Invalid Input Error | Developer | ||
Invalid Input Error | Developer | ||
Invalid Input Error | Developer | ||
Invalid Input Error | Developer | ||
Rate Limit Exceeded Error | Developer | ||
Rate Limit Exceeded Error | Developer | ||
Rate Limit Exceeded Error | Institution | ||
Rate Limit Exceeded Error | Institution | ||
Rate Limit Exceeded Error | Institution | ||
Rate Limit Exceeded Error | Developer | ||
Rate Limit Exceeded Error | |||
ReCAPTCHA Error | LinkMoneyInstitution | ||
ReCAPTCHA Error | LinkMoneyInstitution |