Rule Resource

Represent a Rule resource using the specified set of conditions, logical operator, action, and priority order.

🚧

Beta testing phase

If you are interested in early access to this feature please contact [email protected]!

A Rule Resource

{
  "data": {
    "id": "frl_abcdefg123456",
    "type": "fraud.rule",
    "enabled": true,
    "name": "My 1st Rule",
    "operator": "AND",
    "rules": [
      {
        "rule_attribute": "risk_score_gte",
        "rule_value": "700"
      },
      {
        "rule_attribute": "card_country_id",
        "rule_value": [
          "NG"
        ]
      }
    ],
    "action": "block",
    "rule_order": 1,
    "created_at": "2025-07-21T10:01:23.456Z",
    "updated_at": null
	}
}

attributetypedescription
idstringUnique ID of the Rule resource
typestringResource type (fraud.rule)
enabledbooleanWhether the rule is active
namestringName of the rule
operatorstringLogical operator for combining conditions (AND or OR)
rulesarrayList of rule conditions (see Rule Condition Object below)
actionstringAction to take (allow, block, review)
rule_orderintegerPriority order of the rule
created_atstringTimestamp when the rule was created (ISO8601)
updated_atstringTimestamp when the rule was last updated (ISO8601)

Rule Condition Object:

attributedescription
rule_attributeAttribute evaluated (e.g., risk score, country)
rule_valueValue(s) for the condition