Response Structure
The alert response includes:- Alert metadata: ID, reference, status, and timestamps
- Profile fields: The subject’s information used for screening
- Hits: List of potential matches from screening providers, each containing:
- Match profile and confidence score
- Source types (SANCTION, WATCHLIST, PEP, MEDIA)
- Related articles and evidence
- Remediation status and comments
- Comments: Alert-level discussion and notes
- Status tracking: Creation and last update timestamps
Hit Statuses
Each hit can be marked as:UNRESOLVED
- Pending reviewFALSE_POSITIVE
- Not a true matchTRUE_POSITIVE
- Confirmed match requiring action
Authorizations
API key for authentication
Path Parameters
Alert ID (UUID)
Example:
"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"
Response
Alert retrieved successfully
Alert ID
Example:
"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"
Alert reference identifier
Example:
"CUST-2024-001"
Alert status
Available options:
RESOLVED
, UNRESOLVED
Example:
"UNRESOLVED"
Profile fields
List of screening hits
Alert-level comments
Alert creation timestamp
Example:
"2024-10-02T12:00:00Z"
Alert last updated timestamp
Example:
"2024-10-02T14:30:00Z"