Get check detail with hits
Returns a single check with full detail including hits.
Organization API key. Keys are prefixed with vk_live_ (production) or
vk_sandbox_ (sandbox).
Check ID (schk_*).
API version date string (e.g. 2026-02-01). If omitted, the version
pinned to your API key is used.
Response key casing. Defaults to snake.
The type of check. Categories:
sanction, pep, adverse_media, warning — screen against global sanctions, PEP, and adverse-media watchlistsemail_risk, phone_risk, ip_risk — lightweight risk scoringemail_risk_enhanced, phone_risk_enhanced, address_validation, ssn_verification — deep provider-backed analysisCheck status. pending = still processing, clear = no matches/low risk,
hit = matches found or high risk, error = provider failure.
Number of screening hits found (AML checks) or 0/1 for risk checks.
Sanitized provider category for the check (e.g.,
aml_screening, email_risk, phone_risk, address_verification).
Raw vendor identifiers are scrubbed at the API boundary — the
underlying vendor name is never exposed to API clients.
Whether ongoing monitoring is enabled for this check (AML only).
Whether this check was created in sandbox mode (uses test data).
PEP risk classification tier. Only present for pep check type.
Recommended action based on PEP risk tier. Only present for pep check type.
When check data was redacted (GDPR). Only present if redacted.
Provider result data. Structure varies by check type:
{match_count, highest_score, ...}{risk_score, risk_level, deliverable, fraud_score, ...}Screening hits (matches). Only included when fetching check detail.