Skip to content
Developers
Back to Steward

Update a screening group verdict

PATCH
/api/v1/screening/groups/{groupId}

Set a verdict (and one rationale) on a whole screening group: applies to every source hit grouped under it

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
groupId
required
string

Screening group ID

Request Bodyrequired

Section titled “ Request Bodyrequired ”
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 group, applied to every member hit’s matchResult.severity, not just the primary source. Defaults for grouped types are PEP ‘Class 1’-‘Class 4’ and Adverse Media/Sanctions ‘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
Examples
{
  "status": "",
  "note": ""
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”
Media type application/json
object
id
required
string
type
required
string
Allowed values: ADVERSE_MEDIA SANCTIONS WARNING PEP
headline
required
string
summary
required
string
aiDescription
required

One reviewer-facing AI description standing in for the per-source rationales.

string
primaryHitId
required

The primary (most credible, latest-development) source’s hit id.

string
memberHitIds
required

Member hit ids, ordered newest-development-first (primary leads).

Array<string>
category

Group-level category (latest state).

object
label
required
string
description

Concise (≤12 word) description of the risk type shown on the (i) hover

string
nullable
severity

Group-level severity tier label (latest state).

string
nullable
reviewerNote
string
nullable
tierRationale
string
nullable
Examples
{
  "id": "507f1f77bcf86cd799439021",
  "type": "ADVERSE_MEDIA",
  "headline": "Mexico antitrust case against seven banks closed with minor fines",
  "summary": "One event tracked from a Dec 2019 collusion probe to its Jan 2021 resolution with minor fines.",
  "aiDescription": "An antitrust case in Mexico against seven banks over alleged collusion, opened in December 2019 and closed in January 2021 with minor fines; the event is reported across several sources.",
  "primaryHitId": "507f1f77bcf86cd799439012",
  "memberHitIds": [
    "507f1f77bcf86cd799439012",
    "507f1f77bcf86cd799439015"
  ],
  "category": {
    "label": "Competition/antitrust breaches",
    "description": null
  },
  "severity": "Medium",
  "reviewerNote": "Same antitrust matter across all sources, resolved to minor fines. False positive.",
  "tierRationale": "The case concerns bank collusion that ended in fines, which fits Competition/antitrust breaches in the Medium tier."
}