plaid

Gets insights data in Cashflow Report

Changed on

The /cashflow_report/insights/get endpoint retrieves insights data associated with an Item. Insights are only calculated on credit and depository accounts.

post/cashflow_report/insights/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/cashflow_report/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.

access_tokenstring required

The access token associated with the Item for which data is being requested.

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.

Response

OK

last_generated_timestring date-time required

Datetime of last Cashflow Report generation in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ )

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

  • 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_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

    • warning

      added the new CRA_REPORT_ERROR enum value to the // response property for the response status

    • info

      added the optional property /// to the response with the status

  • e07a869352e8Revision changes
    • breaking

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

    • info

      added the optional property / to the response with 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