Skip to main content
GET
/
v1
/
name-screenings
/
searches
/
{id}
Get search by ID
curl --request GET \
  --url https://api.godiligent.ai/v1/name-screenings/searches/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "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": {
        "status": "FALSE_POSITIVE",
        "determined_at": "2024-01-15T10:30:00Z",
        "summary": "No match - different person",
        "action_taken": "RESOLVED",
        "author": "DILIGENT"
      }
    }
  ],
  "created_at": "2024-10-02T12:00:00Z",
  "updated_at": "2024-10-02T14:30:00Z"
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required

Search ID (UUID)

Example:

"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"

Response

Search retrieved successfully

id
string<uuid>

Search ID

Example:

"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"

reference
string

Search reference identifier

Example:

"CUST-2024-001"

status
enum<string>

Search status

Available options:
PENDING,
COMPLETED,
FAILED
Example:

"COMPLETED"

input
object[]

Profile fields for the entity being screened

hit_counts
object

Count of hits by status

hits
object[]

Alerts created from this search

created_at
string<date-time>

Search creation timestamp

Example:

"2024-10-02T12:00:00Z"

updated_at
string<date-time>

Search last updated timestamp

Example:

"2024-10-02T14:30:00Z"