Skip to main content
POST
/
api
/
gateway
/
execute
/
{project_hash}
/
kyc
/
init
Initiate Person Verification journey (async)
curl --request POST \
  --url https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/kyc/init \
  --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>"
}
'
{
  "tokens": {
    "pull": "<string>",
    "start": "<string>"
  }
}

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.

​
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

Verification journey initiated. Use tokens to build URL and retrieve results.

Response from async initiation endpoints (/init). Contains tokens for retrieving results and constructing verification URLs.

​
tokens
object