Retrieve a Rule

🚧
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]!

Retrieves the full definition and metadata for a single Rule resource by its unique ID. This includes the rule’s name, enabled status, logical operator, array of conditions, action (allow, block, review), execution priority, and live/test mode status. Use this endpoint to inspect or troubleshoot individual rules, display rule details in administrative interfaces, or fetch rule logic for use in automated processes.

Example Response:

{
  "data": {
    "id": "frl_abcdefg123456",
    "type": "fraud.rule",
    "livemode": true,
    "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
  }
}

See attribute details on List all rules.