ELelliptic
Risk Rules

Get team's risk rules

Get the risk rules for your team

get/risk_rules

Request

  • Base URL
    https://aml-api.elliptic.co/v3
  • URL
    https://aml-api.elliptic.co/v3/risk_rules
  • Auth
    • HTTP bearer
    • or API key in header x-access-key and API key in header x-access-sign and API key in header x-access-timestamp

Query parameters

include_id_mapboolean

Whether or not to include an id_map in response

Response

Rule objects

OR

Example response

{
  "risk_rules": [
    {
      "id": "b7535048-76f8-4f60-bdd3-9d659298f9e7",
      "history_id": "b7535048-76f8-4f60-bdd3-9d659298f9e7",
      "name": "illicit activities",
      "version": 3,
      "is_current": true,
      "created_at": "2015-05-13T10:36:21.000Z",
      "application_criteria": {
        "direction": {
          "forwards": null
        }
      },
      "trigger_criteria": {
        "$or": [
          {
            "label_id": {
              "$in": [
                "a3535022-76f8-4f60-bdd3-9d659298f3b5"
              ]
            }
          }
        ]
      },
      "scoring": {
        "method": "linear",
        "options": {
          "property": "percentage",
          "min_threshold": 0,
          "max_threshold": 100,
          "min_score": 10,
          "max_score": 10
        }
      },
      "draft_rule_id": "b7535048-76f8-4f60-bdd3-9d659298f9e7"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.