Skip to main content
POST
/
api
/
gateway
/
execute
/
{project_hash}
/
kyc
/
api
Execute Person Verification (sync)
curl --request POST \
  --url https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/kyc/api \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "first_name": "Jane",
  "last_name": "Smith",
  "country": "GB",
  "date_of_birth": "2023-12-25",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "address": "<string>",
  "city": "<string>",
  "postal_code": "<string>",
  "nationality": "<string>",
  "document_type": "passport",
  "external_reference": "<string>"
}
'
{
  "case_reference": "AML-2026-0042",
  "external_reference": "<string>",
  "processing_status": "complete",
  "overall_verdict": "Pass",
  "risk_tier": "High",
  "completed_at": "2023-11-07T05:31:56Z",
  "next_review_date": "2023-12-25",
  "company": {},
  "screening": {},
  "directors": [
    {}
  ],
  "beneficial_owners": [
    {}
  ],
  "identity": {},
  "document": {},
  "biometric": {},
  "risk_assessment": {},
  "checks_summary": {},
  "compliance_metadata": {}
}

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

​
X-API-KEY
string
required

Project-scoped API key.

​
X-SYNC-TIMEOUT
integer

Sync timeout in milliseconds. Range: 5000-120000. Recommended: 30000 for screening-only, 60000 for screening + identity.

Required range: 5000 <= x <= 120000
​
Idempotency-Key
string

Unique key for idempotent request handling.

Path Parameters

​
project_hash
string
required

Project identifier from Zenoo Studio.

Body

application/json

Request body for Person Verification. Supports three tiers of data.

TierFieldsResult Quality
Minimumfirst_name, last_name, countryBasic screening
Standard+ date_of_birth, email, phone, addressIdentity + phone/email verification
Full+ nationality, document_type, external_referenceIdempotency, preferred document
​
first_name
string
required

Individual's first name.

Example:

"Jane"

​
last_name
string
required

Individual's last name.

Example:

"Smith"

​
country
string
required

Country of residence. ISO 3166-1 alpha-2 code.

Example:

"GB"

​
date_of_birth
string<date>

ISO 8601 date (YYYY-MM-DD). Reduces screening false positives by 80-95%.

​
email
string<email>

Email address. Triggers email verification check.

​
phone
string

Phone number in E.164 format (e.g., +447700900123).

​
address
string

Street address.

​
city
string

City.

​
postal_code
string

Postal or ZIP code.

​
nationality
string

ISO 3166-1 alpha-2 code.

​
document_type
enum<string>

Preferred document type for verification UI.

Available options:
passport,
national_id,
driving_licence
​
external_reference
string

Your internal reference ID for idempotency.

Maximum string length: 255

Response

All checks completed within timeout. Full compliance report.

Top-level verification result from the pull endpoint or sync response. Contains overall verdict, risk assessment, and detailed check results.

​
case_reference
string

Zenoo's unique case identifier.

Example:

"AML-2026-0042"

​
external_reference
string

Your reference ID, echoed back from the request.

​
processing_status
enum<string>

Current processing state.

Available options:
complete,
processing,
failed
​
overall_verdict
enum<string>

Aggregated verification outcome.

Available options:
Pass,
Refer,
Fail
​
risk_tier
enum<string>

Assessed risk level.

Available options:
High,
Medium,
Low
​
completed_at
string<date-time>

ISO 8601 completion timestamp.

​
next_review_date
string<date>

Recommended next review date.

​
company
object

Registry-verified company data (Company Verification only).

​
screening
object

Screening summary with PEP/sanctions/adverse media status.

​
directors
object[]

Director screening results (Company Verification only).

​
beneficial_owners
object[]

UBO screening results (Company Verification only).

​
identity
object

Identity verification result (Person Verification only).

​
document
object

Document verification result (Person Verification only).

​
biometric
object

Biometric liveness result (Person Verification only).

​
risk_assessment
object

Risk score breakdown.

​
checks_summary
object

Summary of all checks performed.

​
compliance_metadata
object

CDD/EDD status and case URL.