Rule - Get

GET

/rules/:ruleId

Retrieve a Rule

GET /rules/{ruleId} endpoint returns a rule template supported by flagright.

Path parameters

ruleIdstringRequired

Response

This endpoint returns an object.

idstring

typeenum

Allowed values: TRANSACTIONUSERUSER_ONGOING_SCREENING

namestring

typeslist of strings

descriptionstring

defaultParametersmap from strings to any

defaultActionenum

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

labelslist of enums

defaultCasePriorityenum

Allowed values: P1P2P3P4

defaultNatureenum

Allowed values: AMLFRAUDCTFSCREENING

checksForlist of strings

typologieslist of strings

sampleUseCasesstring

parametersSchemamap from strings to anyOptional

defaultRiskLevelParametersobjectOptional

defaultRiskLevelActionsobjectOptional

Errors

GET

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

200Retrieved

1 {
2   "id": "id",
3   "type": "TRANSACTION",
4   "name": "name",
5   "types": [
6     "types"
7   ],
8   "description": "description",
9   "defaultParameters": {
10     "defaultParameters": {
11       "key": "value"
12     }
13   },
14   "defaultAction": "ALLOW",
15   "labels": [
16     "UNEXPECTED_BEHAVIOR"
17   ],
18   "defaultCasePriority": "P1",
19   "defaultNature": "AML",
20   "checksFor": [
21     "checksFor"
22   ],
23   "typologies": [
24     "typologies"
25   ],
26   "sampleUseCases": "sampleUseCases",
27   "parametersSchema": {
28     "parametersSchema": {
29       "key": "value"
30     }
31   },
32   "defaultRiskLevelParameters": {
33     "VERY_HIGH": {
34       "VERY_HIGH": {
35         "key": "value"
36       }
37     },
38     "HIGH": {
39       "HIGH": {
40         "key": "value"
41       }
42     },
43     "MEDIUM": {
44       "MEDIUM": {
45         "key": "value"
46       }
47     },
48     "LOW": {
49       "LOW": {
50         "key": "value"
51       }
52     },
53     "VERY_LOW": {
54       "VERY_LOW": {
55         "key": "value"
56       }
57     }
58   },
59   "defaultRiskLevelActions": {
60     "VERY_HIGH": "ALLOW",
61     "HIGH": "ALLOW",
62     "MEDIUM": "ALLOW",
63     "LOW": "ALLOW",
64     "VERY_LOW": "ALLOW"
65   }
66 }

Built with

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

1	{
2	"id": "id",
3	"type": "TRANSACTION",
4	"name": "name",
5	"types": [
6	"types"
7	],
8	"description": "description",
9	"defaultParameters": {
10	"defaultParameters": {
11	"key": "value"
12	}
13	},
14	"defaultAction": "ALLOW",
15	"labels": [
16	"UNEXPECTED_BEHAVIOR"
17	],
18	"defaultCasePriority": "P1",
19	"defaultNature": "AML",
20	"checksFor": [
21	"checksFor"
22	],
23	"typologies": [
24	"typologies"
25	],
26	"sampleUseCases": "sampleUseCases",
27	"parametersSchema": {
28	"parametersSchema": {
29	"key": "value"
30	}
31	},
32	"defaultRiskLevelParameters": {
33	"VERY_HIGH": {
34	"VERY_HIGH": {
35	"key": "value"
36	}
37	},
38	"HIGH": {
39	"HIGH": {
40	"key": "value"
41	}
42	},
43	"MEDIUM": {
44	"MEDIUM": {
45	"key": "value"
46	}
47	},
48	"LOW": {
49	"LOW": {
50	"key": "value"
51	}
52	},
53	"VERY_LOW": {
54	"VERY_LOW": {
55	"key": "value"
56	}
57	}
58	},
59	"defaultRiskLevelActions": {
60	"VERY_HIGH": "ALLOW",
61	"HIGH": "ALLOW",
62	"MEDIUM": "ALLOW",
63	"LOW": "ALLOW",
64	"VERY_LOW": "ALLOW"
65	}
66	}