Skip to main content

Alerts

Alerts represent compliance issues that require analyst review. They are generated automatically from check results (screening matches, identity failures) or created manually. Each alert belongs to a case and optionally links to a specific entity.

Resource fields

FieldTypeDescription
tokenstringUnique alert identifier (prefix alt_)
typestringAlert type. See types
categorystringAlert category. See categories
titlestringHuman-readable alert title
descriptionstringDetailed description with source and match details
statusstringCurrent status. See statuses
prioritystringPriority: Critical, High, Medium, Low
priority_scorenumberComposite priority score (0-290)
risk_tierstringRisk tier assigned by assessor: High, Medium, Low
match_scorenumberScreening match confidence (0-100)
case_tokenstringParent case token
entity_namestringName of the entity this alert relates to
entity_tokenstringToken of the related entity
assigned_toobjectAssigned analyst { id, name, email }
resolved_byobjectUser who resolved { id, name, email }
resolved_atstringISO 8601 timestamp of resolution
resolution_actionstringResolution action. See resolution actions
resolution_notesstringResolution justification
sla_due_datestringISO 8601 timestamp of SLA deadline
sla_statusstringSLA status: On Track, Warning, Critical, Breached
sla_hours_remainingnumberHours until SLA breach
source_dataobjectRaw screening match data from provider
ai_researchobjectAI research results (see AI fields)
auto_triagedbooleanWhether auto-triage was attempted
auto_disposedbooleanWhether the alert was auto-disposed
auto_disposition_reasonstringDetailed rationale for auto-disposition
qa_samplebooleanWhether flagged for QA review
created_atstringISO 8601 timestamp of creation
updated_atstringISO 8601 timestamp of last modification

AI research fields

The ai_research object is populated when AI analysis is triggered:
FieldTypeDescription
statusstringpending, processing, completed, failed
assessmentstringDetailed narrative analysis of the match
confidencenumberAI confidence in its assessment (0-100)
false_positive_probabilitynumberEstimated false positive probability (0-100)
recommended_actionstringAI-suggested resolution action
sourcesarrayArray of { title, url } sources consulted
researched_atstringISO 8601 timestamp of research completion

Alert statuses

StatusDescription
OpenCreated, awaiting analyst review
AcknowledgedAnalyst has claimed the alert
ResolvedResolved with an action and notes
False PositiveConfirmed as a false positive match
EscalatedEscalated to a senior reviewer or manager

Alert types

TypeDescription
ScreeningGenerated from PEP/sanctions/adverse media checks
IdentityGenerated from identity verification failures
CompanyGenerated from company registry check issues
DocumentGenerated from document verification failures
FinancialGenerated from financial or credit check issues
Client InputCreated when client input is required
Internal ReviewCreated for internal compliance review

Alert categories

CategoryTypeDescription
PEP MatchScreeningPolitically Exposed Person match
Sanctions HitScreeningSanctions list match
Adverse MediaScreeningNegative media coverage match
Name MismatchIdentityName differs between documents
DOB MismatchIdentityDate of birth discrepancy
Criminal InvestigationScreeningCriminal investigation record
Regulatory ActionScreeningRegulatory enforcement action
API FailureCompanyExternal API check failure
Watchlist MatchScreeningOther watchlist match
Ongoing ScreeningScreeningHit from ongoing monitoring
RCA MatchScreeningRelative or close associate match

Resolution actions

ActionDescription
ApproveAlert reviewed, no issues or risk accepted
DeclineConfirmed compliance issue, reject entity
EscalateRoute to senior reviewer
Request DocumentRequest additional evidence from client
Approve with ConditionsAccept with caveats (e.g., monitoring)

Example

{
  "token": "alt_001",
  "type": "Screening",
  "category": "PEP Match",
  "title": "PEP Match: John Doe",
  "description": "WorldCheck screening returned a PEP match for 'John Doe' against UK political figures database.",
  "status": "Open",
  "priority": "High",
  "priority_score": 78,
  "risk_tier": "Medium",
  "match_score": 92,
  "case_token": "cas_xyz789",
  "entity_name": "John Doe",
  "entity_token": "ent_ubo789",
  "assigned_to": {
    "id": "user_analyst01",
    "name": "Sarah Johnson",
    "email": "sarah@example.com"
  },
  "sla_due_date": "2026-02-18T10:00:00Z",
  "sla_status": "On Track",
  "sla_hours_remaining": 46.5,
  "source_data": {
    "provider": "WorldCheck",
    "matched_name": "John Doe",
    "match_type": "Exact",
    "pep_category": "Former Local Councillor"
  },
  "ai_research": null,
  "auto_triaged": false,
  "auto_disposed": false,
  "qa_sample": false,
  "created_at": "2026-02-16T10:15:00Z",
  "updated_at": "2026-02-16T10:15:00Z"
}
EndpointMethodDescription
GET /v1/alertsGETList alerts with filters
GET /v1/alerts/{token}GETGet alert details
POST /v1/alerts/{token}/resolvePOSTResolve an alert
POST /v1/alerts/{token}/acknowledgePOSTAcknowledge an alert
POST /v1/alerts/{token}/escalatePOSTEscalate an alert
POST /v1/alerts/{token}/ai-researchPOSTTrigger AI research
GET /v1/alerts/{token}/ai-researchGETGet AI research results
POST /v1/alerts/bulk/resolvePOSTBulk resolve alerts
POST /v1/alerts/bulk/acknowledgePOSTBulk acknowledge alerts
POST /v1/alerts/bulk/assignPOSTBulk assign alerts

See also