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
| Field | Type | Description |
|---|---|---|
token | string | Unique check identifier (prefix chk_) |
type | string | Check type name (e.g., PEP Screening, Company Registry) |
type_code | string | Developer name from check type configuration |
category | string | Check category. See categories |
status | string | Current status. See statuses |
result | string | Check result: Pass, Refer, Fail, null (pending) |
result_summary | string | Human-readable result description |
result_data | object | Raw JSON result from API provider |
match_score | number | Screening match confidence (0-100), null if not applicable |
case_token | string | Parent case token |
entity_name | string | Name of the entity being checked |
entity_token | string | Token of the entity being checked |
provider | string | Provider code (e.g., WorldCheck, Kyckr, Twilio) |
execution_method | string | Execution method. See execution methods |
alert_token | string | Token of generated alert (if result produced an alert) |
retry_count | number | Number of execution retry attempts |
edd_only | boolean | Whether this check only applies to Enhanced Due Diligence |
verification_url | string | Client verification URL (async checks only) |
verification_expires | string | ISO 8601 expiry of verification URL |
valid_until | string | ISO 8601 date until which this check is valid for reuse |
original_check_token | string | Token of the original check (for reused checks) |
reuse_source_case | string | Case name the reused check originated from |
document_token | string | Token of linked document requirement (hybrid checks) |
started_at | string | ISO 8601 timestamp of execution start |
completed_at | string | ISO 8601 timestamp of execution completion |
created_at | string | ISO 8601 timestamp of creation |
updated_at | string | ISO 8601 timestamp of last modification |
Check statuses
| Status | Description |
|---|---|
Pending | Created, awaiting execution or manual action |
Queued | Scheduled for automatic execution |
In Progress | Currently executing against a provider |
Awaiting Document | Hybrid check waiting for document upload |
Awaiting Client | Waiting for client-side action (document capture, etc.) |
Complete | Execution finished with a result |
Failed | Execution error or timeout |
Waived | Manually waived by analyst with documented reason |
Cancelled | Cancelled before execution |
Reused | Valid check from another case reused |
Retry Scheduled | Failed check scheduled for automatic retry |
Check categories
| Category | Description |
|---|---|
Screening | PEP, sanctions, adverse media, watchlist checks |
Identity | Identity and biometric verification |
Company | Company registry and corporate checks |
Financial | Credit, source of wealth, financial checks |
EDD | Enhanced Due Diligence checks |
Check results
| Result | Description | Alert generated? |
|---|---|---|
Pass | Verification passed, no issues | No |
Refer | Potential issue, needs review | Yes |
Fail | Verification failed | Yes |
Execution methods
| Method | Description | Example provider |
|---|---|---|
API | Automated execution via external API | WorldCheck, Kyckr |
Manual_Check | Manual review by analyst | Manual sanctions |
Document | Document upload required | Certificate upload |
Free_Text | Free text input required | SOW explanation |
Dropdown | Selection from predefined options | SOW selection |
Hybrid | API check paired with document requirement | Registry + 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"
}
Related endpoints
| Endpoint | Method | Description |
|---|---|---|
GET /v1/cases/{token}/checks | GET | List checks for a case |
GET /v1/checks/{token} | GET | Get check details |
POST /v1/checks/{token}/execute | POST | Manually trigger check execution |
POST /v1/checks/{token}/waive | POST | Waive a check with reason |
POST /v1/checks/{token}/retry | POST | Retry a failed check |
GET /v1/entities/{token}/checks | GET | List checks for an entity |