List all Rules

Use secret API key to retrieve a list of all fraud Rule resources.

Retrieves a paginated list of all custom fraud rules configured for your organization. Each rule defines a set of conditions (such as risk score thresholds, country codes, payment amounts, etc.) and the action to take (allow, block, or review) when those conditions are met.

The endpoint returns rule metadata, logical operators, priority order, and the full set of conditions for each rule. Use this to audit your fraud strategy, visualize rule coverage, or synchronize rule definitions in external systems.

Example Response:

{
  "has_more": false,
  "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
    }
  ]
}

attributedescription
idUnique ID of the Rule resource
typeResource type (fraud.rule)
enabledWhether the rule is active
nameName of the rule
operatorLogical operator for combining conditions (AND or OR)
rulesList of rule conditions (see below)
actionAction to take (allow, block, review)
rule_orderPriority order of the rule

Rule Condition Resource:

attributedescription
rule_attributeAttribute evaluated (e.g., risk score, country)
rule_valueValue(s) for the condition
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!