Rule Instance - List

GET

/rule-instances

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.

idstring

typeenum

Allowed values: TRANSACTIONUSERUSER_ONGOING_SCREENING

ruleIdstring

checksForlist of strings

runCountdoubleOptional

hitCountintegerOptional

createdAtdoubleOptional

updatedAtdoubleOptional

alertCreationOnHitbooleanOptional

filtersmap from strings to anyOptional

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

parametersmap from strings to anyOptional

ruleNameAliasstringOptional

riskLevelParametersobjectOptional

actionenumOptional

Allowed values: ALLOWFLAGBLOCKSUSPEND

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

riskLevelActionsobjectOptional

triggersOnHitobjectOptional

riskLevelsTriggersOnHitobjectOptional

status"ACTIVE" or "INACTIVE"Optional

Allowed values: ACTIVEINACTIVE

casePriorityenumOptional

Allowed values: P1P2P3P4

GET

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

200Retrieved

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     "alertCreationOnHit": true,
14     "filters": {
15       "filters": {
16         "key": "value"
17       }
18     },
19     "parameters": {
20       "parameters": {
21         "key": "value"
22       }
23     },
24     "ruleNameAlias": "ruleNameAlias",
25     "riskLevelParameters": {
26       "VERY_HIGH": {},
27       "HIGH": {},
28       "MEDIUM": {},
29       "LOW": {},
30       "VERY_LOW": {}
31     },
32     "action": "ALLOW",
33     "riskLevelActions": {
34       "VERY_HIGH": "ALLOW",
35       "HIGH": "ALLOW",
36       "MEDIUM": "ALLOW",
37       "LOW": "ALLOW",
38       "VERY_LOW": "ALLOW"
39     },
40     "triggersOnHit": {
41       "usersToCheck": "ALL",
42       "userStateDetails": {
43         "reason": "reason",
44         "state": "UNACCEPTABLE"
45       },
46       "kycStatusDetails": {
47         "reason": "reason"
48       },
49       "pepStatus": {
50         "isPepHit": true
51       }
52     },
53     "riskLevelsTriggersOnHit": {
54       "VERY_HIGH": {},
55       "HIGH": {},
56       "MEDIUM": {},
57       "LOW": {},
58       "VERY_LOW": {}
59     },
60     "status": "ACTIVE",
61     "casePriority": "P1"
62   }
63 ]

Built with

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

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	"alertCreationOnHit": true,
14	"filters": {
15	"filters": {
16	"key": "value"
17	}
18	},
19	"parameters": {
20	"parameters": {
21	"key": "value"
22	}
23	},
24	"ruleNameAlias": "ruleNameAlias",
25	"riskLevelParameters": {
26	"VERY_HIGH": {},
27	"HIGH": {},
28	"MEDIUM": {},
29	"LOW": {},
30	"VERY_LOW": {}
31	},
32	"action": "ALLOW",
33	"riskLevelActions": {
34	"VERY_HIGH": "ALLOW",
35	"HIGH": "ALLOW",
36	"MEDIUM": "ALLOW",
37	"LOW": "ALLOW",
38	"VERY_LOW": "ALLOW"
39	},
40	"triggersOnHit": {
41	"usersToCheck": "ALL",
42	"userStateDetails": {
43	"reason": "reason",
44	"state": "UNACCEPTABLE"
45	},
46	"kycStatusDetails": {
47	"reason": "reason"
48	},
49	"pepStatus": {
50	"isPepHit": true
51	}
52	},
53	"riskLevelsTriggersOnHit": {
54	"VERY_HIGH": {},
55	"HIGH": {},
56	"MEDIUM": {},
57	"LOW": {},
58	"VERY_LOW": {}
59	},
60	"status": "ACTIVE",
61	"casePriority": "P1"
62	}
63	]