Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request GET \
--url https://api.godiligent.ai/v1/name-screenings/searches/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.godiligent.ai/v1/name-screenings/searches/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.godiligent.ai/v1/name-screenings/searches/{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/searches/{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/searches/{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))
}HttpResponse<String> response = Unirest.get("https://api.godiligent.ai/v1/name-screenings/searches/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.godiligent.ai/v1/name-screenings/searches/{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": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
"reference": "CUST-2024-001",
"status": "COMPLETED",
"input": [
{
"label": "full_name",
"value": "John Doe"
}
],
"hit_counts": {
"FALSE_POSITIVE": 2,
"TRUE_POSITIVE": 1,
"UNRESOLVED": 3
},
"hits": [
{
"id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
"provider_reference": "HIT-001",
"provider_url": "https://example.com/hit-001",
"status": "UNRESOLVED",
"fields": [
{
"label": "full_name",
"value": "John Doe"
}
],
"hit_categories": [
"SANCTION"
],
"remediation": {
"sync_status": "SYNCED",
"determination": "FALSE_POSITIVE",
"action": "SET_AS_FALSE_POSITIVE",
"status": "FALSE_POSITIVE",
"action_taken": "RESOLVED",
"determined_at": "2024-01-15T10:30:00Z",
"author": "DILIGENT",
"summary": "No match - different person"
}
}
],
"created_at": "2024-10-02T12:00:00Z",
"updated_at": "2024-10-02T14:30:00Z"
}Retrieve a name screening search with hits and remediation data
curl --request GET \
--url https://api.godiligent.ai/v1/name-screenings/searches/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.godiligent.ai/v1/name-screenings/searches/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.godiligent.ai/v1/name-screenings/searches/{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/searches/{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/searches/{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))
}HttpResponse<String> response = Unirest.get("https://api.godiligent.ai/v1/name-screenings/searches/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.godiligent.ai/v1/name-screenings/searches/{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": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
"reference": "CUST-2024-001",
"status": "COMPLETED",
"input": [
{
"label": "full_name",
"value": "John Doe"
}
],
"hit_counts": {
"FALSE_POSITIVE": 2,
"TRUE_POSITIVE": 1,
"UNRESOLVED": 3
},
"hits": [
{
"id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
"provider_reference": "HIT-001",
"provider_url": "https://example.com/hit-001",
"status": "UNRESOLVED",
"fields": [
{
"label": "full_name",
"value": "John Doe"
}
],
"hit_categories": [
"SANCTION"
],
"remediation": {
"sync_status": "SYNCED",
"determination": "FALSE_POSITIVE",
"action": "SET_AS_FALSE_POSITIVE",
"status": "FALSE_POSITIVE",
"action_taken": "RESOLVED",
"determined_at": "2024-01-15T10:30:00Z",
"author": "DILIGENT",
"summary": "No match - different person"
}
}
],
"created_at": "2024-10-02T12:00:00Z",
"updated_at": "2024-10-02T14:30:00Z"
}Search ID (UUID)
"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"
Search retrieved successfully
Search ID
"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"
Search reference identifier
"CUST-2024-001"
Search status
PENDING, COMPLETED, FAILED "COMPLETED"
Profile fields for the entity being screened
Show child attributes
Count of hits by status
Show child attributes
Alerts created from this search
Show child attributes
Search creation timestamp
"2024-10-02T12:00:00Z"
Search last updated timestamp
"2024-10-02T14:30:00Z"