Rule Instance - List

GET

Retrieve Rule Instances

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

Response

This endpoint returns a list of objects
id
string
type
enum
Allowed values: TRANSACTIONUSERUSER_ONGOING_SCREENING
ruleId
string
checksFor
list of strings
runCount
doubleOptional
hitCount
integerOptional
createdAt
doubleOptional
updatedAt
doubleOptional
filters
map from strings to anyOptional
Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.
parameters
map from strings to anyOptional
ruleNameAlias
stringOptional
riskLevelParameters
objectOptional
action
enumOptional
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: ALLOWFLAGBLOCKSUSPEND
riskLevelActions
objectOptional
triggersOnHit
objectOptional
riskLevelsTriggersOnHit
objectOptional
status
enumOptional
Allowed values: ACTIVEINACTIVE
casePriority
enumOptional
Allowed values: P1P2P3P4
GET
1curl https://sandbox.api.flagright.com/management/rule-instances \
2 -H "x-api-key: <apiKey>"
200
Retrieved
1[
2 {
3 "id": "id",
4 "type": "TRANSACTION",
5 "ruleId": "ruleId",
6 "checksFor": [
7 "checksFor"
8 ],
9 "runCount": 1.1,
10 "hitCount": 1,
11 "createdAt": 1.1,
12 "updatedAt": 1.1,
13 "filters": {
14 "filters": {
15 "key": "value"
16 }
17 },
18 "parameters": {
19 "parameters": {
20 "key": "value"
21 }
22 },
23 "ruleNameAlias": "ruleNameAlias",
24 "riskLevelParameters": {
25 "VERY_HIGH": {},
26 "HIGH": {},
27 "MEDIUM": {},
28 "LOW": {},
29 "VERY_LOW": {}
30 },
31 "action": "ALLOW",
32 "riskLevelActions": {
33 "VERY_HIGH": "ALLOW",
34 "HIGH": "ALLOW",
35 "MEDIUM": "ALLOW",
36 "LOW": "ALLOW",
37 "VERY_LOW": "ALLOW"
38 },
39 "triggersOnHit": {
40 "usersToCheck": "ALL",
41 "userStateDetails": {
42 "reason": "reason",
43 "state": "UNACCEPTABLE"
44 },
45 "kycStatusDetails": {
46 "reason": "reason"
47 }
48 },
49 "riskLevelsTriggersOnHit": {
50 "VERY_HIGH": {
51 "usersToCheck": "ALL"
52 },
53 "HIGH": {
54 "usersToCheck": "ALL"
55 },
56 "MEDIUM": {
57 "usersToCheck": "ALL"
58 },
59 "LOW": {
60 "usersToCheck": "ALL"
61 },
62 "VERY_LOW": {
63 "usersToCheck": "ALL"
64 }
65 },
66 "status": "ACTIVE",
67 "casePriority": "P1"
68 }
69]