plaid

Retrieve a Monitoring Insights Report

This endpoint allows you to retrieve a Cash Flow Updates report by passing in the user_id referred to in the webhook you received.

post/cra/monitoring_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_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.

consumer_report_permissible_purpose'ACCOUNT_REVIEW_CREDIT' | 'WRITTEN_INSTRUCTION_OTHER' required

Describes the reason you are generating a Consumer Report for this user.

ACCOUNT_REVIEW_CREDIT: In connection with a consumer credit transaction for the review or collection of an account pursuant to FCRA Section 604(a)(3)(A).

WRITTEN_INSTRUCTION_OTHER: In accordance with the written instructions of the consumer pursuant to FCRA Section 604(a)(2), such as when an individual agrees to act as a guarantor or assumes personal liability for a consumer, business, or commercial loan.

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.

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.

user_insights_idstring required

A unique ID identifying a User Monitoring Insights Report. Like all Plaid identifiers, this ID is case sensitive.

Changes

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

Aug 17, 2026e536704a333f5See the full diff
- ●
  added the new charge card enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new commercial line of credit enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new home equity loan enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new installment enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new prediction market enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 2026a1bbca01816013See 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
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, 2026fb8c3f188d8b1See 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
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 17, 2026b9a2871636de1See the full diff
- ●
  added the new limited purpose checking enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
Apr 2, 20267f9a02ad0ce37See the full diff
- ●
  added the new fhsa enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new qshr enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth 403B enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth 457b enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth pension enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth profit sharing plan enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth thrift savings plan enum value to the items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
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 items/items/accounts/items/transactions/items/personal_finance_category to the response with the 200 status
  response-optional-property-added
Dec 11, 2025465584b48c99112See the full diff
- ▲
  the user_id request property type/format changed from / to string/
  request-property-type-changed
- ●
  removed NewUserID from the user_id request property allOf list
  request-property-all-of-removed
- ○
  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, 20254abee1c5692912See the full diff
- ●
  removed subschema #2 from the user_id request property allOf list
  request-property-all-of-removed
- ○
  the request property user_token became optional
  request-property-became-optional
- ○
  removed the IDENTITY_ERROR enum value from the error_type response property for the response status default
  response-property-enum-value-removed
Oct 2, 202583dc2757b74e1316See the full diff
- ▲
  added subschema #2 to the user_id request property allOf list
  request-property-all-of-added
- ▲
  the response property items/items/insights/income/forecasted_monthly_income/baseline_amount became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property items/items/insights/income/historical_annual_income/baseline_amount became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property items/items/insights/income/income_sources_counts/baseline_count became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property items/items/insights/income/total_monthly_income/baseline_amount became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property items/items/insights/loans/loan_payment_merchants_counts/baseline_count became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property items/items/insights/loans/loan_payments_counts/baseline_count became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property items/items/insights/income/forecasted_monthly_income/baseline_amount became optional for the status 200
  response-property-became-optional
- ▲
  the response property items/items/insights/income/historical_annual_income/baseline_amount became optional for the status 200
  response-property-became-optional
- ▲
  the response property items/items/insights/income/income_sources_counts/baseline_count became optional for the status 200
  response-property-became-optional
- ▲
  the response property items/items/insights/income/total_monthly_income/baseline_amount became optional for the status 200
  response-property-became-optional
- ▲
  the response property items/items/insights/loans/loan_payment_merchants_counts/baseline_count became optional for the status 200
  response-property-became-optional
- ▲
  the response property items/items/insights/loans/loan_payments_counts/baseline_count became optional for the status 200
  response-property-became-optional
- ●
  removed subschema #2 subschema #3 from the user_id request property allOf list
  request-property-all-of-removed
- ○
  response property items/items/insights/income/forecasted_monthly_income/baseline_amount deprecated
  response-property-deprecated
- ○
  response property items/items/insights/income/historical_annual_income/baseline_amount deprecated
  response-property-deprecated
- ○
  response property items/items/insights/income/income_sources_counts/baseline_count deprecated
  response-property-deprecated
- ○
  response property items/items/insights/income/total_monthly_income/baseline_amount deprecated
  response-property-deprecated
- ○
  response property items/items/insights/loans/loan_payment_merchants_counts/baseline_count deprecated
  response-property-deprecated
- ○
  response property items/items/insights/loans/loan_payments_counts/baseline_count deprecated
  response-property-deprecated
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (20 revisions)