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>",
  "external_reference": "<string>"
}
'
import requests

url = "https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/kyc/init"

payload = {
"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>",
"external_reference": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>',
external_reference: '<string>'
})
};

fetch('https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/kyc/init', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/kyc/init",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'external_reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/kyc/init"

payload := strings.NewReader("{\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"country\": \"GB\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"nationality\": \"<string>\",\n \"external_reference\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/kyc/init")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"country\": \"GB\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"nationality\": \"<string>\",\n \"external_reference\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/kyc/init")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"country\": \"GB\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"nationality\": \"<string>\",\n \"external_reference\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "tokens": {
    "pull": "<string>",
    "start": "<string>"
  }
}
{
"error": {
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}
{
"error": {
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}
{
"error": {
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}
{
"error": {
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}
{
"error": {
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<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