POST /cra/check_report/income_insights/get

This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you've received a CHECK_REPORT_READY or a USER_CHECK_REPORT_READY webhook, either after the Link session for the user or after calling /cra/check_report/create. If the most recent consumer report for the user doesn't have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling /cra/check_report/create.

NOTE: The following schema was updated in April 2026 to reflect the response when the provided version is "II2". Please see this document for guidance on migrating to II2 if you are currently using the II1 version, and this section for an example II1 response along with its documentation.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`user_token`	String	No	The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the `user_token` field. All other customers should use the `user_id` instead. For more details, see New User APIs.
`client_id`	String	No	Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
`options`	Object	No	Deprecated. This field is no longer accepted for new clients (created on or after 2026-07-01). New clients should specify required products when creating the Consumer Report. Existing integrations may continue to pass `options`.
`options.income_insights_version`	String	Yes	The version of Income Insights to use. This value is not shared across API calls for the same resource. If it is omitted from a request, the default version is used, even if a version was set in an earlier call such as `/link/token/create` or `/cra/check_report/create`. Valid values: `"II2"`
`options.income_insights_filter`	Object	No	Filters the returned income streams based on the specified income categories. If no filters are requested, streams from the following default set of categories are returned: `EARNED_INCOME.` (`EARNED_INCOME.SALARY`, `EARNED_INCOME.GIG_ECONOMY`, `EARNED_INCOME.SELF_EMPLOYED`) `BENEFITS.DISABILITY` `RETIREMENT.` (`RETIREMENT.GOVERNMENT_DERIVED`, `RETIREMENT.PRIVATE_RETIREMENT`, `RETIREMENT.PLAN_DISTRIBUTION`) The final list of income categories is generated by adding the `included_categories`, then removing the `excluded_categories`. Priority is given to `excluded_categories` in the case of collisions. Filter patterns supported: ``: All categories `PRIMARY.`: All categories within the specified primary category `PRIMARY.SECONDARY`: A specific income category For a list of income categories, see the Income V2 Category Taxonomy.
`options.income_insights_filter.included_categories[]`	Array	Yes	Includes income streams matching the specified categories.
`options.income_insights_filter.excluded_categories[]`	Array	No	Excludes income streams matching the specified categories.
`third_party_user_token`	String	No	The third-party user token associated with the requested User data.
`consumer_report_permissible_purpose`	String	No	The permissible purpose under the FCRA for retrieving this consumer report. Restricted to permissible purposes related to loan servicing only. Required when `report_id` is provided. Valid values: `"ACCOUNT_REVIEW_CREDIT"` `"WRITTEN_INSTRUCTION_OTHER"`
`report_id`	String	No	The CRA report token (formatted `cra-report-<env>-<uuid>`) identifying a specific consumer report. When provided alongside `consumer_report_permissible_purpose`, pins retrieval to that report and stamps its permissible purpose. If omitted, the most recently generated report for the user is returned.
`secret`	String	No	Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
`user_id`	String	No	A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see New User APIs.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.