Skip to main content
GET
List Alerts

Overview

Retrieves alerts for specific entities or across the organization. Alerts are generated automatically by rules when conditions are met.

Endpoint

Authentication

Requires a valid API key in the Authorization header:

Query Parameters

string
required
Entity ID to filter alerts (person, company, or transaction)
string
Filter by status: PENDING, ACKNOWLEDGED, RESOLVED
string
Filter by severity: LOW, MEDIUM, HIGH, CRITICAL
string
Filter by alert category

Response

boolean
Whether the request was successful
array
Array of alert objects
number
Total number of alerts matching filters

Example Requests

Get Alerts for Entity

Filter by Severity and Status

Response Example

Alert Severity Levels

  • LOW: Informational, requires review
  • MEDIUM: Moderate risk, should be investigated
  • HIGH: Significant risk, requires immediate attention
  • CRITICAL: Severe risk, urgent action required

Alert Status Workflow

  1. PENDING: Alert just created, awaiting review
  2. ACKNOWLEDGED: Alert has been reviewed by compliance team
  3. RESOLVED: Alert has been addressed and closed

See Also