plaid

Retrieve cash flow insights from the bank accounts used for income verification

/cra/partner_insights/get returns cash flow insights for a specified user.

post/cra/partner_insights/get

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 required

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.

user_tier'free' | 'paid' | 'null' nullable

The tier of the user.

Response

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

Changed in 20 of the 52 revisions of this API.64254

Jul 22, 2026a1bbca018160131See the full diff
- ●
  added the new ASSETS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CRA_MONITORING_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CREDIT_PROFILE_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new ENCOMPASS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new ENRICH_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new FRAUD_INSIGHTS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new FREDDIE_MAC_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new LINK_DELIVERY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new PROFILE_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new RECURRING_TRANSACTIONS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new STATEMENTS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_RECURRING_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_REFUND_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ○
  added the optional property report/items/fico/ultrafico_score_results/items/exclusion_code to the response with the 200 status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 25, 202680d23bfdc2e51See the full diff
- ●
  added the new IDEMPOTENCY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
Jun 10, 2026fb8c3f188d8b112See the full diff
- ●
  added the new BASE_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ○
  added the optional property report/items/fico/ultrafico_score_results/items/ultrafico_score/negative_reason_codes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/fico/ultrafico_score_results/items/ultrafico_score/positive_reason_codes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/prism/insights/model_version to the response with the 200 status
  response-optional-property-added
- ○
  response property report/items/fico/ultrafico_score_results/items/ultrafico_score/positive_reason_code_1 deprecated
  response-property-deprecated
- ○
  response property report/items/fico/ultrafico_score_results/items/ultrafico_score/positive_reason_code_2 deprecated
  response-property-deprecated
- ○
  response property report/items/fico/ultrafico_score_results/items/ultrafico_score/positive_reason_code_3 deprecated
  response-property-deprecated
- ○
  response property report/items/fico/ultrafico_score_results/items/ultrafico_score/positive_reason_code_4 deprecated
  response-property-deprecated
- ○
  response property report/items/fico/ultrafico_score_results/items/ultrafico_score/reason_code_1 deprecated
  response-property-deprecated
- ○
  response property report/items/fico/ultrafico_score_results/items/ultrafico_score/reason_code_2 deprecated
  response-property-deprecated
- ○
  response property report/items/fico/ultrafico_score_results/items/ultrafico_score/reason_code_3 deprecated
  response-property-deprecated
- ○
  response property report/items/fico/ultrafico_score_results/items/ultrafico_score/reason_code_4 deprecated
  response-property-deprecated
- ○
  response property report/items/prism/insights/version deprecated
  response-property-deprecated
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 17, 2026b9a2871636de15See the full diff
- ●
  added the new limited purpose checking enum value to the report/items/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property report/items/fico/report_characteristics to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/fico/ultrafico_score_results/items/ultrafico_score/positive_reason_code_1 to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/fico/ultrafico_score_results/items/ultrafico_score/positive_reason_code_2 to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/fico/ultrafico_score_results/items/ultrafico_score/positive_reason_code_3 to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/fico/ultrafico_score_results/items/ultrafico_score/positive_reason_code_4 to the response with the 200 status
  response-optional-property-added
Apr 2, 20267f9a02ad0ce311See the full diff
- ▲
  the response property report/items/prism became nullable for the status 200
  response-property-became-nullable
- ○
  added the new optional request property user_tier
  new-optional-request-property
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 4, 2026ac31f04fdb581See the full diff
- ○
  added the optional property report/items/fico to the response with the 200 status
  response-optional-property-added
Dec 11, 2025465584b48c992See the full diff
- ○
  added the optional property provided_account_subtypes to the response with the default status
  response-optional-property-added
- ○
  added the optional property required_account_subtypes to the response with the default status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 19, 20254abee1c569291See the full diff
- ○
  removed the IDENTITY_ERROR enum value from the error_type response property for the response status default
  response-property-enum-value-removed
Nov 12, 2025f8b9f1a857672See the full diff
- ●
  added the new IDENTITY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new USER_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 22, 2025af4b6e71d87f1See the full diff
- ●
  added the new SIGNAL_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added

Full history (20 revisions)