Apply one verdict to several screening groups

POST

/api/v1/screening/bulk/group-verdict

Applies one status, optional rationale, and optional severity to every member hit in each selected group after the complete selection is authorized.

Authorizations

• apiKey

Request Body^required

Media type application/json

object

status

required

string

Allowed values: IN_REVIEW CONFIRMED DISMISSED NOT_REVIEWED TRUE_MATCH FALSE_POSITIVE

note

string

severity

Reviewer-overridden severity tier label for this hit. Defaults per type are PEP ‘Class 1’-‘Class 4’ and Adverse Media/Sanctions/Warning ‘High’/‘Medium’/‘Low’, but tiers are workspace-configurable and renameable, so the valid set depends on the account’s taxonomy. Pass null to clear.

string

nullable

groupIds

required

Screening group IDs the verdict applies to

Array<string>

<= 500 items

Examples

{
  "status": "",
  "note": "",
  "groupIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012",
    "507f1f77bcf86cd799439013"
  ]
}

{
  "status": "FALSE_POSITIVE",
  "note": "Confirmed false positive after manual review",
  "severity": "string",
  "groupIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012",
    "507f1f77bcf86cd799439013"
  ]
}

Responses

200

Media type application/json

object

groupIds

required

Array<string>

skippedGroupIds

required

Array<string>

changedCount

required

number

skippedCount

required

number

Example

{
  "groupIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012"
  ],
  "skippedGroupIds": [
    "507f1f77bcf86cd799439013"
  ],
  "changedCount": 2,
  "skippedCount": 1
}