plaid

Create a CRA Report for provided user

/cra/report/create generates a CRA Report for a user from the Items associated with that user.

Each requested product is generated asynchronously. Use the returned report_id to retrieve the report once its products are ready.

post/cra/report/create

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.

user_idstring required

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.

scope'PLAID_NETWORK' | 'CLIENT_USER'

Determines whose items are used. PLAID_NETWORK (default) uses the Plaid Network view of the user's profile. CLIENT_USER uses only the items linked by this client.

decision_stage'PREQUALIFICATION' | 'DECISIONING' | 'SERVICING' required

The stage in the lending lifecycle that the report is for.

consumer_report_permissible_purpose'ACCOUNT_REVIEW_CREDIT' | 'ACCOUNT_REVIEW_NON_CREDIT' | 'EXTENSION_OF_CREDIT' | 'LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING' | 'LEGITIMATE_BUSINESS_NEED_OTHER' | 'WRITTEN_INSTRUCTION_PREQUALIFICATION' | 'WRITTEN_INSTRUCTION_OTHER' | 'ELIGIBILITY_FOR_GOVT_BENEFITS' required

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

client_report_idstring nullable

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

days_requestedinteger nullable

The number of days of history to include in Plaid Check products. Maximum is 731; minimum is 180. If a value lower than 180 is provided, a minimum of 180 days of history will be requested.

days_requiredinteger nullable

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

include_investmentsboolean nullable

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

webhookstring url

The destination URL to which the report's webhooks will be sent.

Response

OK

report_idstring required

The identifier of the report being generated. Use it to retrieve the report once its products are ready.

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

Changed in 1 of the 54 revisions of this API.1