plaid

Subscribe to Monitoring Insights

This endpoint allows you to subscribe to insights for a user's linked CRA Item, which are updated between one and four times per day (best-effort). In the current Cash Flow Updates beta experience, only one Item per user may be subscribed for monitoring updates.

post/cra/monitoring_insights/subscribe

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.

item_idstring

The Item ID to subscribe for Cash Flow Updates.

webhookstring url required

URL to which Plaid will send Cash Flow Updates webhooks, for example when the requested Cash Flow Updates report is ready.

income_categoriesCreditBankIncomeCategory[] nullable

Income categories to include in Cash Flow Updates. If empty or null, this field will default to including all possible categories.

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.

subscription_idstring required

A unique identifier for the subscription.

Changes

Changed in 11 of the 52 revisions of this API.4188

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
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
Nov 12, 2025f8b9f1a857671See the full diff
- ▲
  the webhook request property type/format changed from string/ to string/url
  request-property-type-changed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 2, 202583dc2757b74e111See the full diff
- ▲
  added subschema #2 to the user_id request property allOf list
  request-property-all-of-added
- ●
  removed subschema #2 subschema #3 from the user_id request property allOf list
  request-property-all-of-removed
- ○
  added the new optional request property item_id
  new-optional-request-property
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 2, 2025af95b7b9aa931See the full diff
- ○
  added the new optional request property user_id
  new-optional-request-property
Mar 26, 202509cbc84449131See the full diff
- ○
  added the new optional request property income_categories
  new-optional-request-property
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 4, 2024a2c34406c3171See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (11 revisions)