Remediation - Godiligent API Documentation

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"
    }
  ]
}

{
  "error": "Validation failed",
  "details": [
    {
      "field": "hits.0.reference",
      "message": "Reference is required"
    }
  ]
}

POST

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"
    }
  ]
}

{
  "error": "Validation failed",
  "details": [
    {
      "field": "hits.0.reference",
      "message": "Reference is required"
    }
  ]
}

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:

Validate the request and persist the alert
Return { "id": "..." } with status 201
Enrich each hit (registry, web search, articles) based on your configured enrichments
Run entity resolution and the rule engine against your configured rules and segments
Generate evidence reports and summaries for each hit
Trigger the alert_remediated webhook

Use the returned id to:

Retrieve full results with GET /name-screenings/alerts/
Correlate with webhook notifications

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

Show child attributes

hits

object[]

required

Screening hits to remediate. At least one required.

Minimum array length: 1

Show child attributes

alt_reference

string

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

Example:

"INTERNAL-42"

Response

Alert accepted for remediation

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.

Show child attributes

​Behavior

​Workflow

Authorizations

Body

Response

Behavior

Workflow