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

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 a CHECK_REPORT_READY or a USER_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 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.

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 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.
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

Deprecated, specify partner_insights.prism_versions instead.
options.prism_versions Object No

Deprecated, use partner_insights.prism_versions instead.
options.prism_versions.detect String No

The version of Prism Detect

Valid values:

  • "4"
  • null
  • "4.1"
options.prism_versions.firstdetect String No

The version of Prism FirstDetect. If not specified, will default to v3.

Valid values:

  • "3"
  • null
options.prism_versions.cashscore String No

The version of Prism CashScore. If not specified, will default to v3.

Valid values:

  • "4"
  • "3"
  • "3_lite"
  • null
  • "4.1"
options.prism_versions.extend String No

The version of Prism Extend

Valid values:

  • "4"
  • null
  • "4.1"
options.prism_versions.insights String No

The version of Prism Insights. If not specified, will default to v3.

Valid values:

  • "4"
  • "3"
  • null
  • "4.1"
third_party_user_token String No

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

The tier of the user.

Valid values:

  • "free"
  • null
  • "paid"
partner_insights Object No

Deprecated. This field is no longer accepted for new clients (created on or after 2026-07-01). New clients should specify required products when creating the Consumer Report. Existing integrations may continue to pass partner_insights.
partner_insights.fico Object No

Configuration for the FICO products used in the Partner Insights product.
partner_insights.fico.lender_application_id String Yes

Client-generated identifier that uniquely identifies the FICO Application across FICO systems.
partner_insights.fico.ultrafico_score_requests[] Array Yes

A list of UltraFICO® scoring requests. Each request contains all configuration required to generate an UltraFICO score.
partner_insights.fico.ultrafico_score_requests[].ultrafico_score_version String Yes

The version of the UltraFICO® score.

Valid values:

  • "1.0"
partner_insights.fico.ultrafico_score_requests[].base_fico_score Object Yes

Details about the base FICO score associated with an UltraFICO® scoring request.
partner_insights.fico.ultrafico_score_requests[].base_fico_score.reason_code_1 String No

Deprecated. Use reason_codes instead. The first reason code associated with the score.
partner_insights.fico.ultrafico_score_requests[].base_fico_score.score Integer Yes

Numeric value of the base FICO score.
partner_insights.fico.ultrafico_score_requests[].base_fico_score.base_fico_score_version String Yes

The version of the base FICO score model.

Valid values:

  • "10"
  • "10T"
  • "9"
  • "8"
partner_insights.fico.ultrafico_score_requests[].base_fico_score.reason_codes[] Array No

Reason codes associated with the score, in priority order. May contain up to 4 items.
partner_insights.fico.ultrafico_score_requests[].base_fico_score.reason_code_3 String No

Deprecated. Use reason_codes instead. The third reason code associated with the score.
partner_insights.fico.ultrafico_score_requests[].base_fico_score.reason_code_2 String No

Deprecated. Use reason_codes instead. The second reason code associated with the score.
partner_insights.fico.ultrafico_score_requests[].base_fico_score.bureau String Yes

The credit bureau that provided the base FICO score.

Valid values:

  • "EXPERIAN"
  • "EQUIFAX"
  • "TRANSUNION"
partner_insights.fico.ultrafico_score_requests[].base_fico_score.did_inquiries_adversely_affect_score Boolean No

Whether inquiries adversely affected the score but were not represented in one of the four reason codes. Sometimes referred to as the FACTA Flag.
partner_insights.fico.ultrafico_score_requests[].base_fico_score.reason_code_4 String No

Deprecated. Use reason_codes instead. The fourth reason code associated with the score.
partner_insights.fico.ultrafico_score_requests[].request_correlation_id String No

Client-generated identifier that can be used to correlate scoring requests with their scoring results.
partner_insights.fico.ultrafico_score_requests[].fico_scoring_request_id String No

FICO identifier for a particular scoring request. Should only be provided by FICO as part of the FICO-led flow.
partner_insights.fico.fico_lender_id String Yes

ID provided by FICO that uniquely identifies the lender. Required for UltraFICO® score generation. Sometimes referred to as Lender Org ID.
partner_insights.prism_versions Object No

The versions of Prism products to evaluate
partner_insights.prism_versions.detect String No

The version of Prism Detect

Valid values:

  • "4"
  • null
  • "4.1"
partner_insights.prism_versions.firstdetect String No

The version of Prism FirstDetect. If not specified, will default to v3.

Valid values:

  • "3"
  • null
partner_insights.prism_versions.cashscore String No

The version of Prism CashScore. If not specified, will default to v3.

Valid values:

  • "4"
  • "3"
  • "3_lite"
  • null
  • "4.1"
partner_insights.prism_versions.extend String No

The version of Prism Extend

Valid values:

  • "4"
  • null
  • "4.1"
partner_insights.prism_versions.insights String No

The version of Prism Insights. If not specified, will default to v3.

Valid values:

  • "4"
  • "3"
  • null
  • "4.1"
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.
user_id String No

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.

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
© 2026 SimWorkflow
Terms of Service Privacy Policy