plaid

(Legacy) Retrieve a Cash Flow Updates report

Changed on

This endpoint allows you to retrieve a Cash Flow Updates report by passing in the user_id referred to in the webhook you received. This endpoint is part of the legacy Cash Flow Updates product and is available only to integrations already using it. CRA Servicing has no direct equivalent; other integrations should handle the CRA_REPORT_UPDATED webhook and pass its report_id to the relevant product /get endpoint, such as /cra/check_report/base_report/get.

post/cra/monitoring_insights/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/cra/monitoring_insights/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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

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.

user_insights_idstring required

A unique ID identifying a User Monitoring Insights Report. Like all Plaid identifiers, this ID 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_REPORT_ERROR enum value to the response property for the response status

  • e07a869352e8Revision changes
    • breaking

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

    • info

      removed the charge card enum value from the //// response property for the response status

    • info

      removed the installment enum value from the //// response property for the response status