(Deprecated) Evaluate risk of a bank account
Use /beacon/account_risk/v1/evaluate to get risk insights for a linked account.
Request body
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.
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.
The access token associated with the Item for which data is being requested.
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.
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.
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
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
OK
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.