Rule Resource

🚧
Beta testing phase
This is not the final version of the product, and is still subject to change.
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
	}
}

attribute	type	description
`id`	string	Unique ID of the Rule resource
`type`	string	Resource type (`fraud.rule`)
`enabled`	boolean	Whether the rule is active
`name`	string	Name of the rule
`operator`	string	Logical operator for combining conditions (`AND` or `OR`)
`rules`	array	List of rule conditions (see Rule Condition Object below)
`action`	string	Action to take (`allow`, `block`, `review`)
`rule_order`	integer	Priority order of the rule
`created_at`	string	Timestamp when the rule was created (ISO8601)
`updated_at`	string	Timestamp when the rule was last updated (ISO8601)

Rule Condition Object:

attribute	description
`rule_attribute`	Attribute evaluated (e.g., risk score, country)
`rule_value`	Value(s) for the condition