Represents one rule's contribution to a fraud score, built via its Builder. The value is how strongly the rule fired, from 0 (did not fire) to 1 (fired as hard as it can), and the weight is how many points of risk a full firing is worth; keeping the two apart is what lets an account retune a rule's importance without touching its logic. A signal can also be marked failed, meaning the rule threw or could not run: a failed signal contributes nothing and is reported separately, because a broken rule must never be able to block a transaction by itself, and must never be silently indistinguishable from a rule that ran and found nothing.


Properties

PropertyReturnsDescription
evidenceStringA short human-readable reason this rule fired, for the reviewer looking at the event later.
failedbooleanWhether the rule could not run.
failureMessageStringWhy the rule could not run.
ruleNameStringThe name of the rule that produced this signal.
valuedoubleHow strongly the rule fired.
weightdoubleHow many points of risk a full firing of this rule is worth.

Methods

getRuleName()

Returns: String

The name of the rule that produced this signal.

getValue()

Returns: double

How strongly the rule fired.

getWeight()

Returns: double

How many points of risk a full firing of this rule is worth.

getEvidence()

Returns: String

A short human-readable reason this rule fired, for the reviewer looking at the event later.

isFailed()

Returns: boolean

Whether the rule could not run.

getFailureMessage()

Returns: String

Why the rule could not run.

calcPoints()

Returns: double

Calculates the points this signal contributes to the overall score, as value multiplied by weight.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.