List rules

GET 
/Rules

List rules

Request

Query Parameters

page int32

Possible values: >= 1 and <= 2147483647

The 1-based page number for paginated results.

count int32

Possible values: >= 1 and <= 50

The number of items to return per page (1–50).

sortByProperty string

The property name to sort results by.

sortByAscending boolean

When true, sorts results in ascending order; descending otherwise.

searchValues object

Key-value pairs used to filter results.

findCodeToIncludeInPage string

A specific code to locate; the page containing it will be returned.

searchHistoricData boolean

When true, includes soft-deleted or historical records in the results.

Responses

200

A collection of rules for the specified page.

application/json

Schema

Schema

page int32required

The current page number in the paginated result set.

count int32required

The number of items returned on this page.

hasNextPage booleanrequired

Indicates whether additional pages of results are available after the current page.

hasPreviousPage booleanrequired

Indicates whether pages of results exist before the current page.

totalCount int32required

The total number of items across all pages.

totalPages int32required

The total number of pages available.

items object[]nullable
The collection of items returned for the current page.
Array [
groupRuleObjects object[]nullable
The list of group-specific rule object overrides.
Array [
uid uuidrequired
The universally unique identifier of this record.
ruleCode stringnullablerequired
The unique code identifying the AML rule.
objectCode stringnullablerequired
The unique code identifying the AML object.
objectType int32required
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
operator stringnullablerequired
The comparison operator used in the rule condition (e.g., >, <, =).
valueFrom stringnullablerequired
The lower bound or starting value for the rule condition.
valueFromType int32required
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
valueTo stringnullablerequired
The upper bound or ending value for the rule condition.
valueToType int32required
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
objectName stringnullablerequired
The display name of the AML object.
objectType stringnullablerequired
The type classification of the AML object.
objectDescription stringnullablerequired
A textual description of the AML object's purpose.
sqlObject stringnullablerequired
The SQL expression used to evaluate this object.
objectErrorMessage stringnullablerequired
The error message recorded if object evaluation fails.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
objectVersion int32nullablerequired
The version number of the object definition.
objectCode stringnullablerequired
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
0 required
1 required
2 required
3 required
4 required
5 required
6 required
7 required
8 required
9 required
ruleVersion int32required
The version number of the rule definition.
ruleObjectUID uuidrequired
The unique identifier of the parent rule object.
groupRuleUID uuidrequired
The unique identifier of the parent group rule.
groupCode stringnullablerequired
The unique code identifying the customer group.
group object
The referenced customer group definition.
groupCode stringnullablerequired
The unique code identifying the customer group.
groupDescription stringnullablerequired
A textual description of the group's purpose.
groupSqlQuery stringnullablerequired
The SQL query used to dynamically determine group membership.
groupName stringnullablerequired
The display name of the group.
groupStatus booleanrequired
Indicates whether the group is currently active.
groupRiskLevelCode int32required
The risk level code assigned to this group.
groupLiveCheckFlg booleannullablerequired
Indicates whether live checking is enabled for this group.
groupAmlExceptionFlg booleanrequired
Indicates whether this group is exempt from standard AML rules.
searchInSanctionlist stringnullablerequired
Configuration for sanction list screening behavior for this group.
groupErrorMessage stringnullablerequired
The error message recorded if group evaluation fails.
groupVersion int32required
The version number of the group definition.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
updateAt date-timerequired
The date and time when this record was last updated.
]
groupRules object[]nullable
The list of group-specific rule associations.
Array [
uid uuidrequired
The universally unique identifier of this record.
groupCode stringnullablerequired
The unique code identifying the customer group.
ruleCode stringnullablerequired
The unique code identifying the AML rule.
groupRulePriority int32required
The priority order of this rule within the group.
groupRuleScore int32required
The score assigned to this rule within the group context.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
createDate date-timerequired
The date and time when this record was created.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
updateDate date-timenullablerequired
The date and time when this record was last updated.
ruleVersion int32required
The version number of the rule definition.
group object
The referenced customer group definition.
groupCode stringnullablerequired
The unique code identifying the customer group.
groupDescription stringnullablerequired
A textual description of the group's purpose.
groupSqlQuery stringnullablerequired
The SQL query used to dynamically determine group membership.
groupName stringnullablerequired
The display name of the group.
groupStatus booleanrequired
Indicates whether the group is currently active.
groupRiskLevelCode int32required
The risk level code assigned to this group.
groupLiveCheckFlg booleannullablerequired
Indicates whether live checking is enabled for this group.
groupAmlExceptionFlg booleanrequired
Indicates whether this group is exempt from standard AML rules.
searchInSanctionlist stringnullablerequired
Configuration for sanction list screening behavior for this group.
groupErrorMessage stringnullablerequired
The error message recorded if group evaluation fails.
groupVersion int32required
The version number of the group definition.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
updateAt date-timerequired
The date and time when this record was last updated.
rule object
The referenced AML rule definition.
0 required
1 required
2 required
3 required
4 required
5 required
6 required
7 required
8 required
9 required
]
ruleObjects object[]nullable
The list of rule objects (conditions) that compose this rule.
Array [
uid uuidrequired
The universally unique identifier of this record.
ruleCode stringnullablerequired
The unique code identifying the AML rule.
objectCode stringnullablerequired
The unique code identifying the AML object.
objectType int32required
Possible values: [0, 1, 3, 4]
The type classification of the AML object.
operator stringnullablerequired
The comparison operator used in the rule condition (e.g., >, <, =).
valueFrom stringnullablerequired
The lower bound or starting value for the rule condition.
valueFromType int32required
Possible values: [0, 1, 3, 4]
The type classification of the lower bound value.
valueTo stringnullablerequired
The upper bound or ending value for the rule condition.
valueToType int32required
Possible values: [0, 1, 3, 4]
The type classification of the upper bound value.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
object object
The referenced AML object definition.
objectName stringnullablerequired
The display name of the AML object.
objectType stringnullablerequired
The type classification of the AML object.
objectDescription stringnullablerequired
A textual description of the AML object's purpose.
sqlObject stringnullablerequired
The SQL expression used to evaluate this object.
objectErrorMessage stringnullablerequired
The error message recorded if object evaluation fails.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
objectVersion int32nullablerequired
The version number of the object definition.
objectCode stringnullablerequired
The unique code identifying the AML object.
rule object
The referenced AML rule definition.
0 required
1 required
2 required
3 required
4 required
5 required
6 required
7 required
8 required
9 required
ruleVersion int32required
The version number of the rule definition.
]
ruleVersion int32required
The version number of the rule definition.
ruleValidFrom date-timerequired
The date from which this rule is effective.
ruleValidTo date-timerequired
The date until which this rule is effective.
ruleRiskLevelCode stringnullablerequired
The risk level code associated with this rule.
ruleScore int32required
The score value assigned when this rule is triggered.
ruleDesc stringnullablerequired
A textual description of the rule's logic and purpose.
ruleName stringnullablerequired
The display name of the rule.
ruleStatus booleannullablerequired
Indicates whether the rule is currently active.
ruleCode stringnullablerequired
The unique code identifying the AML rule.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
]

Example (from schema)

{
  "page": 0,
  "count": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "totalCount": 0,
  "totalPages": 0,
  "items": [
    {
      "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"
    }
  ]
}

400

The page request parameters are invalid.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

404

A page with the specified page number was not found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

406

Incorrect JSON format.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...