plaid

Retrieve a Consumer Report for your user

Changed on

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

post/cra/report/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/cra/report/get
  • Auth
    • API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version
    • or OAuth 2
      Client credentials
      Token URL: https://api.plaid.com/oauth2/apiv2/token scopes: cra:read

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 credit or other eligibility decisioning lifecycle for which a given report will be utilized.

Allowable permissible purposes for PREQUALIFICATION:

  • WRITTEN_INSTRUCTION_PREQUALIFICATION

Allowable permissible purposes for DECISIONING:

  • ELIGIBILITY_FOR_GOVT_BENEFITS
  • EXTENSION_OF_CREDIT
  • LEGITIMATE_BUSINESS_NEED_OTHER
  • LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING
  • WRITTEN_INSTRUCTION_OTHER

If an incompatible decision_stage and consumer_report_permissible_purpose pairing is requested, an INVALID_FIELD error is returned. If your client isn't yet enabled for a given decision_stage on a product, a DECISION_STAGE_NOT_ENABLED error is returned instead (contact your Plaid account manager to enable it).

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. The purpose must be one of the allowable permissible purposes for the decision_stage.

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

INSURANCE_UNDERWRITING: In connection with the underwriting of insurance involving the consumer pursuant to FCRA Section 604(a)(3)(C).

report_idstring

A unique ID identifying a Consumer Report. Like all Plaid identifiers, this ID is case sensitive. When provided, that specific report is returned; when omitted, the most recent report matching the request is returned. Omit this field when retrieving a report without a prior /cra/report/create or /link/token/create request.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

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.

client_user_idstring nullable required

The unique ID representing the end user that you supplied as client_user_id when creating the user via /user/create. null if the user has no client_user_id on record.

Changes

  • ea443cd78f6fRevision changes
    • breaking

      added subschema #2 to the request property allOf list

    • breaking

      removed the enum value ACCOUNT_REVIEW_CREDIT of the request property

    • breaking

      removed the enum value ACCOUNT_REVIEW_NON_CREDIT of the request property

    • breaking

      removed the enum value ELIGIBILITY_FOR_GOVT_BENEFITS of the request property

    • breaking

      removed the enum value EXTENSION_OF_CREDIT of the request property

    • breaking

      removed the enum value LEGITIMATE_BUSINESS_NEED_OTHER of the request property

    • breaking

      removed the enum value LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING of the request property

    • breaking

      removed the enum value WRITTEN_INSTRUCTION_OTHER of the request property

    • breaking

      removed the enum value WRITTEN_INSTRUCTION_PREQUALIFICATION of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      the / response's property type changed from string to no type for status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the ////// response property for the response status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the ////// response property for the response status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the ////// response property for the response status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the //// response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the ////// response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the ////// response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the ////// response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the //// response property for the response status

    • info

      added the new optional request property ///

    • info

      added cra_lend_score_complete cra_income_complete discriminator mapping keys to the / request property

    • info

      added to the / request property oneOf list

    • info

      added subschema #2 to the / response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      added cra_cashflow_insights cra_network_insights cra_lend_score cra_base_report cra_lend_score_complete cra_income_complete discriminator mapping keys to the // response property for the response status

    • info

      removed the ACCOUNT_REVIEW_CREDIT enum value from the / response property for the response status

    • info

      removed the ACCOUNT_REVIEW_NON_CREDIT enum value from the / response property for the response status

    • info

      removed the ELIGIBILITY_FOR_GOVT_BENEFITS enum value from the / response property for the response status

    • info

      removed the EXTENSION_OF_CREDIT enum value from the / response property for the response status

    • info

      removed the LEGITIMATE_BUSINESS_NEED_OTHER enum value from the / response property for the response status

    • info

      removed the LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING enum value from the / response property for the response status

    • info

      removed the WRITTEN_INSTRUCTION_OTHER enum value from the / response property for the response status

    • info

      removed the WRITTEN_INSTRUCTION_PREQUALIFICATION enum value from the / response property for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property / to the response with the status

  • e07a869352e8Revision changes
    • info

      the endpoint scheme security clientId AND secret AND plaidVersion was added to the API

    • info

      the endpoint scheme security oauth2 was added to the API

    • info

      added cra_base_report cra_lend_score cra_cashflow_insights cra_network_insights discriminator mapping keys to the / request property

    • info

      added to the / request property oneOf list