Create rule
POST/Rules
Create rule
Request​
- application/json
Body
Rule to create.
- Array [
- Array [
- ]
- Array [
- ]
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
groupRuleObjects object[]nullable
The list of group-specific rule object overrides.
The universally unique identifier of this record.
The unique code identifying the AML rule.
The unique code identifying the AML object.
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
The comparison operator used in the rule condition (e.g., >, <, =).
The lower bound or starting value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
The upper bound or ending value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
The display name of the AML object.
The type classification of the AML object.
A textual description of the AML object's purpose.
The SQL expression used to evaluate this object.
The error message recorded if object evaluation fails.
The username or identifier of the user who last updated this record.
The username or identifier of the user who created this record.
The version number of the object definition.
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
The list of group-specific rule object overrides.
groupRules object[]nullable
The list of group-specific rule associations.
The universally unique identifier of this record.
The unique code identifying the customer group.
The unique code identifying the AML rule.
The priority order of this rule within the group.
The score assigned to this rule within the group context.
The username or identifier of the user who created this record.
The date and time when this record was created.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
The version number of the rule definition.
group object
The referenced customer group definition.
The unique code identifying the customer group.
A textual description of the group's purpose.
The SQL query used to dynamically determine group membership.
The display name of the group.
Indicates whether the group is currently active.
The risk level code assigned to this group.
Indicates whether live checking is enabled for this group.
Indicates whether this group is exempt from standard AML rules.
Configuration for sanction list screening behavior for this group.
The error message recorded if group evaluation fails.
The version number of the group definition.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
rule object
The referenced AML rule definition.
ruleObjects object[]nullable
The list of rule objects (conditions) that compose this rule.
The universally unique identifier of this record.
The unique code identifying the AML rule.
The unique code identifying the AML object.
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
The comparison operator used in the rule condition (e.g., >, <, =).
The lower bound or starting value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
The upper bound or ending value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
The display name of the AML object.
The type classification of the AML object.
A textual description of the AML object's purpose.
The SQL expression used to evaluate this object.
The error message recorded if object evaluation fails.
The username or identifier of the user who last updated this record.
The username or identifier of the user who created this record.
The version number of the object definition.
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
The version number of the rule definition.
The version number of the rule definition.
The date from which this rule is effective.
The date until which this rule is effective.
The risk level code associated with this rule.
The score value assigned when this rule is triggered.
A textual description of the rule's logic and purpose.
The display name of the rule.
Indicates whether the rule is currently active.
The unique code identifying the AML rule.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The version number of the rule definition.
The unique identifier of the parent rule object.
The unique identifier of the parent group rule.
The unique code identifying the customer group.
group object
The referenced customer group definition.
The unique code identifying the customer group.
A textual description of the group's purpose.
The SQL query used to dynamically determine group membership.
The display name of the group.
Indicates whether the group is currently active.
The risk level code assigned to this group.
Indicates whether live checking is enabled for this group.
Indicates whether this group is exempt from standard AML rules.
Configuration for sanction list screening behavior for this group.
The error message recorded if group evaluation fails.
The version number of the group definition.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
groupRules object[]nullable
The list of group-specific rule associations.
The universally unique identifier of this record.
The unique code identifying the customer group.
The unique code identifying the AML rule.
The priority order of this rule within the group.
The score assigned to this rule within the group context.
The username or identifier of the user who created this record.
The date and time when this record was created.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
The version number of the rule definition.
group object
The referenced customer group definition.
The unique code identifying the customer group.
A textual description of the group's purpose.
The SQL query used to dynamically determine group membership.
The display name of the group.
Indicates whether the group is currently active.
The risk level code assigned to this group.
Indicates whether live checking is enabled for this group.
Indicates whether this group is exempt from standard AML rules.
Configuration for sanction list screening behavior for this group.
The error message recorded if group evaluation fails.
The version number of the group definition.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
rule object
The referenced AML rule definition.
groupRuleObjects object[]nullable
The list of group-specific rule object overrides.
The universally unique identifier of this record.
The unique code identifying the AML rule.
The unique code identifying the AML object.
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
The comparison operator used in the rule condition (e.g., >, <, =).
The lower bound or starting value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
The upper bound or ending value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
The display name of the AML object.
The type classification of the AML object.
A textual description of the AML object's purpose.
The SQL expression used to evaluate this object.
The error message recorded if object evaluation fails.
The username or identifier of the user who last updated this record.
The username or identifier of the user who created this record.
The version number of the object definition.
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
The version number of the rule definition.
The unique identifier of the parent rule object.
The unique identifier of the parent group rule.
The unique code identifying the customer group.
group object
The referenced customer group definition.
The unique code identifying the customer group.
A textual description of the group's purpose.
The SQL query used to dynamically determine group membership.
The display name of the group.
Indicates whether the group is currently active.
The risk level code assigned to this group.
Indicates whether live checking is enabled for this group.
Indicates whether this group is exempt from standard AML rules.
Configuration for sanction list screening behavior for this group.
The error message recorded if group evaluation fails.
The version number of the group definition.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
The list of group-specific rule associations.
ruleObjects object[]nullable
The list of rule objects (conditions) that compose this rule.
The universally unique identifier of this record.
The unique code identifying the AML rule.
The unique code identifying the AML object.
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
The comparison operator used in the rule condition (e.g., >, <, =).
The lower bound or starting value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
The upper bound or ending value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
The display name of the AML object.
The type classification of the AML object.
A textual description of the AML object's purpose.
The SQL expression used to evaluate this object.
The error message recorded if object evaluation fails.
The username or identifier of the user who last updated this record.
The username or identifier of the user who created this record.
The version number of the object definition.
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
The version number of the rule definition.
The version number of the rule definition.
The date from which this rule is effective.
The date until which this rule is effective.
The risk level code associated with this rule.
The score value assigned when this rule is triggered.
A textual description of the rule's logic and purpose.
The display name of the rule.
Indicates whether the rule is currently active.
The unique code identifying the AML rule.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
ruleObjects object[]nullable
The list of rule objects (conditions) that compose this rule.
The universally unique identifier of this record.
The unique code identifying the AML rule.
The unique code identifying the AML object.
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
The comparison operator used in the rule condition (e.g., >, <, =).
The lower bound or starting value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
The upper bound or ending value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
The display name of the AML object.
The type classification of the AML object.
A textual description of the AML object's purpose.
The SQL expression used to evaluate this object.
The error message recorded if object evaluation fails.
The username or identifier of the user who last updated this record.
The username or identifier of the user who created this record.
The version number of the object definition.
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
groupRuleObjects object[]nullable
The list of group-specific rule object overrides.
The universally unique identifier of this record.
The unique code identifying the AML rule.
The unique code identifying the AML object.
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
The comparison operator used in the rule condition (e.g., >, <, =).
The lower bound or starting value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
The upper bound or ending value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
The display name of the AML object.
The type classification of the AML object.
A textual description of the AML object's purpose.
The SQL expression used to evaluate this object.
The error message recorded if object evaluation fails.
The username or identifier of the user who last updated this record.
The username or identifier of the user who created this record.
The version number of the object definition.
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
The version number of the rule definition.
The unique identifier of the parent rule object.
The unique identifier of the parent group rule.
The unique code identifying the customer group.
group object
The referenced customer group definition.
The unique code identifying the customer group.
A textual description of the group's purpose.
The SQL query used to dynamically determine group membership.
The display name of the group.
Indicates whether the group is currently active.
The risk level code assigned to this group.
Indicates whether live checking is enabled for this group.
Indicates whether this group is exempt from standard AML rules.
Configuration for sanction list screening behavior for this group.
The error message recorded if group evaluation fails.
The version number of the group definition.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
groupRules object[]nullable
The list of group-specific rule associations.
The universally unique identifier of this record.
The unique code identifying the customer group.
The unique code identifying the AML rule.
The priority order of this rule within the group.
The score assigned to this rule within the group context.
The username or identifier of the user who created this record.
The date and time when this record was created.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
The version number of the rule definition.
group object
The referenced customer group definition.
The unique code identifying the customer group.
A textual description of the group's purpose.
The SQL query used to dynamically determine group membership.
The display name of the group.
Indicates whether the group is currently active.
The risk level code assigned to this group.
Indicates whether live checking is enabled for this group.
Indicates whether this group is exempt from standard AML rules.
Configuration for sanction list screening behavior for this group.
The error message recorded if group evaluation fails.
The version number of the group definition.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
rule object
The referenced AML rule definition.
The list of rule objects (conditions) that compose this rule.
The version number of the rule definition.
The date from which this rule is effective.
The date until which this rule is effective.
The risk level code associated with this rule.
The score value assigned when this rule is triggered.
A textual description of the rule's logic and purpose.
The display name of the rule.
Indicates whether the rule is currently active.
The unique code identifying the AML rule.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The version number of the rule definition.
The version number of the rule definition.
The date from which this rule is effective.
The date until which this rule is effective.
The risk level code associated with this rule.
The score value assigned when this rule is triggered.
A textual description of the rule's logic and purpose.
The display name of the rule.
Indicates whether the rule is currently active.
The unique code identifying the AML rule.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
Responses​
- 201
- 400
- 406
- 409
Rule was created.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
groupRuleObjects object[]nullable
The list of group-specific rule object overrides.
The universally unique identifier of this record.
The unique code identifying the AML rule.
The unique code identifying the AML object.
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
The comparison operator used in the rule condition (e.g., >, <, =).
The lower bound or starting value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
The upper bound or ending value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
The display name of the AML object.
The type classification of the AML object.
A textual description of the AML object's purpose.
The SQL expression used to evaluate this object.
The error message recorded if object evaluation fails.
The username or identifier of the user who last updated this record.
The username or identifier of the user who created this record.
The version number of the object definition.
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
The version number of the rule definition.
The unique identifier of the parent rule object.
The unique identifier of the parent group rule.
The unique code identifying the customer group.
group object
The referenced customer group definition.
The unique code identifying the customer group.
A textual description of the group's purpose.
The SQL query used to dynamically determine group membership.
The display name of the group.
Indicates whether the group is currently active.
The risk level code assigned to this group.
Indicates whether live checking is enabled for this group.
Indicates whether this group is exempt from standard AML rules.
Configuration for sanction list screening behavior for this group.
The error message recorded if group evaluation fails.
The version number of the group definition.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
groupRules object[]nullable
The list of group-specific rule associations.
The universally unique identifier of this record.
The unique code identifying the customer group.
The unique code identifying the AML rule.
The priority order of this rule within the group.
The score assigned to this rule within the group context.
The username or identifier of the user who created this record.
The date and time when this record was created.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
The version number of the rule definition.
group object
The referenced customer group definition.
The unique code identifying the customer group.
A textual description of the group's purpose.
The SQL query used to dynamically determine group membership.
The display name of the group.
Indicates whether the group is currently active.
The risk level code assigned to this group.
Indicates whether live checking is enabled for this group.
Indicates whether this group is exempt from standard AML rules.
Configuration for sanction list screening behavior for this group.
The error message recorded if group evaluation fails.
The version number of the group definition.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
The date and time when this record was last updated.
rule object
The referenced AML rule definition.
ruleObjects object[]nullable
The list of rule objects (conditions) that compose this rule.
The universally unique identifier of this record.
The unique code identifying the AML rule.
The unique code identifying the AML object.
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
The comparison operator used in the rule condition (e.g., >, <, =).
The lower bound or starting value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
The upper bound or ending value for the rule condition.
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
The display name of the AML object.
The type classification of the AML object.
A textual description of the AML object's purpose.
The SQL expression used to evaluate this object.
The error message recorded if object evaluation fails.
The username or identifier of the user who last updated this record.
The username or identifier of the user who created this record.
The version number of the object definition.
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
The version number of the rule definition.
The version number of the rule definition.
The date from which this rule is effective.
The date until which this rule is effective.
The risk level code associated with this rule.
The score value assigned when this rule is triggered.
A textual description of the rule's logic and purpose.
The display name of the rule.
Indicates whether the rule is currently active.
The unique code identifying the AML rule.
The username or identifier of the user who created this record.
The username or identifier of the user who last updated this record.
{
"groupRuleObjects": [
{
"uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ruleCode": "string",
"objectCode": "string",
"objectType": 0,
"operator": "string",
"valueFrom": "string",
"valueFromType": 0,
"valueTo": "string",
"valueToType": 0,
"createdBy": "string",
"updatedBy": "string",
"object": {
"objectName": "string",
"objectType": "string",
"objectDescription": "string",
"sqlObject": "string",
"objectErrorMessage": "string",
"updatedBy": "string",
"createdBy": "string",
"objectVersion": 0,
"objectCode": "string"
},
"rule": {},
"ruleVersion": 0,
"ruleObjectUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"groupRuleUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"groupCode": "string",
"group": {
"groupCode": "string",
"groupDescription": "string",
"groupSqlQuery": "string",
"groupName": "string",
"groupStatus": true,
"groupRiskLevelCode": 0,
"groupLiveCheckFlg": true,
"groupAmlExceptionFlg": true,
"searchInSanctionlist": "string",
"groupErrorMessage": "string",
"groupVersion": 0,
"createdBy": "string",
"updatedBy": "string",
"updateAt": "2024-07-29T15:51:28.071Z"
}
}
],
"groupRules": [
{
"uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"groupCode": "string",
"ruleCode": "string",
"groupRulePriority": 0,
"groupRuleScore": 0,
"createdBy": "string",
"createDate": "2024-07-29T15:51:28.071Z",
"updatedBy": "string",
"updateDate": "2024-07-29T15:51:28.071Z",
"ruleVersion": 0,
"group": {
"groupCode": "string",
"groupDescription": "string",
"groupSqlQuery": "string",
"groupName": "string",
"groupStatus": true,
"groupRiskLevelCode": 0,
"groupLiveCheckFlg": true,
"groupAmlExceptionFlg": true,
"searchInSanctionlist": "string",
"groupErrorMessage": "string",
"groupVersion": 0,
"createdBy": "string",
"updatedBy": "string",
"updateAt": "2024-07-29T15:51:28.071Z"
},
"rule": {}
}
],
"ruleObjects": [
{
"uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ruleCode": "string",
"objectCode": "string",
"objectType": 0,
"operator": "string",
"valueFrom": "string",
"valueFromType": 0,
"valueTo": "string",
"valueToType": 0,
"createdBy": "string",
"updatedBy": "string",
"object": {
"objectName": "string",
"objectType": "string",
"objectDescription": "string",
"sqlObject": "string",
"objectErrorMessage": "string",
"updatedBy": "string",
"createdBy": "string",
"objectVersion": 0,
"objectCode": "string"
},
"rule": {},
"ruleVersion": 0
}
],
"ruleVersion": 0,
"ruleValidFrom": "2024-07-29T15:51:28.071Z",
"ruleValidTo": "2024-07-29T15:51:28.071Z",
"ruleRiskLevelCode": "string",
"ruleScore": 0,
"ruleDesc": "string",
"ruleName": "string",
"ruleStatus": true,
"ruleCode": "string",
"createdBy": "string",
"updatedBy": "string"
}
Rule is invalid.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
reasons object[]nullable
The list of underlying error reasons.
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
The list of underlying error reasons.
The unique code identifying this entity.
errors object[]nullable
The list of validation errors.
The name of the field that failed validation.
The error or validation message.
{
"message": "string",
"metadata": {},
"reasons": [
{
"message": "string",
"metadata": {},
"reasons": [
null
]
}
],
"code": 0,
"errors": [
{
"field": "string",
"message": "string"
}
]
}
Incorrect JSON format.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
reasons object[]nullable
The list of underlying error reasons.
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
The list of underlying error reasons.
The unique code identifying this entity.
errors object[]nullable
The list of validation errors.
The name of the field that failed validation.
The error or validation message.
{
"message": "string",
"metadata": {},
"reasons": [
{
"message": "string",
"metadata": {},
"reasons": [
null
]
}
],
"code": 0,
"errors": [
{
"field": "string",
"message": "string"
}
]
}
Rule already exists.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
reasons object[]nullable
The list of underlying error reasons.
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
The list of underlying error reasons.
The unique code identifying this entity.
errors object[]nullable
The list of validation errors.
The name of the field that failed validation.
The error or validation message.
{
"message": "string",
"metadata": {},
"reasons": [
{
"message": "string",
"metadata": {},
"reasons": [
null
]
}
],
"code": 0,
"errors": [
{
"field": "string",
"message": "string"
}
]
}