API Documentation

Link Account Errors

Suggest Edits

🚧

Under Construction

These documents are a still a work in progress. The missing endpoint and fields will be completed as soon as possible and updates to the information will be made as needed.

Link Account

Errors pertaining to link_account endpoint.

Error CodeError Response MessageError TypeTroubleshootingError Status Code
Key not present in response.Bank account successfully linked.200
Key not present in response.Bank account not successfully linked (public token may have expired; tokens expire in 30 minutes after creation).200
Key not present in response.Bank account linked, but in a frozen state.202
Key not present in response.The end user is NOT using a PRODUCTION tier and the account_name is 'no match' and the end user provides a public_token or a plaid_token
Key not present in response.Check validation_details for more information. PRODUCT_NOT_READY indicates the account is waiting to be linked (with microdeposit verification, for instance).400
Key not present in response.authsignature or usersignature header was absent or incorrect.401
invalid_choice"{ ""success"": false, ""validation_details"": { ""invalid_choice"": ""'{input}' is not a valid choice. Must be one of: {PLAID_TOKEN_TYPE_CHOICES}"" }, ""message"": ""Bad request."", ""status"": ""FAILURE"" }"Validation Error: Invalid Token TypePlease ensure the token type being entered is a valid entry and try the request again.400
required"{ ""success"": false, ""validation_details"": { ""public_token"": ""This field is required."" }, ""message"": ""Bad request."", ""status"": ""FAILURE"" }"Validation Error: Plaid Token is required.Please ensure the correct token type being entered and try the request again.400
required"{
""success"": false,
""validation_details"": {
""account_number"": ""This field is required.""
},
""message"": ""Bad request."",
""status"": ""FAILURE""
}"		Validation Error: Account number is required.Please ensure a public token is being passed and the account number is provided in the request and try the request again.400
required"{
""success"": false,
""validation_details"": {
""routing_number"": ""This field is required.""
},
""message"": ""Bad request."",
""status"": ""FAILURE""
}"		Validation Error: Routing number is required.Please ensure a public token is being passed and the routing number is being provided in the request and try the request again.400
required"{
""success"": false,
""validation_details"": {
""routing_number"": ""This field is required.""
},
""message"": ""Bad request."",
""status"": ""FAILURE""
}"		Validation Error: Correct account number and routing number is required.Please ensure a public token is being passed and the correct account number and routing number is being provided in the request and try the request again.400
Cannot be specified alongside field(s): {other_fields}."{
""success"": false,
""validation_details"": {
""public_token"": ""Cannot be specified alongside field(s): plaid_token."",
""plaid_token"": ""Cannot be specified alongside field(s): public_token.""
},
""message"": ""Bad request."",
""status"": ""FAILURE""
}"		Validation ErrorPlease provide either a public token or a plaid token with the request but not both.400
Plaid error encountered while trying to get account balance: None; the login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information. Use Link's update mode to restore the item to a good state.400
NO_BANK_ACCOUNT_LINKEDNo savings or checking account was linked; selected account was of a different account type.Link Account ErrorResponse from Plaid does not have an account number, ACH number or the account is not a checking or savings account.400
Key not present in response.No score from rosette API request. Response:{rosette_response}ExceptionProduction request but the rosette API request returns None.500
INVALID_PUBLIC_TOKENThe provided Plaid public token is expired. Public tokens expire 30 minutes after creation; you will need to create and send a new token.Plaid ErrorSandbox request: Please create and send a new token with the request.400
INVALID_PUBLIC_TOKENThe provided Plaid public token is in an invalid format. Expected format: public--.Plaid ErrorSandbox request: Please check the public token and ensure valid information is being passed in the request.400
See Plaid's most relevant error codes belowThe request does not have a valid Plaid token.Plaid ErrorPlease check the request and ensure a valid Plaid token is being passed.400
NO_BANK_ACCOUNT_LINKEDNo savings or checking account was linked; selected account was of a different account type.Link Account ErrorPlease ensure that the account number and routing number being sent are for a checking or savings account and submit the request again.400
NO_CHECKING_ACCOUNT_LINKEDNo selected account ID was sent and user did not have a checking account at the chosen institution.Link Account ErrorPlease ensure that the correct account ID is provided and that the end user has a checking account at the selected institution.500
Plaid received an invalid request: {status}Plaid Error400
Plaid returned an unexpected Auth error code: {err_code}Plaid Error400
Plaid Auth error code: PRODUCT_NOT_READYPlaid Error400
Plaid Micro-deposit verification for a bank account has exceeded the 7-day limit for verification: VERIFICATION_EXPIRED.Plaid Error400
INSTANT_MATCH_FAILEDUnknown Plaid Auth error code: INSTANT_MATCH_FAILEDPlaid ErrorPlaid docs for INSTANT_MATCH_FAILED400
INSUFFICIENT_CREDENTIALSUnknown Plaid Auth error code: INSUFFICIENT_CREDENTIALSPlaid ErrorPlaid docs for INSUFFICIENT_CREDENTIALS400
INVALID_CREDENTIALSUnknown Plaid Auth error code: INVALID_CREDENTIALSPlaid ErrorPlaid docs for INVALID_CREDENTIALS400
INVALID_MFAUnknown Plaid Auth error code: INVALID_MFAPlaid ErrorPlaid docs for INVALID_MFA400
INVALID_SEND_METHODUnknown Plaid Auth error code: INVALID_SEND_METHODPlaid ErrorPlaid docs for INVALID_SEND_METHOD400
INVALID_UPDATED_USERNAMEUnknown Plaid Auth error code: INVALID_UPDATED_USERNAMEPlaid ErrorPlaid docs for INVALID_UPDATED_USERNAME400
ITEM_CONCURRENTLY_DELETEDUnknown Plaid Auth error code: ITEM_CONCURRENTLY_DELETEDPlaid ErrorPlaid docs for ITEM_CONCURRENTLY_DELETED400
ITEM_LOCKEDUnknown Plaid Auth error code: ITEM_LOCKEDPlaid ErrorPlaid docs for ITEM_LOCKED400
ITEM_LOGIN_REQUIREDUnknown Plaid Auth error code: ITEM_LOGIN_REQUIREDPlaid ErrorPlaid docs for ITEM_LOGIN_REQUIRED400
ITEM_NOT_FOUNDUnknown Plaid Auth error code: ITEM_NOT_FOUNDPlaid ErrorPlaid docs for ITEM_NOT_FOUND400
ITEM_NOT_SUPPORTEDUnknown Plaid Auth error code: ITEM_NOT_SUPPORTEDPlaid ErrorPlaid docs for ITEM_NOT_SUPPORTED400
MFA_NOT_SUPPORTEDUnknown Plaid Auth error code: MFA_NOT_SUPPORTEDPlaid ErrorPlaid docs for MFA_NOT_SUPPORTED400
NO_ACCOUNTSUnknown Plaid Auth error code: NO_ACCOUNTSPlaid ErrorPlaid docs for NO_ACCOUNTS400
NO_AUTH_ACCOUNTSUnknown Plaid Auth error code: NO_AUTH_ACCOUNTSPlaid ErrorPlaid docs for NO_AUTH_ACCOUNTS400
NO_INVESTMENT_ACCOUNTSUnknown Plaid Auth error code: NO_INVESTMENT_ACCOUNTSPlaid ErrorPlaid docs for NO_INVESTMENT_ACCOUNTS400
NO_INVESTMENT_AUTH_ACCOUNTSUnknown Plaid Auth error code: NO_INVESTMENT_AUTH_ACCOUNTSPlaid ErrorPlaid docs for NO_INVESTMENT_AUTH_ACCOUNTS400
NO_LIABILITY_ACCOUNTSUnknown Plaid Auth error code: NO_LIABILITY_ACCOUNTSPlaid ErrorPlaid docs for NO_LIABILITY_ACCOUNTS400
PRODUCT_NOT_ENABLEDUnknown Plaid Auth error code: PRODUCT_NOT_ENABLEDPlaid ErrorPlaid docs for PRODUCT_NOT_ENABLED400
PRODUCT_NOT_READYUnknown Plaid Auth error code: PRODUCT_NOT_READYPlaid ErrorPlaid docs for PRODUCT_NOT_READY400
PRODUCTS_NOT_SUPPORTEDUnknown Plaid Auth error code: PRODUCTS_NOT_SUPPORTEDPlaid ErrorPlaid docs for PRODUCTS_NOT_SUPPORTED400
USER_SETUP_REQUIREDUnknown Plaid Auth error code: USER_SETUP_REQUIREDPlaid ErrorPlaid docs for USER_SETUP_REQUIRED400
USER_INPUT_TIMEOUTUnknown Plaid Auth error code: USER_INPUT_TIMEOUTPlaid ErrorPlaid docs for USER_INPUT_TIMEOUT400
INCOMPATIBLE_API_VERSIONUnknown Plaid Auth error code: INCOMPATIBLE_API_VERSIONPlaid ErrorPlaid docs for INCOMPATIBLE_API_VERSION400
INVALID_ACCOUNT_NUMBERUnknown Plaid Auth error code: INVALID_ACCOUNT_NUMBERPlaid ErrorPlaid docs for INVALID_ACCOUNT_NUMBER400
INVALID_BODYUnknown Plaid Auth error code: INVALID_BODYPlaid ErrorPlaid docs for INVALID_BODY400
INVALID_CONFIGURATIONUnknown Plaid Auth error code: INVALID_CONFIGURATIONPlaid ErrorPlaid docs for INVALID_CONFIGURATION400
INVALID_FIELDUnknown Plaid Auth error code: INVALID_FIELDPlaid ErrorPlaid docs for INVALID_FIELD400
INVALID_HEADERSUnknown Plaid Auth error code: INVALID_HEADERSPlaid ErrorPlaid docs for INVALID_HEADERS400
MISSING_FIELDSUnknown Plaid Auth error code: MISSING_FIELDSPlaid ErrorPlaid docs for MISSING_FIELDS400
NO_LONGER_AVAILABLEUnknown Plaid Auth error code: NO_LONGER_AVAILABLEPlaid ErrorPlaid docs for NO_LONGER_AVAILABLE400
NOT_FOUNDUnknown Plaid Auth error code: NOT_FOUNDPlaid ErrorPlaid docs for NOT_FOUND400
SANDBOX_ONLYUnknown Plaid Auth error code: SANDBOX_ONLYPlaid ErrorPlaid docs for SANDBOX_ONLY400
UNKNOWN_FIELDUnknown Plaid Auth error code: UNKNOWN_FIELDPlaid ErrorPlaid docs for UNKNOWN_FIELD400
LAST_UPDATED_DATETIME_OUT_OF_RANGEUnknown Plaid Auth error code: LAST_UPDATED_DATETIME_OUT_OF_RANGEPlaid ErrorPlaid docs for LAST_UPDATED_DATETIME_OUT_OF_RANGE400
PLAID_DIRECT_ITEM_IMPORT_RETURNED_INVALID_MFAUnknown Plaid Auth error code: PLAID_DIRECT_ITEM_IMPORT_RETURNED_INVALID_MFAPlaid ErrorPlaid docs for PLAID_DIRECT_ITEM_IMPORT_RETURNED_INVALID_MFA400
ACCOUNTS_LIMITUnknown Plaid Auth error code: ACCOUNTS_LIMITPlaid Rate LimitPlaid docs for ACCOUNTS_LIMIT400
ADDITION_LIMITUnknown Plaid Auth error code: ADDITION_LIMITPlaid Rate LimitPlaid docs for ADDITION_LIMIT400
AUTH_LIMITUnknown Plaid Auth error code: AUTH_LIMITPlaid Rate LimitPlaid docs for AUTH_LIMIT400
BALANCE_LIMITUnknown Plaid Auth error code: BALANCE_LIMITPlaid Rate LimitPlaid docs for BALANCE_LIMIT400
IDENTITY_LIMITUnknown Plaid Auth error code: IDENTITY_LIMITPlaid Rate LimitPlaid docs for IDENTITY_LIMIT400
INSTITUTIONS_GET_LIMITUnknown Plaid Auth error code: INSTITUTIONS_GET_LIMITPlaid Rate LimitPlaid docs for INSTITUTIONS_GET_LIMIT400
INSTITUTIONS_GET_BY_ID_LIMITUnknown Plaid Auth error code: INSTITUTIONS_GET_BY_ID_LIMITPlaid Rate LimitPlaid docs for INSTITUTIONS_GET_BY_ID_LIMIT400
INVESTMENT_HOLDINGS_GET_LIMITUnknown Plaid Auth error code: INVESTMENT_HOLDINGS_GET_LIMITPlaid Rate LimitPlaid docs for INVESTMENT_HOLDINGS_GET_LIMIT400
INVESTMENT_TRANSACTIONS_LIMITUnknown Plaid Auth error code: INVESTMENT_TRANSACTIONS_LIMITPlaid Rate LimitPlaid docs for INVESTMENT_TRANSACTIONS_LIMIT400
ITEM_GET_LIMITUnknown Plaid Auth error code: ITEM_GET_LIMITPlaid Rate LimitPlaid docs for ITEM_GET_LIMIT400
RATE_LIMITUnknown Plaid Auth error code: RATE_LIMITPlaid Rate LimitPlaid docs for RATE_LIMIT400
TRANSACTIONS_LIMITUnknown Plaid Auth error code: TRANSACTIONS_LIMITPlaid Rate LimitPlaid docs for TRANSACTIONS_LIMIT400
INCORRECT_OAUTH_NONCEUnknown Plaid Auth error code: INCORRECT_OAUTH_NONCEPlaid ErrorPlaid docs for INCORRECT_OAUTH_NONCE400
INCORRECT_LINK_TOKENUnknown Plaid Auth error code: INCORRECT_LINK_TOKENPlaid ErrorPlaid docs for INCORRECT_LINK_TOKEN400
OAUTH_STATE_ID_ALREADY_PROCESSEDUnknown Plaid Auth error code: OAUTH_STATE_ID_ALREADY_PROCESSEDPlaid ErrorPlaid docs for OAUTH_STATE_ID_ALREADY_PROCESSED400
OAUTH_STATE_ID_NOT_FOUNDUnknown Plaid Auth error code: OAUTH_STATE_ID_NOT_FOUNDPlaid ErrorPlaid docs for OAUTH_STATE_ID_NOT_FOUND400
MICRODEPOSITS_UNSUPPORRTED_ENVIRONMENTUnknown Plaid Auth error code: MICRODEPOSITS_UNSUPPORRTED_ENVIRONMENTPlaid ErrorPlaid docs for MICRODEPOSITS_UNSUPPORRTED_ENVIRONMENT400
SANDBOX_PRODUCT_NOT_ENABLEDUnknown Plaid Auth error code: SANDBOX_PRODUCT_NOT_ENABLEDPlaid ErrorPlaid docs for SANDBOX_PRODUCT_NOT_ENABLED400
SANDBOX_WEBHOOK_INVALIDUnknown Plaid Auth error code: SANDBOX_WEBHOOK_INVALIDPlaid ErrorPlaid docs for SANDBOX_WEBHOOK_INVALID400
SANDBOX_ACCOUNT_SELECT_V2_NOT_ENABLEDUnknown Plaid Auth error code: SANDBOX_ACCOUNT_SELECT_V2_NOT_ENABLEDPlaid ErrorPlaid docs for SANDBOX_ACCOUNT_SELECT_V2_NOT_ENABLED400
SANDBOX_TRANSFER_EVENT_TRANSITION_INVALIDUnknown Plaid Auth error code: SANDBOX_TRANSFER_EVENT_TRANSITION_INVALIDPlaid ErrorPlaid docs for SANDBOX_TRANSFER_EVENT_TRANSITION_INVALID400

Updated about 1 year ago