Skip to main content
GET
Get search by ID

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"