stable
Get Alert
Retrieve details of a specific alert.
GET
{AML_CORE_URL}/amlcore/api/v1/alerts/{alert_id}Description
Fetches detailed information about a specific alert. Alerts are generated when screening results exceed configured risk thresholds or when transaction monitoring detects suspicious patterns.
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| alert_id | string | Required | The unique identifier of the alert | — |
Example Request
cURL
curl -X GET AML_CORE/amlcore/api/v1/alerts/alert-001 \
-H "Authorization: Bearer fl_live_abc123"Example Response
JSON
{
"timestamp": "2026-04-14T12:00:00Z",
"status": 200,
"message": "Success",
"correlationId": "fl-abc123",
"data": {
"alertId": "alert-001",
"type": "PEP_SCREENING",
"severity": "HIGH",
"status": "DETECTED",
"customerId": "prof-001",
"customerName": "John Smith",
"accountNumber": "ACC-001",
"transactionUuid": "57C719CD-699E-3DE9-863E-D678E7A6D838",
"riskScore": 75.0,
"riskLevel": "HIGH",
"description": "Individual matched against PEP database with score of 98%",
"reason": "PEP_MATCH",
"ruleCodes": "PEP_MATCH,HIGH_RISK_SCORE",
"detectionSource": "SCREENING_ENGINE",
"detectionMethod": "FUZZY_MATCH",
"confidence": 98.0,
"triageNotes": "Review required: name matches multiple PEP entries with varying confidence.",
"dismissalReason": null,
"promotedToCaseId": "CASE-2026-0042",
"createdAt": "2026-04-14T10:30:00Z",
"updatedAt": "2026-04-14T12:00:00Z",
"createdBy": "system",
"updatedBy": "system"
}
}Response Fields
Case-Insensitive Enum Values
All enum fields (
type, severity, status) accept case-insensitive input — "high", "HIGH", and "High"are all valid.| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| alertId | string | Optional | Unique identifier | alert-001 |
| type | string | Optional | Alert type. Options: FRAUD, MONEY_LAUNDERING, STRUCTURING, SANCTION_SCREENING, PEP_SCREENING, ADVERSE_MEDIA, WATCHLIST_MATCH (case-insensitive) | PEP_SCREENING |
| severity | string | Optional | Severity. Options: LOW, MEDIUM, HIGH, CRITICAL (case-insensitive) | HIGH |
| status | string | Optional | Status. Options: DETECTED, TRIAGED, DISMISSED, PROMOTED (case-insensitive) | DETECTED |
| customerId | string | Optional | Related customer ID | prof-001 |
| customerName | string | Optional | Customer name | John Smith |
| accountNumber | string | Optional | Account number | ACC-001 |
| transactionUuid | string | Optional | Related transaction UUID (nullable) | 57C719CD-699E-3DE9-863E-D678E7A6D838 |
| riskScore | number | Optional | Risk score (0–100) | 75 |
| riskLevel | string | Optional | Risk level. Options: LOW, MEDIUM, HIGH, CRITICAL | HIGH |
| description | string | Optional | Alert description | Individual matched against PEP database with score of 98% |
| reason | string | Optional | Primary reason | PEP_MATCH |
| ruleCodes | string | Optional | Triggered rules | PEP_MATCH,HIGH_RISK_SCORE |
| detectionSource | string | Optional | Detection source | SCREENING_ENGINE |
| detectionMethod | string | Optional | Detection method | FUZZY_MATCH |
| confidence | number | Optional | Confidence score (0–100) | 98 |
| triageNotes | string | Optional | Triage notes (nullable) | Review required: name matches multiple PEP entries... |
| dismissalReason | string | Optional | Dismissal reason (populated when status is DISMISSED) | null |
| promotedToCaseId | string | Optional | Promoted case ID (nullable; populated when status is PROMOTED) | CASE-2026-0042 |
| createdAt | string | Optional | Creation timestamp | 2026-04-14T10:30:00Z |
| updatedAt | string | Optional | Last update timestamp | 2026-04-14T12:00:00Z |
Error Codes
| Code | Message |
|---|---|
| 404 | Alert not found |
| 401 | Invalid or expired API key |
| 429 | Rate limit exceeded |