List all Rules

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Account configuration is required before testing transactions

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

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,
      "created_at": "2025-07-21T10:01:23.456Z",
      "updated_at": null
    },
    {
      "id": "frl_hijklmn123456",
      "type": "fraud.rule",
      "enabled": true,
      "name": "My 2nd Rule",
      "operator": "AND",
      "rules": [
        {
          "rule_attribute": "billing_country_id",
          "rule_value": "NG"
        }
      ],
      "action": "block",
      "rule_order": 2,
      "created_at": "2025-07-21T10:03:23.456Z",
      "updated_at": null
    }
  ]
}

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
Query Params
string

A cursor for use in pagination. after is a resource ID that defines your place in the list. For example, if you make a list request and receive 10 resources, ending with some_resource_id, your subsequent call can include after=some_resource_id in order to fetch the next page of the list.

integer
Defaults to 10

Limit of resources to return. If not passed, the default limit is 10.

string

Name of the rule attribute

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json