API ReferenceCases

List review cases

Returns review cases for the authenticated organization. Required scope: cases:read.

Authentication

X-API-Keystring

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

Query parameters

statusenumOptional
Filter by case status
qstringOptional
Search by session ID or external ref
rejection_reason_codeenumOptional

Filter to cases whose result carries the given structured rejection code. Useful for triaging buckets like aml_hit or document_authenticity.

limitintegerOptional1-100Defaults to 50
offsetintegerOptional>=0Defaults to 0

Response

List of cases
datalist of objects
paginationobject

Errors

401
Unauthorized Error