v1

latestOpenAPI 3.0.12026-07-22156.7 KB

Name Screening

Submit alert for remediation (Beta)

Submit an externally-screened alert for AI-powered remediation. For customers who perform name screening themselves and want Diligent's AI to resolve the hits.

Processing is asynchronous — use Get Alert to retrieve results.

See the Remediation API Guide for recommended field labels and detailed examples.

post/v1/name-screenings/alerts/remediate

Request body

referencestring required

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

alt_referencestring

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

Example request

{
  "reference": "WC-CASE-2026-001",
  "alt_reference": "INTERNAL-42",
  "input": [
    {
      "label": "Name",
      "value": "John Doe"
    }
  ],
  "hits": [
    {
      "reference": "WC-RESULT-12345",
      "profile_reference": "WC-ENTITY-789",
      "categories": [
        "SANCTION"
      ],
      "fields": [
        {
          "label": "Name",
          "value": "John A. Doe"
        }
      ]
    }
  ]
}

Response

Alert accepted for remediation

idstring uuid

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

referencestring

Provider reference (echoed back).

alt_referencestring nullable

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

Example response

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

All 1 operations