Income (beta) errors

Guide to troubleshooting Income errors

PRODUCT_NOT_ENABLED

The Income product has not been enabled.

Server-Side

Common causes

The Income product has not been enabled.

Troubleshooting steps

Make sure to initialize Link with income in the product array.

Contact your Plaid Account Manager or Plaid Support to request that your account be enabled for Income Verification.

API error response
1
2
3
4
5
6
7
8
http code 400 
{
 "error_type": "INCOME_VERIFICATION_ERROR",
 "error_code": "PRODUCT_NOT_ENABLED",
 "error_message": "the 'income_verification' product is not enabled for the following client ID: <CLIENT_ID>. please ensure that the 'income_verification' is included in the 'product' array when initializing Link and try again.",
 "display_message": null,
 "request_id": "HNTDNrA8F1shFEW"
}

INCOME_VERIFICATION_NOT_FOUND

An employment verification instance with the given ID was not found.

Server-Side

Common causes

An invalid income verification ID was provided.

Ensure that the income verification ID provided is valid and from the correct environment. Also be sure to preserve the case of any non-numeric characters in the income verification ID, as they are case sensitive.

API error response
1
2
3
4
5
6
7
8
http code 400 
{
 "error_type": "INCOME_VERIFICATION_ERROR",
 "error_code": "INCOME_VERIFICATION_NOT_FOUND",
 "error_message": "an 'income_verification' with the id <ID> cannot be found",
 "display_message": null,
 "request_id": "HNTDNrA8F1shFEW"
}

INCOME_VERIFICATION_UPLOAD_ERROR

There was an error uploading income verification documents.

Server-SideorClient-Side

Common causes

The end user's Internet connection may have been interrupted during the upload attempt.

Troubleshooting steps

Plaid will prompt the end user to re-try uploading their documents.

API error response
1
2
3
4
5
6
7
8
http code 400 
{
 "error_type": "INCOME_VERIFICATION_ERROR",
 "error_code": "INCOME_VERIFICATION_UPLOAD_ERROR",
 "error_message": "there was a problem uploading the document for verification. Please try again or recreate an income verification.",
 "display_message": null,
 "request_id": "HNTDNrA8F1shFEW"
}

INCOME_VERIFICATION_DOCUMENT_INVALID

A document used to verify income was invalid.

Server-SideorClient-Side

Common causes

The uploaded document was not a supported type. The following filetypes are supported: PDF, JPEG, PNG, BMP, GIF, TIFF.

Troubleshooting steps

Plaid will prompt the end user to re-try uploading their documents.

API error response
1
2
3
4
5
6
7
8
http code 400 
{
 "error_type": "INCOME_VERIFICATION_ERROR",
 "error_code": "INCOME_VERIFICATION_DOCUMENT_INVALID",
 "error_message": "the uploaded document is invalid. upload must be a PDF or image of type JPEG, PNG, BMP, GIF, TIFF",
 "display_message": null,
 "request_id": "HNTDNrA8F1shFEW"
}

INCOME_VERIFICATION_DOCUMENT_NOT_RECOGNIZED

The uploaded income verification document could not be recognized.

Server-SideorClient-Side

Common causes

The uploaded document was not recognized as a paystub.

Troubleshooting steps

Plaid will prompt the end user to re-try uploading their documents.

If you have verified that the user is uploading a valid paystub but is continuing to receive this error, contact Plaid Support.

API error response
1
2
3
4
5
6
7
8
http code 400 
{
 "error_type": "INCOME_VERIFICATION_ERROR",
 "error_code": "INCOME_VERIFICATION_DOCUMENT_NOT_RECOGNIZED",
 "error_message": "the uploaded document was not recognized as an accepted document type",
 "display_message": null,
 "request_id": "HNTDNrA8F1shFEW"
}

INCOME_VERIFICATION_FAILED

The income verification you are trying to retrieve could not be completed. please try creating a new income verification

Server-SideorClient-Side

Common causes

The processing of the verification failed to complete successfully.

Troubleshooting steps

Have the user retry the verification.

If the problem persists, contact Plaid Support.

API error response
1
2
3
4
5
6
7
8
http code 500 
{
 "error_type": "INCOME_VERIFICATION_ERROR",
 "error_code": "INCOME_VERIFICATION_FAILED",
 "error_message": "the income verification you are trying to retrieve could not be completed. please try creating a new income verification",
 "display_message": null,
 "request_id": "HNTDNrA8F1shFEW"
}