plaid

Retrieve income insights from your user's banks

Changed on

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.

post/cra/check_report/income_insights/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/cra/check_report/income_insights/get
  • Auth
    • API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version
    • or OAuth 2
      Client credentials
      Token URL: https://api.plaid.com/oauth2/apiv2/token scopes: cra:read

Request body

client_idstring

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.

secretstring

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_tokenstring

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.

third_party_user_tokenstring

The third-party user token associated with the requested User data.

user_idstring

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.

report_idstring

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.

consumer_report_permissible_purpose'ACCOUNT_REVIEW_CREDIT' | 'WRITTEN_INSTRUCTION_OTHER'

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.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the //// response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the //// response property for the response status

  • e07a869352e8Revision changes
    • breaking

      the response property ////////// became nullable for the status

    • breaking

      the response property ////////// became nullable for the status