Skip to main content

​
Checks

Checks represent verification requirements executed against external providers. They are auto-created when entities are added to a case and track the full lifecycle from creation through execution to result processing.

​
Resource fields

FieldTypeDescription
tokenstringUnique check identifier (prefix chk_)
typestringCheck type name (e.g., PEP Screening, Company Registry)
type_codestringDeveloper name from check type configuration
categorystringCheck category. See categories
statusstringCurrent status. See statuses
resultstringCheck result: Pass, Refer, Fail, null (pending)
result_summarystringHuman-readable result description
result_dataobjectRaw JSON result from API provider
match_scorenumberScreening match confidence (0-100), null if not applicable
case_tokenstringParent case token
entity_namestringName of the entity being checked
entity_tokenstringToken of the entity being checked
providerstringProvider code (e.g., WorldCheck, Kyckr, Twilio)
execution_methodstringExecution method. See execution methods
alert_tokenstringToken of generated alert (if result produced an alert)
retry_countnumberNumber of execution retry attempts
edd_onlybooleanWhether this check only applies to Enhanced Due Diligence
verification_urlstringClient verification URL (async checks only)
verification_expiresstringISO 8601 expiry of verification URL
valid_untilstringISO 8601 date until which this check is valid for reuse
original_check_tokenstringToken of the original check (for reused checks)
reuse_source_casestringCase name the reused check originated from
document_tokenstringToken of linked document requirement (hybrid checks)
started_atstringISO 8601 timestamp of execution start
completed_atstringISO 8601 timestamp of execution completion
created_atstringISO 8601 timestamp of creation
updated_atstringISO 8601 timestamp of last modification

​
Check statuses

StatusDescription
PendingCreated, awaiting execution or manual action
QueuedScheduled for automatic execution
In ProgressCurrently executing against a provider
Awaiting DocumentHybrid check waiting for document upload
Awaiting ClientWaiting for client-side action (document capture, etc.)
CompleteExecution finished with a result
FailedExecution error or timeout
WaivedManually waived by analyst with documented reason
CancelledCancelled before execution
ReusedValid check from another case reused
Retry ScheduledFailed check scheduled for automatic retry

​
Check categories

CategoryDescription
ScreeningPEP, sanctions, adverse media, watchlist checks
IdentityIdentity and biometric verification
CompanyCompany registry and corporate checks
FinancialCredit, source of wealth, financial checks
EDDEnhanced Due Diligence checks

​
Check results

ResultDescriptionAlert generated?
PassVerification passed, no issuesNo
ReferPotential issue, needs reviewYes
FailVerification failedYes

​
Execution methods

MethodDescriptionExample provider
APIAutomated execution via external APIWorldCheck, Kyckr
Manual_CheckManual review by analystManual sanctions
DocumentDocument upload requiredCertificate upload
Free_TextFree text input requiredSOW explanation
DropdownSelection from predefined optionsSOW selection
HybridAPI check paired with document requirementRegistry + COI

​
Example

{
  "token": "chk_001",
  "type": "PEP Screening",
  "type_code": "PEP_SCREEN",
  "category": "Screening",
  "status": "Complete",
  "result": "Refer",
  "result_summary": "PEP match found: former local councillor (UK)",
  "result_data": {
    "matched_name": "John Doe",
    "match_type": "Exact",
    "pep_category": "Former Local Councillor",
    "country": "GB",
    "source_list": "WorldCheck PEP Database"
  },
  "match_score": 92,
  "case_token": "cas_xyz789",
  "entity_name": "John Doe",
  "entity_token": "ent_ubo789",
  "provider": "WorldCheck",
  "execution_method": "API",
  "alert_token": "alt_001",
  "retry_count": 0,
  "edd_only": false,
  "valid_until": "2026-05-16",
  "started_at": "2026-02-16T10:10:00Z",
  "completed_at": "2026-02-16T10:10:12Z",
  "created_at": "2026-02-16T10:05:00Z",
  "updated_at": "2026-02-16T10:10:12Z"
}
EndpointMethodDescription
GET /v1/cases/{token}/checksGETList checks for a case
GET /v1/checks/{token}GETGet check details
POST /v1/checks/{token}/executePOSTManually trigger check execution
POST /v1/checks/{token}/waivePOSTWaive a check with reason
POST /v1/checks/{token}/retryPOSTRetry a failed check
GET /v1/entities/{token}/checksGETList checks for an entity

​
See also