Get Search - Godiligent API Documentation

Retrieves a complete name screening search including its status, input fields, and all matching hits.

Response Structure

The search response includes:

Search metadata: ID, reference, status, and timestamps
Input fields: The subject’s information used for screening
Hit counts: Number of hits by status (FALSE_POSITIVE, TRUE_POSITIVE, UNRESOLVED)
Hits: Array of screening matches, each containing:
- Hit ID, provider reference, and provider URL
- Hit status (FALSE_POSITIVE, TRUE_POSITIVE, UNRESOLVED)
- Hit fields with match details
- Hit categories (SANCTION, PEP, MEDIA)
- Remediation data with AI analysis and resolution

Example response:

{
  "id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
  "reference": "CUST-2024-001",
  "status": "COMPLETED",
  "input": [
    {"label": "Name", "value": "John Doe"}
  ],
  "hit_counts": {
    "FALSE_POSITIVE": 2,
    "TRUE_POSITIVE": 1,
    "UNRESOLVED": 3
  },
  "hits": [
    {
      "id": "hit-001",
      "provider_reference": "WC-12345",
      "provider_url": "https://worldcheck.com/...",
      "status": "UNRESOLVED",
      "fields": [...],
      "hit_categories": ["SANCTION"],
      "remediation": null
    }
  ],
  "created_at": "2024-10-02T12:00:00Z",
  "updated_at": "2024-10-02T14:30:00Z"
}

Search Status

Monitor the status field to track search progress:

PENDING - Search created, provider query in progress
COMPLETED - Search finished, hits available
FAILED - Provider query failed

Working with Hits

Each hit in the response includes:

provider_reference: Provider’s identifier for this match
provider_url: Direct link to the match in provider’s system
status: Resolution status (UNRESOLVED by default)
fields: Match details and confidence scores
hit_categories: Type of match (SANCTION, PEP, MEDIA)
remediation: AI analysis with determination and evidence

Typical Flow

Create search and receive search ID
Poll search endpoint to check status
When status is COMPLETED, review hits array
Access remediation data for AI-generated analysis

Authorizations

X-API-KEY

string

header

required

API key for authentication

Path Parameters

string<uuid>

required

Search ID (UUID)

Example:

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

Response

Search retrieved successfully

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

Show child attributes

input.label

string

required

Field label (e.g., 'Name', 'DOB', 'Address')

Example:

"Name"

input.value

string

required

Field value

Example:

"John Doe"

hit_counts

object

Count of hits by status

Show child attributes

hit_counts.FALSE_POSITIVE

integer

required

Number of false positive hits

Example:

2

hit_counts.TRUE_POSITIVE

integer

required

Number of true positive hits

Example:

1

hit_counts.UNRESOLVED

integer

required

Number of unresolved hits

Example:

3

hits

object[]

Alerts created from this search

Show child attributes

hits.id

string<uuid>

Hit ID

Example:

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

hits.provider_reference

string

Hit reference identifier

Example:

"HIT-001"

hits.provider_url

string

Hit provider URL

Example:

"https://example.com/hit-001"

hits.status

enum<string>

Hit status

Available options:

FALSE_POSITIVE,

TRUE_POSITIVE,

UNRESOLVED

Example:

"UNRESOLVED"

hits.fields

object[]

Hit profile fields

Show child attributes

hits.fields.label

string

required

Field label (e.g., 'Name', 'DOB', 'Address')

Example:

"Name"

hits.fields.value

string

required

Field value

Example:

"John Doe"

hits.hit_categories

enum<string>[]

Categories for this hit

Available options:

SANCTION,

PEP,

MEDIA

Example:

["SANCTION"]

hits.remediation

object

Show child attributes

hits.remediation.status

enum<string>

required

Resolution status

Available options:

FALSE_POSITIVE,

TRUE_POSITIVE,

UNRESOLVED

Example:

"FALSE_POSITIVE"

hits.remediation.determined_at

string<date-time>

required

When the resolution was determined

Example:

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

hits.remediation.summary

string

required

Resolution summary

Example:

"No match - different person"

hits.remediation.action_taken

enum<string>

required

Action taken during resolution

Available options:

NONE,

COMMENTED,

RESOLVED

Example:

"RESOLVED"

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"

API Reference

​Response Structure

​Search Status

​Working with Hits

​Typical Flow

Authorizations

Path Parameters

Response

Response Structure

Search Status

Working with Hits

Typical Flow