POST /cra/check_report/partner_insights/get

This endpoint allows you to retrieve the Partner 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 base report, 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 credit_partner_insights product or have generated a report using /cra/check_report/create, we will call our partners to 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

https://production.plaid.com
https://sandbox.plaid.com

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 Partner Insights
`options.prism_products[]`	Array	No	The specific Prism Data products to return. If none are passed in, then all products will be returned.
`options.prism_versions`	Object	No	The versions of Prism products to evaluate
`options.prism_versions.firstdetect`	String	No	The version of Prism FirstDetect. If not specified, will default to v3. Possible values: `"3"` `null`
`options.prism_versions.cashscore`	String	No	The version of Prism CashScore. If not specified, will default to v3. Possible values: `"3"` `"3_lite"` `null`
`options.prism_versions.insights`	String	No	The version of Prism Insights. If not specified, will default to v3. Possible values: `"3"` `null`
`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

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.