Get group

GET 
/Groups/:groupCode

Get group

Request

Path Parameters

groupCode stringrequired

The group code.

Responses

200

The group with the specified group code.

application/json

Schema

Schema

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.

Example (from schema)

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

304

The group has not changed since the date given in the If-Modified-Since HTTP header.

404

An group with the specified group code could not be 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"
    }
  ]
}

Loading...