Errors
A comprehensive breakdown of all Plaid error codes
Errors overview
Item errors Occur when an Item may be invalid or not supported on Plaid's platform. | INVALID_MFA OTP Device & Code INVALID_MFA Questions INVALID_MFA Selections NO_AUTH_ACCOUNTS or no-depository-accounts |
Institution errors Occur when there are errors for the requested financial institution. | |
API errors Occur during planned maintenance and in response to API errors. | INTERNAL_SERVER_ERROR or plaid-internal-error |
Assets errors Occur for errors related to Asset endpoints. | |
Payment errors Occur for errors related to Payment Initiation endpoints. | |
Virtual Account errors Occur for errors related to Virtual Account endpoints. | |
Transactions errors Occur for errors related to Transactions endpoints. | |
Transfer errors Occur for errors related to Transfer endpoints. | |
Income errors Occur for errors related to Income endpoints. | |
Sandbox errors Occur when invalid parameters are supplied in the Sandbox environment. | |
Invalid Request errors Occur when a request is malformed and cannot be processed. | |
Invalid Input errors Occur when all fields are provided, but the values provided are incorrect in some way. | |
Invalid Result errors Occur when a request is valid, but the output would be unusable for any supported flow. | |
Rate Limit Exceeded errors Occur when an excessive number of requests are made in a short period of time. | |
Link Web errors Occur when the error is specific to Link on the web platform. | |
ReCAPTCHA errors Occur when a ReCAPTCHA challenge has been presented or failed during the link process. | |
OAuth errors Occur when there is an error in OAuth authentication. | |
Micro-deposits errors Occur when there is an error with micro-deposits. | |
Partner errors Occur when there is an error with creating or managing end customers. | |
Error schema
We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type
. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. An Item with a non-null
error object will only be part of an API response when calling /item/get
to view Item status. Otherwise, error fields will be null
if no error has occurred; if an error has occurred, an error code will be returned instead.
error_type
string
A broad categorization of the error. Safe for programmatic use.
Possible values:
INVALID_REQUEST
, INVALID_RESULT
, INVALID_INPUT
, INSTITUTION_ERROR
, RATE_LIMIT_EXCEEDED
, API_ERROR
, ITEM_ERROR
, ASSET_REPORT_ERROR
, RECAPTCHA_ERROR
, OAUTH_ERROR
, PAYMENT_ERROR
, BANK_TRANSFER_ERROR
, INCOME_VERIFICATION_ERROR
, MICRODEPOSITS_ERROR
error_code
string
The particular error code. Safe for programmatic use.
error_message
string
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
string
A user-friendly representation of the error code.
This may change over time and is not safe for programmatic use.
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
string
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causes
array
In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request,
causes
will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes
will only be provided for the error_type
ASSET_REPORT_ERROR
. causes
will also not be populated inside an error nested within a warning
object.status
integer
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_url
string
The URL of a Plaid documentation page with more information about the error
suggested_action
string
Suggested steps for resolving the error