Rule Instance - List | Flagright

curl https://sandbox.api.flagright.com/management/rule-instances \
     -H "x-api-key: <apiKey>"

[
  {
    "id": "string",
    "type": "TRANSACTION",
    "ruleId": "string",
    "checksFor": [
      "string"
    ],
    "runCount": 1.1,
    "hitCount": 1,
    "createdAt": 1.1,
    "updatedAt": 1.1,
    "alertCreationOnHit": true,
    "filters": {},
    "parameters": {},
    "ruleNameAlias": "string",
    "riskLevelParameters": {
      "VERY_HIGH": {},
      "HIGH": {},
      "MEDIUM": {},
      "LOW": {},
      "VERY_LOW": {}
    },
    "action": "ALLOW",
    "riskLevelActions": {
      "VERY_HIGH": "ALLOW",
      "HIGH": "ALLOW",
      "MEDIUM": "ALLOW",
      "LOW": "ALLOW",
      "VERY_LOW": "ALLOW"
    },
    "triggersOnHit": {
      "usersToCheck": "ALL",
      "userStateDetails": {
        "reason": "string",
        "state": "UNACCEPTABLE",
        "description": "string"
      },
      "kycStatusDetails": {
        "reason": "string",
        "status": "SUCCESSFUL",
        "description": "string"
      },
      "pepStatus": {
        "isPepHit": true,
        "pepCountry": "AF",
        "pepRank": "LEVEL_1",
        "category": "string"
      },
      "sanctionsStatus": true,
      "adverseMediaStatus": true
    },
    "riskLevelsTriggersOnHit": {
      "VERY_HIGH": {
        "usersToCheck": "ALL",
        "userStateDetails": {
          "reason": "string",
          "state": "UNACCEPTABLE",
          "description": "string"
        },
        "kycStatusDetails": {
          "reason": "string",
          "status": "SUCCESSFUL",
          "description": "string"
        },
        "pepStatus": {
          "isPepHit": true,
          "pepCountry": "AF",
          "pepRank": "LEVEL_1",
          "category": "string"
        },
        "sanctionsStatus": true,
        "adverseMediaStatus": true
      },
      "HIGH": {
        "usersToCheck": "ALL",
        "userStateDetails": {
          "reason": "string",
          "state": "UNACCEPTABLE",
          "description": "string"
        },
        "kycStatusDetails": {
          "reason": "string",
          "status": "SUCCESSFUL",
          "description": "string"
        },
        "pepStatus": {
          "isPepHit": true,
          "pepCountry": "AF",
          "pepRank": "LEVEL_1",
          "category": "string"
        },
        "sanctionsStatus": true,
        "adverseMediaStatus": true
      },
      "MEDIUM": {
        "usersToCheck": "ALL",
        "userStateDetails": {
          "reason": "string",
          "state": "UNACCEPTABLE",
          "description": "string"
        },
        "kycStatusDetails": {
          "reason": "string",
          "status": "SUCCESSFUL",
          "description": "string"
        },
        "pepStatus": {
          "isPepHit": true,
          "pepCountry": "AF",
          "pepRank": "LEVEL_1",
          "category": "string"
        },
        "sanctionsStatus": true,
        "adverseMediaStatus": true
      },
      "LOW": {
        "usersToCheck": "ALL",
        "userStateDetails": {
          "reason": "string",
          "state": "UNACCEPTABLE",
          "description": "string"
        },
        "kycStatusDetails": {
          "reason": "string",
          "status": "SUCCESSFUL",
          "description": "string"
        },
        "pepStatus": {
          "isPepHit": true,
          "pepCountry": "AF",
          "pepRank": "LEVEL_1",
          "category": "string"
        },
        "sanctionsStatus": true,
        "adverseMediaStatus": true
      },
      "VERY_LOW": {
        "usersToCheck": "ALL",
        "userStateDetails": {
          "reason": "string",
          "state": "UNACCEPTABLE",
          "description": "string"
        },
        "kycStatusDetails": {
          "reason": "string",
          "status": "SUCCESSFUL",
          "description": "string"
        },
        "pepStatus": {
          "isPepHit": true,
          "pepCountry": "AF",
          "pepRank": "LEVEL_1",
          "category": "string"
        },
        "sanctionsStatus": true,
        "adverseMediaStatus": true
      }
    },
    "status": "ACTIVE",
    "casePriority": "P1"
  }
]

Retrieve Rule Instances

GET /rule-instances endpoint returns a list of all rule instances created by your account on flagright.

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Response

idstring

typeenum

ruleIdstring

checksForlist of strings

runCountdouble

hitCountinteger

createdAtdouble

updatedAtdouble

alertCreationOnHitboolean

filtersobject

Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.

parametersobject

ruleNameAliasstring

riskLevelParametersobject

actionenum

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Allowed values:

riskLevelActionsobject

triggersOnHitobject

riskLevelsTriggersOnHitobject

statusenum

Allowed values:

casePriorityenum

Allowed values: