Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Body

application/json
external_id
string<uuid>
required

UUID of the person being checked

context
object
required
registries
object[]
required

Array of registries to search

Response

200 - application/json
search_id
string
required

Unique identifier for this search execution

registry
string
required

Registry code that was queried (e.g., "oig-exclusion", "nsopw", "sam", "ofac")

result
enum<string>
required

Outcome of the search

Available options:
match_found,
no_match_found
query
object
required
metadata
object
required
matches
object[]
required

Potential records returned by the registry that resemble the query subject. This array will be empty if no matches are found.

filteredResults
object[]
required

Results that match the search criteria before filtering out false positives. This array will be empty if no filtered results are found.

attestation
object
required
registryPrettyName
string

Human-readable name of the registry