POST /cra/report/get

/cra/report/get retrieves a CRA Report for a user.

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
products[] Array Yes

The requested products and their versions, e.g. [{"product":"cra_qualify","version":"V1"}].

products[].version String Yes

The version of the product that was generated.

products[].product String Yes

A list of products that an institution can support. All Items must be initialized with at least one product. The Balance product is always available and does not need to be specified during initialization.

Valid values:

  • "cra_network_insights"
  • "investments_auth"
  • "recurring_transactions"
  • "pay_by_bank"
  • "protect_transactions"
  • "balance_plus"
  • "income"
  • "protect_linked_bank"
  • "identity_match"
  • "auth"
  • "transfer"
  • "liabilities"
  • "employment"
  • "processor_payments"
  • "beacon"
  • "cra_cashflow_insights"
  • "cra_qualify"
  • "credit_details"
  • "cra_plaid_credit_score"
  • "payment_initiation"
  • "investments"
  • "income_verification"
  • "cra_partner_insights"
  • "identity_verification"
  • "profile"
  • "identity"
  • "cra_base_report"
  • "transactions"
  • "cra_lend_score"
  • "cra_income_insights"
  • "standing_orders"
  • "balance"
  • "cra_monitoring"
  • "transactions_refresh"
  • "statements"
  • "processor_identity"
  • "assets"
  • "signal"
  • "layer"
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.

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"
scope String No

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.

Valid values:

  • "CLIENT_USER"
  • "PLAID_NETWORK"
decision_stage String Yes

The stage in the lending lifecycle for which the report is being retrieved.

Valid values:

  • "DECISIONING"
  • "PREQUALIFICATION"
  • "SERVICING"
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 Yes

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.