Errors and Exceptional Conditions

Communicating Errors

For certain predictable conditions, the implementer can return an ErrorResponse and use the HTTP status code to communicate the cause of the error.

Response

ErrorResponse

Response indicating the presence of an error.

request_id
string
Unique identifier useful for tracing this request, when debugging.
error
requiredobject
Generic error object.
id
string
Opaque identifier, expected to be consistent for errors which have the same cause.
message
string
Brief description of the error, intended for display purposes. Under certain conditions, Plaid may modify or replace the message e.g. in response to suspicious user activity.
1{
2  "request_id": "m8MDnv9okwxFNBV",
3  "error": {
4    "id": "E00001",
5    "message": "string"
6  }
7}
400 Bad Request

This response should be used to indicate that the parameters to the method were incorrect, e.g., the pagination parameters were out of range, or the dates were not specified in the correct format.

401 Unauthorized

This response should be used to indicate that the request requires authentication before it can be fulfilled. It should be returned when the request does not contain the required authentication methods: either an invalid/missing authentication token, or invalid credential pair in the case of the Authentication API Method endpoint.

503 Unavailable

This response should be used to indicate that the institution is currently unavailable to respond to the request. The implementer may return an InstitutionError to indicate the time when it prefers that Plaid retries its requests.