Skip to content
Developers
Back to Steward

Update screening hit status

PATCH
/api/v1/screening/hits/{hitId}

Update the status of a screening hit (e.g., mark as Match/Dismiss)

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
hitId
required
string

Screening hit 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 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
Examples
{
  "status": "",
  "note": ""
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”
Media type application/json
object
id
required
string
entityId

Entity ID (individualId or businessId)

string
type
required
string
Allowed values: ADVERSE_MEDIA SANCTIONS WARNING PEP
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
status
required
string
Allowed values: IN_REVIEW CONFIRMED DISMISSED NOT_REVIEWED TRUE_MATCH FALSE_POSITIVE
source
required
string
details
required

Raw screening hit details from the provider

object
updatedBy
string
enriched
required
boolean
matchResult
object
isMatch
required
boolean
confidence
required
number
reviewNote
required
string
matchExplanation
string
incidentSummary
required
string
riskLevel
required
string
severity
string
nullable
tierRationale
string
nullable
clearedReason

Why an automated pass cleared this hit, as a discrete value. Null while the hit is not cleared, on a reviewer’s own ruling, and on hits cleared before the reason was stored.

string
Allowed values: IDENTITY_MISMATCH NOTHING_ADVERSE_REPORTED SEARCH_RESULT_NOT_IDENTIFIED SOURCE_PAGE_UNREADABLE CONFIDENCE_BELOW_THRESHOLD NOMINAL_ROLE
categories
required
Array<object>
object
label
required
string
description

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

string
nullable
note
string
nullable
individualId
string
groupId

Id of the screening group this hit belongs to.

string
nullable
storyId

Deprecated alias for groupId on adverse-media hits.

string
nullable
notes
Array<object>
object
id
required
string
entityType
required
string
Allowed values: APPLICATION SCREENING_HIT DOCUMENT WORKFLOW_VERSION AUDIT_LOG
entityId
required
string
content
required
string
createdBy
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
deleted
required
boolean
createdByUser
required
object
id
required
string
externalId
required
string
firstName
required
string
lastName
required
string
email
required
string
title
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
updatedByUser
required
object
id
required
string
externalId
required
string
firstName
required
string
lastName
required
string
email
required
string
title
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
origin

Which screen raised this hit. Null for hits written before origin was recorded.

string
Allowed values: INITIAL_SCREENING ONGOING_MONITORING
Examples
{
  "id": "507f1f77bcf86cd799439011",
  "type": "SANCTIONS",
  "createdAt": "2026-03-30T12:00:00.000Z",
  "updatedAt": "2026-03-30T12:00:00.000Z",
  "status": "FALSE_POSITIVE",
  "source": "comply-advantage",
  "details": {},
  "updatedBy": "60d5ecb54b24003a7c8e92b2",
  "enriched": true,
  "matchResult": {
    "isMatch": true,
    "confidence": 0.85,
    "reviewNote": "Name and date of birth match the screening profile",
    "matchExplanation": "The full name and date of birth both align with the listed profile",
    "incidentSummary": "Individual listed on OFAC SDN list since 2020 for involvement in money laundering activities",
    "riskLevel": "high",
    "severity": "High",
    "tierRationale": "The subject is named on the OFAC SDN list, a direct sanctions-list match, which places this hit in the High tier.",
    "clearedReason": null,
    "categories": [
      {
        "label": "Direct match",
        "description": "named on the OFAC SDN sanctions list"
      }
    ]
  },
  "note": "Confirmed false positive after manual review",
  "individualId": "507f1f77bcf86cd799439013",
  "groupId": null,
  "storyId": null,
  "origin": "INITIAL_SCREENING"
}