Skip to main content
POST
/
v1
/
checks
/
{check_token}
/
run
Execute check
curl --request POST \
  --url https://instance.prod.onboardapp.io/v1/checks/{check_token}/run \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "token": "chk_5n8p3q1r",
    "entity_token": "<string>",
    "type_code": "<string>",
    "category": "Identity",
    "status": "Pending",
    "result": "Pass",
    "provider": "WorldCheck",
    "execution_method": "API",
    "result_data": {},
    "alerts_generated": 123,
    "waive_reason": "<string>",
    "retry_count": 0,
    "valid_until": "2023-11-07T05:31:56Z",
    "executed_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Headers

​
Idempotency-Key
string<uuid>

Unique key for idempotent request handling. If a request with the same key was already processed within the last 24 hours, the original response is returned.

Path Parameters

​
check_token
string
required

Check token.

Response

Check execution initiated.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

​
data
object

A verification check executed against a specific provider. Checks are the atomic units of verification — each produces a pass/fail/refer result. Valid results from prior checks can be reused across cases.

​
meta
object