plaid

Simulate a CRA Servicing report

Changed on

Use the /sandbox/cra/servicing/simulate endpoint to synchronously seed a CRA Servicing report in the Sandbox environment and return a report_id that can be fetched via /cra/check_report/base_report/get or /cra/check_report/income_insights/get. This endpoint also fires a CRA_REPORT_UPDATED webhook, mirroring the notification a live subscription would emit.

post/sandbox/cra/servicing/simulate

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/sandbox/cra/servicing/simulate
  • 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.

subscription_idstring required

The Servicing subscription to simulate an update for. Upon calling this endpoint, Plaid will simulate a report creation for all products referenced by this subscription ID.

user_idstring

The user to simulate an update for, in place of a subscription_id.

Response

OK

report_idstring nullable

The cra-report token for the seeded snapshot. Pin as report_id on /cra/check_report/base_report/get or /cra/check_report/income_insights/get. Omitted when error_webhook_code was used.

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

      removed the enum value PRODUCT_GENERATION_ERROR of the request property /

    • 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

  • 141de8aaaad2Revision changes
    • info

      added the new optional request property

    • info

      added the new PRODUCT_GENERATION_ERROR enum value to the request property /