Pricing Templates
Log in Sign up
Integrations / Plaid / ...

POST /cra/check_report/cashflow_insights/get

This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received the 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 insights, 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.

If you did not initialize Link with the cra_cashflow_insights product or have generated a report using /cra/check_report/create, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under options to configure which insights you want to receive.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
user_token String No

The user token associated with the User data is being requested for.
client_id String No

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.
options Object No

Defines configuration options to generate Cashflow Insights
options.plaid_check_score_version String No

The version of the Plaid Check Score

Possible values:

  • "v1.0"
  • "v2.0"
options.attributes_version String No

The version of cashflow attributes

Possible values:

  • "v1.0"
third_party_user_token String No

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

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy