POST /cra/check_report/create

Use /cra/check_report/create to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any /get endpoints on the report before it expires. If a report expires, you can call /cra/check_report/create again to re-generate it and refresh the data in the report.

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
days_requested Integer Yes

The number of days of data to request for the report. Default value is 365; maximum is 731; minimum is 180. If a value lower than 180 is provided, a minimum of 180 days of history will be requested.

user_token String No

The user token associated with the User data is being requested for. 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.

base_report Object No

Defines configuration options to generate a Base Report

base_report.require_identity Boolean No

Indicates that the report must include identity information. If identity information is not available, the report will fail.

base_report.gse_options Object No

Specifies options for creating reports that can be shared with GSEs for mortgage verification.

base_report.gse_options.report_types[] Array Yes

Specifies which types of reports should be made available to GSEs.

base_report.client_report_id String No

Client-generated identifier, which can be used by lenders to track loan applications. This field is deprecated. Use the client_report_id field at the top level of the request instead.

client_report_id String No

Client-generated identifier, which can be used by lenders to track loan applications.

products[] Array No

Specifies a list of products that will be eagerly generated when creating the report (in addition to the Base Report, which is always eagerly generated). These products will be made available before a success webhook is sent. Use this option to minimize response latency for product /get endpoints. Note that specifying cra_partner_insights in this field will trigger a billable event. Other products are not billed until the respective reports are fetched via product-specific /get endpoints.

days_required Integer No

The minimum number of days of data required for the report to be successfully generated.

webhook String Yes

The destination URL to which webhooks will be sent

network_insights Object No

Defines configuration options to generate Network Insights

network_insights.network_insights_version String No

The version of network insights

Valid values:

  • "NI1"
consumer_report_permissible_purpose String Yes

Describes the reason you are generating a Consumer Report for this user. When calling /link/token/create, this field is required when using Plaid Check (CRA) products; invalid if not using Plaid Check (CRA) products.

ACCOUNT_REVIEW_CREDIT: In connection with a consumer credit transaction for the review or collection of an account pursuant to FCRA Section 604(a)(3)(A).

ACCOUNT_REVIEW_NON_CREDIT: For a legitimate business need of the information to review a non-credit account provided primarily for personal, family, or household purposes to determine whether the consumer continues to meet the terms of the account pursuant to FCRA Section 604(a)(3)(F)(2).

EXTENSION_OF_CREDIT: In connection with a credit transaction initiated by and involving the consumer pursuant to FCRA Section 604(a)(3)(A).

LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING: For a legitimate business need in connection with a business transaction initiated by the consumer primarily for personal, family, or household purposes in connection with a property rental assessment pursuant to FCRA Section 604(a)(3)(F)(i).

LEGITIMATE_BUSINESS_NEED_OTHER: For a legitimate business need in connection with a business transaction made primarily for personal, family, or household initiated by the consumer pursuant to FCRA Section 604(a)(3)(F)(i).

WRITTEN_INSTRUCTION_PREQUALIFICATION: In accordance with the written instructions of the consumer pursuant to FCRA Section 604(a)(2), to evaluate an application’s profile to make an offer to the consumer.

WRITTEN_INSTRUCTION_OTHER: In accordance with the written instructions of the consumer pursuant to FCRA Section 604(a)(2), such as when an individual agrees to act as a guarantor or assumes personal liability for a consumer, business, or commercial loan.

ELIGIBILITY_FOR_GOVT_BENEFITS: In connection with an eligibility determination for a government benefit where the entity is required to consider an applicant’s financial status pursuant to FCRA Section 604(a)(3)(D).

Valid values:

  • "WRITTEN_INSTRUCTION_PREQUALIFICATION"
  • "ACCOUNT_REVIEW_CREDIT"
  • "ACCOUNT_REVIEW_NON_CREDIT"
  • "ELIGIBILITY_FOR_GOVT_BENEFITS"
  • "LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING"
  • "EXTENSION_OF_CREDIT"
  • "WRITTEN_INSTRUCTION_OTHER"
  • "LEGITIMATE_BUSINESS_NEED_OTHER"
cashflow_insights Object No

Defines configuration options to generate Cashflow Insights

cashflow_insights.plaid_check_score_version String No

The version of the Check Score. New integrations should use /cra/check_report/lend_score/get and the LendScore instead.

Valid values:

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

The version of cashflow attributes

Valid values:

  • "CFI1"
  • "v1.0"
  • "v2.0"
partner_insights Object No

Defines configuration to generate Partner Insights.

partner_insights.prism_products[] Array No

The specific Prism Data products to return. If none are passed in, then all products will be returned.

partner_insights.fico Object No

Configurations for FICO products used in the Partner Insights flow.

partner_insights.fico.lender_application_id String Yes

Client-generated identifier that uniquely identifies the FICO Application ID 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

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:

  • "10T"
  • "9"
  • "8"
partner_insights.fico.ultrafico_score_requests[].base_fico_score.reason_code_3 String No

The third reason code associated with the score.

partner_insights.fico.ultrafico_score_requests[].base_fico_score.reason_code_2 String No

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

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 and 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 UltraFICO 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
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
partner_insights.prism_versions.extend String No

The version of Prism Extend

Valid values:

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

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

Valid values:

  • "4"
  • "3"
  • null
lend_score Object No

Defines configuration options to generate the LendScore

lend_score.lend_score_version String No

The version of the LendScore

Valid values:

  • "LS1"
  • "v1.0"
  • "v2.0"
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.

include_investments Boolean No

Indicates that investment data should be extracted from the linked account(s).

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.