API ReferenceChecks

Pause monitoring

Pauses continuous monitoring for a check.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

check_idstringRequired

Check ID (schk_*).

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Response

Monitoring paused.
idstring
check_typeenum
The type of check. Categories: - **AML**: `sanction`, `pep`, `adverse_media`, `warning` — screen against watchlists via ComplyAdvantage - **Risk**: `email_risk`, `phone_risk`, `ip_risk` — lightweight risk scoring - **Enhanced**: `email_risk_enhanced`, `phone_risk_enhanced`, `address_validation` — deep provider-backed analysis
statusenum

Check status. pending = still processing, clear = no matches/low risk, hit = matches found or high risk, error = provider failure.

Allowed values:
has_matchboolean
Whether the check found any matches or flagged risk.
hit_countinteger

Number of screening hits found (AML checks) or 0/1 for risk checks.

providerstring or null

The screening provider used (e.g., comply_advantage, ipqs, telesign, smarty).

session_idstring or null
Associated session ID, if the check was triggered as part of a verification session.
identity_idstring or null
Associated identity ID, if the check is linked to a known identity.
external_refstring or null
Your external reference for the subject.
monitoring_enabledboolean

Whether ongoing monitoring is enabled for this check (AML only).

is_sandboxboolean

Whether this check was created in sandbox mode (uses test data).

tagslist of strings
Custom tags attached to this check.
batch_idstring or null
Batch ID if this check was created via the bulk endpoint.
pep_risk_tierenum

PEP risk classification tier. Only present for pep check type.

Allowed values:
redacted_atdatetime or null

When check data was redacted (GDPR). Only present if redacted.

last_checked_atdatetime
created_atdatetime
expires_atdatetime
resultobject or null
Provider result data. Structure varies by check type: - **AML**: `{match_count, highest_score, ...}` - **Risk**: `{risk_score, risk_level, deliverable, fraud_score, ...}` - **Enhanced**: Provider-specific detailed analysis object
hitslist of objects

Screening hits (matches). Only included when fetching check detail.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error