Rule - Get

GET

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>"

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