Skip to main content
POST
/
v1
/
name-screenings
/
alerts
/
remediate
curl --request POST \
  --url https://api.godiligent.ai/v1/name-screenings/alerts/remediate \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "reference": "WC-CASE-2026-001",
  "alt_reference": "CUST-SCREENING-42",
  "input": [
    {
      "label": "full_name",
      "value": "John Alexander Doe"
    },
    {
      "label": "entity_type",
      "value": "INDIVIDUAL"
    },
    {
      "label": "date_of_birth",
      "value": "1985-03-15"
    },
    {
      "label": "country_code",
      "value": "DE"
    }
  ],
  "hits": [
    {
      "reference": "WC-RESULT-12345",
      "profile_reference": "WC-ENTITY-789",
      "categories": [
        "SANCTION"
      ],
      "fields": [
        {
          "label": "Name",
          "value": "John A. Doe"
        },
        {
          "label": "Date of Birth",
          "value": "1985-03-15"
        },
        {
          "label": "Nationality",
          "value": "German"
        }
      ]
    }
  ]
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "reference": "WC-CASE-2026-001",
  "alt_reference": "INTERNAL-42",
  "hits": [
    {
      "reference": "WC-RESULT-12345",
      "profile_reference": "WC-ENTITY-789"
    }
  ]
}
Beta — This endpoint is under active development. The contract may change based on early adopter feedback.

​
Behavior

  • Accepts an alert with subject profile and hits that you have already screened externally
  • Processing is asynchronous — returns an id immediately, remediation runs in the background
  • Results are retrieved via Get Alert using the returned id
  • Triggers an alert_remediated webhook when complete (see Webhooks)

​
Workflow

After submitting, the system will:
  1. Validate the request and persist the alert
  2. Return { "id": "..." } with status 201
  3. Enrich each hit (registry, web search, articles) based on your configured enrichments
  4. Run entity resolution and the rule engine against your configured rules and segments
  5. Generate evidence reports and summaries for each hit
  6. Trigger the alert_remediated webhook
Use the returned id to: See the Remediation API Guide for recommended field labels, best practices, and detailed examples.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
reference
string
required

Provider reference for the alert (e.g. case ID from your screening provider).

Example:

"WC-CASE-2026-001"

​
input
object[]
required

Subject profile as label/value pairs. Freeform labels — the AI uses LLM-based extraction.

Minimum array length: 1
​
hits
object[]
required

Screening hits to remediate. At least one required.

Minimum array length: 1
​
alt_reference
string

Your own client reference for the same alert (e.g. internal case number).

Example:

"INTERNAL-42"

Response

Alert accepted for remediation

​
id
string<uuid>

Alert ID. Use with GET /v1/name-screenings/alerts/{id} to retrieve results.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
reference
string

Provider reference (echoed back).

Example:

"WC-CASE-2026-001"

​
alt_reference
string | null

Client reference (echoed back), or null if not provided.

Example:

"INTERNAL-42"

​
hits
object[]

Submitted hits with references.