Skip to main content
GET
/
name-screening
/
alerts
/
{id}
Get alert by ID
curl --request GET \
  --url https://api.godiligent.ai/name-screening/alerts/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
  "reference": "CUST-2024-001",
  "status": "UNRESOLVED",
  "profile": [
    {
      "label": "Name",
      "value": "John Doe"
    }
  ],
  "hits": [
    {
      "reference": "HIT-001",
      "status": "UNRESOLVED",
      "profile": [
        {
          "label": "Name",
          "value": "John Doe"
        }
      ],
      "source_types": [
        "SANCTION"
      ],
      "comments": [
        {
          "reference": "COMMENT-001",
          "comment": "Name match confirmed",
          "author": "DILIGENT",
          "recommendedStatus": "FALSE_POSITIVE"
        }
      ],
      "articles": [
        {
          "url": "https://example.com/article",
          "details": {},
          "content": "Article text content..."
        }
      ],
      "remediation": {
        "status": "FALSE_POSITIVE",
        "comment": "No match - different person",
        "details": {}
      }
    }
  ],
  "comments": [
    {
      "reference": "COMMENT-001",
      "comment": "Reviewed and approved",
      "author": "John Doe"
    }
  ],
  "createdAt": "2024-10-02T12:00:00Z",
  "updatedAt": "2024-10-02T14:30:00Z"
}
Retrieves a complete name screening alert including all screening hits, comments, and remediation data.

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 review
  • FALSE_POSITIVE - Not a true match
  • TRUE_POSITIVE - Confirmed match requiring action

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

id
string<uuid>
required

Alert ID (UUID)

Example:

"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"

Response

Alert retrieved successfully

id
string<uuid>

Alert ID

Example:

"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"

reference
string

Alert reference identifier

Example:

"CUST-2024-001"

status
enum<string>

Alert status

Available options:
RESOLVED,
UNRESOLVED
Example:

"UNRESOLVED"

profile
object[]

Profile fields

hits
object[]

List of screening hits

comments
object[]

Alert-level comments

createdAt
string<date-time>

Alert creation timestamp

Example:

"2024-10-02T12:00:00Z"

updatedAt
string<date-time>

Alert last updated timestamp

Example:

"2024-10-02T14:30:00Z"