Skip to main content
POST
/
name-screening
/
alerts
Create or retrieve an alert
curl --request POST \
  --url https://api.godiligent.ai/name-screening/alerts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "reference": "CUST-2024-001",
  "profile": [
    {
      "label": "Name",
      "value": "John Doe"
    }
  ]
}'
{
  "id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"
}
Creates a name screening alert and initiates the remediation workflow. The alert provider is automatically determined from your customer configuration.

​
Behavior

  • New alerts begin with status UNRESOLVED and remediation status UNREMEDIATED
  • Existing references return the existing alert’s ID without creating a duplicate
  • Alert IDs are UUIDs that can be used with the Get Alert endpoint

​
Workflow

After creating an alert, the system will:
  1. Generate a unique alert ID
  2. Initialize the alert with the provided profile fields
  3. Prepare the alert for screening against configured providers
  4. Return the alert ID for subsequent status checks and updates

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json
​
reference
string
required

Unique reference identifier for the alert

Maximum length: 200
Example:

"CUST-2024-001"

​
profile
object[]
required

Profile fields for the entity being screened

Minimum length: 1

Response

Alert created or retrieved successfully

​
id
string<uuid>

Alert ID (UUID)

Example:

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