Check Report webhook errors

Guide to troubleshooting Check Report webhook errors

DATA_UNAVAILABLE

Common causes

The report did not have sufficient data to generate: no eligible transactions, an Item's data could not be refreshed, identity was unavailable, or a document upload yielded no transactions.

Troubleshooting steps

If repairable_items is non-empty, initialize Link update mode for those Items so the user can fix them, then call /cra/check_report/create to regenerate the report.

If repairable_items is empty, have the user connect a different account via Plaid Link, then call /cra/check_report/create to regenerate the report.

API error response

http code 400
{
 "error_type": "CHECK_REPORT_ERROR",
 "error_code": "DATA_UNAVAILABLE",
 "error_message": "the check report did not have sufficient data to generate a report. Review the repairable_items list for any Items the user can fix via Link update mode. Once completed, a new report can be generated by calling /cra/check_report/create",
 "display_message": null,
 "request_id": "HNTDNrA8F1shFEW"
}

PRODUCT_GENERATION_FAILED

Common causes

Data was present, but all requested products failed to generate. If only some products failed, a CHECK_REPORT_READY webhook is fired instead.

Troubleshooting steps

Review the failed_products list and call each product's /get endpoint for product-specific error details.

API error response

http code 400
{
 "error_type": "CHECK_REPORT_ERROR",
 "error_code": "PRODUCT_GENERATION_FAILED",
 "error_message": "all requested products failed to generate. Call the corresponding product /get endpoint for product-specific error details",
 "display_message": null,
 "request_id": "HNTDNrA8F1shFEW"
}

INTERNAL_SERVER_ERROR

Common causes

A transient Plaid-side error occurred while generating the report after retries were exhausted.

Troubleshooting steps

Retry by calling /cra/check_report/create. No user action is required.

API error response

http code 500
{
 "error_type": "CHECK_REPORT_ERROR",
 "error_code": "INTERNAL_SERVER_ERROR",
 "error_message": "an internal error occurred while generating the report. Please retry by calling /cra/check_report/create",
 "display_message": null,
 "request_id": "HNTDNrA8F1shFEW"
}