signalEvaluate
POST {{baseUrl}}/signal/evaluate
Use /signal/evaluate to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals.
In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If /signal/evaluate is called on the same transaction multiple times within a 24-hour period, cached results may be returned.
Request Body
{"access_token"=>"<string>", "account_id"=>"<string>", "client_transaction_id"=>"<string>", "amount"=>"<number>", "client_id"=>"5fd43aad1186c30013d6f3e2", "secret"=>"<string>", "user_present"=>"<boolean,null>", "client_user_id"=>"<string>", "user"=>{"name"=>{"prefix"=>"<string,null>", "given_name"=>"<string,null>", "middle_name"=>"<string,null>", "family_name"=>"<string,null>", "suffix"=>"<string,null>"}, "phone_number"=>"<string,null>", "email_address"=>"<string,null>", "address"=>{"city"=>"<string>", "region"=>"<string,null>", "street"=>"<string>", "postal_code"=>"<string,null>", "country"=>"<string,null>"}}, "device"=>{"ip_address"=>"<string,null>", "user_agent"=>"<string,null>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"request_id":"\u003cstring\u003e","scores":{"customer_initiated_return_risk":{"score":"\u003cinteger\u003e","risk_tier":"\u003cinteger\u003e"},"bank_initiated_return_risk":{"score":"\u003cinteger\u003e","risk_tier":"\u003cinteger\u003e"}},"core_attributes":{"unauthorized_transactions_count_7d":"\u003cinteger\u003e","unauthorized_transactions_count_30d":"\u003cinteger\u003e","unauthorized_transactions_count_60d":"\u003cinteger\u003e","unauthorized_transactions_count_90d":"\u003cinteger\u003e","nsf_overdraft_transactions_count_7d":"\u003cinteger\u003e","nsf_overdraft_transactions_count_30d":"\u003cinteger\u003e","nsf_overdraft_transactions_count_60d":"\u003cinteger\u003e","nsf_overdraft_transactions_count_90d":"\u003cinteger\u003e","days_since_first_plaid_connection":"\u003cinteger,null\u003e","plaid_connections_count_7d":"\u003cinteger,null\u003e","plaid_connections_count_30d":"\u003cinteger,null\u003e","total_plaid_connections_count":"\u003cinteger,null\u003e","is_savings_or_money_market_account":"\u003cboolean\u003e","total_credit_transactions_amount_10d":"\u003cnumber\u003e","total_debit_transactions_amount_10d":"\u003cnumber\u003e","p50_credit_transactions_amount_28d":"\u003cnumber,null\u003e","p50_debit_transactions_amount_28d":"\u003cnumber,null\u003e","p95_credit_transactions_amount_28d":"\u003cnumber,null\u003e","p95_debit_transactions_amount_28d":"\u003cnumber,null\u003e","days_with_negative_balance_count_90d":"\u003cinteger,null\u003e","p90_eod_balance_30d":"\u003cnumber,null\u003e","p90_eod_balance_60d":"\u003cnumber,null\u003e","p90_eod_balance_90d":"\u003cnumber,null\u003e","p10_eod_balance_30d":"\u003cnumber,null\u003e","p10_eod_balance_60d":"\u003cnumber,null\u003e","p10_eod_balance_90d":"\u003cnumber,null\u003e","available_balance":"\u003cnumber,null\u003e","current_balance":"\u003cnumber,null\u003e","balance_last_updated":"\u003cstring,null\u003e","phone_change_count_28d":"\u003cinteger,null\u003e","phone_change_count_90d":"\u003cinteger,null\u003e","email_change_count_28d":"\u003cinteger,null\u003e","email_change_count_90d":"\u003cinteger,null\u003e","address_change_count_28d":"\u003cinteger,null\u003e","address_change_count_90d":"\u003cinteger,null\u003e"}}