Skip to main content
GET
/
v1
/
alerts
/
{alert_token}
Get alert details
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/alerts/{alert_token} \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "token": "alt_3j7k9m2n",
    "case_token": "<string>",
    "entity_token": "<string>",
    "type": "Identity",
    "category": "PEP Match",
    "status": "Open",
    "priority": "Critical",
    "priority_score": 50,
    "sla_deadline": "2023-11-07T05:31:56Z",
    "sla_status": "On Track",
    "match_score": 50,
    "ai_assessment": "<string>",
    "resolution_action": "Approve",
    "resolution_rationale": "<string>",
    "resolved_by": "<string>",
    "resolved_at": "2023-11-07T05:31:56Z",
    "assigned_to": "<string>",
    "is_false_positive": false,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Path Parameters

​
alert_token
string
required

Alert token (e.g., alt_abc123).

Response

Alert details.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

​
data
object

A compliance alert requiring analyst review. Alerts are generated automatically when screening checks find matches (PEP, sanctions, adverse media) or when verification checks fail. Each alert has a priority score and SLA deadline.

​
meta
object