Get Alert - Godiligent API Documentation

Get alert by ID

curl --request GET \
  --url https://api.godiligent.ai/v1/name-screenings/alerts/{id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.godiligent.ai/v1/name-screenings/alerts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.godiligent.ai/v1/name-screenings/alerts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.godiligent.ai/v1/name-screenings/alerts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.godiligent.ai/v1/name-screenings/alerts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "714808a0-faf0-4e0f-a3a3-fbe490a10efd",
  "reference": "5jb7h9b1kiu51kbwyrjhog350",
  "status": "COMPLETED",
  "remediation_status": "REMEDIATED",
  "hits": [
    {
      "reference": "5jb766qtsj0e1kbwyrlh03gpe",
      "hit_categories": [
        "MEDIA"
      ],
      "evidences": [
        {
          "type": "DOB",
          "categories": [
            "DOB_AMBIGUOUS",
            "DOB_YEAR_MISMATCH"
          ],
          "supporting_facts": [
            {
              "predicate": "date_of_birth",
              "value": "1974",
              "citations": [
                {
                  "name": "ARTICLE",
                  "url": "https://example.com/article"
                }
              ]
            }
          ]
        }
      ],
      "resolution": {
        "status": "NOTHING",
        "summary": "DOB mismatch - different person",
        "author": "DILIGENT",
        "action": "COMMENT_FALSE_POSITIVE",
        "determination": "FALSE_POSITIVE",
        "applied_rule": {
          "name": "Date of Birth Mismatch"
        }
      }
    }
  ],
  "created_at": "2024-01-15T09:00:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "alt_reference": "ABIGASQLIM3WR",
  "profile_facts": [
    {
      "predicate": "date_of_birth",
      "value": "1974",
      "citations": [
        {
          "name": "ARTICLE",
          "url": "https://example.com/article"
        }
      ]
    }
  ]
}

GET

name-screenings

alerts

{id}

Get alert by ID

curl --request GET \
  --url https://api.godiligent.ai/v1/name-screenings/alerts/{id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.godiligent.ai/v1/name-screenings/alerts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.godiligent.ai/v1/name-screenings/alerts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.godiligent.ai/v1/name-screenings/alerts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.godiligent.ai/v1/name-screenings/alerts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "714808a0-faf0-4e0f-a3a3-fbe490a10efd",
  "reference": "5jb7h9b1kiu51kbwyrjhog350",
  "status": "COMPLETED",
  "remediation_status": "REMEDIATED",
  "hits": [
    {
      "reference": "5jb766qtsj0e1kbwyrlh03gpe",
      "hit_categories": [
        "MEDIA"
      ],
      "evidences": [
        {
          "type": "DOB",
          "categories": [
            "DOB_AMBIGUOUS",
            "DOB_YEAR_MISMATCH"
          ],
          "supporting_facts": [
            {
              "predicate": "date_of_birth",
              "value": "1974",
              "citations": [
                {
                  "name": "ARTICLE",
                  "url": "https://example.com/article"
                }
              ]
            }
          ]
        }
      ],
      "resolution": {
        "status": "NOTHING",
        "summary": "DOB mismatch - different person",
        "author": "DILIGENT",
        "action": "COMMENT_FALSE_POSITIVE",
        "determination": "FALSE_POSITIVE",
        "applied_rule": {
          "name": "Date of Birth Mismatch"
        }
      }
    }
  ],
  "created_at": "2024-01-15T09:00:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "alt_reference": "ABIGASQLIM3WR",
  "profile_facts": [
    {
      "predicate": "date_of_birth",
      "value": "1974",
      "citations": [
        {
          "name": "ARTICLE",
          "url": "https://example.com/article"
        }
      ]
    }
  ]
}

Behavior

Returns a fully enriched alert including all hits, evidences, and supporting facts
Each evidence contains supporting_facts — the specific facts that contributed to the resolution decision
UNREMEDIATED alerts return 404 to prevent exposure of unprocessed data
The alert must belong to the authenticated customer

Response Shape

The response includes profile_facts at the alert level — facts about the screened subject. Each hit contains evidences, which are categorized as PRIMARY_NAME or grouped by evidence category (e.g. DOB, LOCATION). Each evidence contains:

categories — the signal types (e.g. NAME_GIVEN_NAME_EXACT_MATCH, DOB_YEAR_MISMATCH)
supporting_facts — the facts that drove the evidence, each with:
- predicate — e.g. has_name, date_of_birth
- value — the extracted value
- citations — array with one citation indicating the data source (HIT, PROFILE, ARTICLE, REGISTRY, or WEB_SEARCH) and optionally a url

Authorizations

X-API-KEY

string

header

required

Path Parameters

string

required

Alert ID or reference

Example:

"714808a0-faf0-4e0f-a3a3-fbe490a10efd"

Response

Alert retrieved successfully

string<uuid>

required

Alert unique identifier

Example:

"714808a0-faf0-4e0f-a3a3-fbe490a10efd"

reference

string

required

Alert reference from the provider

Example:

"5jb7h9b1kiu51kbwyrjhog350"

status

string

required

Alert status

Example:

"COMPLETED"

remediation_status

enum<string>

required

Whether all hits have been resolved

Available options:

REMEDIATED,

UNREMEDIATED

Example:

"REMEDIATED"

hits

object[]

required

List of enriched hits

Show child attributes

created_at

string<date-time>

required

Example:

"2024-01-15T09:00:00Z"

updated_at

string<date-time>

required

Example:

"2024-01-15T10:30:00Z"

alt_reference

string | null

Alternate reference identifier

Example:

"ABIGASQLIM3WR"

profile_facts

object[]

Facts about the screened profile (subject of the alert)

Show child attributes

​Behavior

​Response Shape

Authorizations

Path Parameters

Response

Behavior

Response Shape