plaid

(Deprecated) Evaluate risk of a bank account

Use /beacon/account_risk/v1/evaluate to get risk insights for a linked account.

post/beacon/account_risk/v1/evaluate

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.

access_tokenstring

The access token associated with the Item for which data is being requested.

client_user_idstring

A unique ID that identifies the end user in your system. This ID is used to correlate requests by a user with multiple evaluations and/or multiple linked accounts. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

client_evaluation_idstring

Unique identifier of what you are looking to evaluate (account add, information change, etc.) to allow us to tie the activity to the decisions and possible fraud outcome sent via our feedback endpoints. You can use your internal request ID or similar.

evaluation_reason'ONBOARDING' | 'NEW_ACCOUNT' | 'INFORMATION_CHANGE' | 'DORMANT_USER' | 'OTHER'

Description of the reason you want to evaluate risk.

ONBOARDING: user links a first bank account as part of the onboarding flow of your platform.

NEW_ACCOUNT: user links another bank account or replaces the currently linked bank account on your platform.

INFORMATION_CHANGE: user changes their information on your platform, e.g., updating their phone number.

DORMANT_USER: you decide to re-evaluate a user that becomes active after a period of inactivity.

OTHER: any other reasons not listed here

Possible values: ONBOARDING, NEW_ACCOUNT, INFORMATION_CHANGE, DORMANT_USER, OTHER

evaluate_timestring

The time the event for evaluation has occurred. Populate this field for backfilling data. If you don't populate this field, we'll use the timestamp at the time of receipt. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).

Response

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 17 of the 53 revisions of this API.13912

Aug 17, 2026e536704a333f5See the full diff
- ●
  added the new charge card enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new commercial line of credit enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new home equity loan enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new installment enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new prediction market enum value to the // response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 202694406d9a4d271See the full diff
- ○
  endpoint deprecated
  endpoint-deprecated
Jul 22, 2026a1bbca01816013See the full diff
- ●
  added the new ASSETS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new CRA_MONITORING_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new ENCOMPASS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new ENRICH_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new FREDDIE_MAC_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new LINK_DELIVERY_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PROFILE_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new STATEMENTS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 25, 202680d23bfdc2e51See the full diff
- ●
  added the new IDEMPOTENCY_ERROR enum value to the response property for the response status
  response-property-enum-value-added
Jun 10, 2026fb8c3f188d8b1See the full diff
- ●
  added the new BASE_REPORT_ERROR enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 17, 2026b9a2871636de1See the full diff
- ●
  added the new limited purpose checking enum value to the // response property for the response status
  response-property-enum-value-added
Apr 2, 20267f9a02ad0ce37See the full diff
- ●
  added the new fhsa enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new qshr enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new roth 403B enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new roth 457b enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new roth pension enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new roth profit sharing plan enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new roth thrift savings plan enum value to the // response property for the response status
  response-property-enum-value-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 11, 2025465584b48c992See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 19, 20254abee1c569291See the full diff
- ○
  removed the IDENTITY_ERROR enum value from the response property for the response status
  response-property-enum-value-removed
Nov 12, 2025f8b9f1a857672See the full diff
- ●
  added the new IDENTITY_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new USER_ERROR enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (17 revisions)