---
title: "Submit alert for remediation (Beta)"
method: POST
path: "/v1/name-screenings/alerts/remediate"
tags: ["Name Screening"]
---

# Submit alert for remediation (Beta)

`POST /v1/name-screenings/alerts/remediate`

## Request

- Base URL: `https://api.godiligent.ai`
- URL: `https://api.godiligent.ai/v1/name-screenings/alerts/remediate`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/godiligent/apis/diligent-remediation-api-beta/docs/v1/name-screenings/alerts/remediate/post.ts> (a function with typed inputs; its response is checked against the schema)

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](/api-reference/name-screening/get-alert) to retrieve results.

See the [Remediation API Guide](/guides/name-screening/remediation-api) for recommended field labels and detailed examples.

## Request body

- RemediateAlertRequest
  - `reference` string, required: Provider reference for the alert (e.g. case ID from your screening provider).
  - `alt_reference` string: Your own client reference for the same alert (e.g. internal case number).
  - `input` FreeformField[], required: Subject profile as label/value pairs. Freeform labels — the AI uses LLM-based extraction.
    - `label` string, required: Field name
    - `value` string, required: Field value
  - `hits` RemediateHit[], required: Screening hits to remediate. At least one required.
    - `reference` string, required: Provider reference for this hit (e.g. result ID or match ID from your screening provider). Must be unique within the alert.
    - `profile_reference` string: Provider's unique reference for the matched profile/entity. May differ from `reference` — some providers use separate IDs for the match result vs the underlying entity. Enables enrichment caching when the same entity appears across multiple alerts. Defaults to `reference` if omitted.
    - `categories` string[], required: Hit categories.
    - `fields` object[], required: Hit entity profile as label/value pairs. Freeform — use whatever labels your provider gives you.
      - `label` string, required: Field name (e.g. Name, Date of Birth, Nationality)
      - `value` string, required: Field value

## Response `201`

Alert accepted for remediation

- RemediateAlertResponse
  - `id` string, uuid: Alert ID. Use with GET /v1/name-screenings/alerts/{id} to retrieve results.
  - `reference` string: Provider reference (echoed back).
  - `alt_reference` string, nullable: Client reference (echoed back), or null if not provided.
  - `hits` object[]: Submitted hits with references.
    - `reference` string: Provider hit reference (as submitted).
    - `profile_reference` string: Provider entity reference (as submitted, or defaulted to reference).

## Other responses

- `400`: Validation error
- `401`: Unauthorized - Invalid or missing API key
- `404`: Customer configuration not found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/godiligent/apis/diligent-remediation-api-beta.md) - [All operations](https://skmtc.dev/godiligent/apis/diligent-remediation-api-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/godiligent/apis/diligent-remediation-api-beta/revisions/2ba248cf5d9c?raw)