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": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}Initiate Person Verification journey (async)
Initialize an asynchronous person verification journey. Returns tokens
immediately. Use the start token to construct a verification URL that
redirects the individual to Zenoo’s hosted verification experience for
document capture and biometric liveness.
Verification URL format:
https://instance.prod.onboardapp.io/{project_hash}/?t={start_token}
The start token expires after 24 hours. The pull token remains valid
for 30 days after results become available.
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": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}Authorizations
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
Project-scoped API key.
Unique key for idempotent request handling.
Path Parameters
Project identifier from Zenoo Studio.
Body
Request body for Person Verification. Supports three tiers of data.
| Tier | Fields | Result Quality |
|---|---|---|
| Minimum | first_name, last_name, country | Basic screening |
| Standard | + date_of_birth, email, phone, address | Identity + phone/email verification |
| Full | + nationality, document_type, external_reference | Idempotency, preferred document |
Individual's first name.
"Jane"
Individual's last name.
"Smith"
Country of residence. ISO 3166-1 alpha-2 code.
"GB"
ISO 8601 date (YYYY-MM-DD). Reduces screening false positives by 80-95%.
Email address. Triggers email verification check.
Phone number in E.164 format (e.g., +447700900123).
Street address.
City.
Postal or ZIP code.
ISO 3166-1 alpha-2 code.
Preferred document type for verification UI.
passport, national_id, driving_licence Your internal reference ID for idempotency.
255Response
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.
Show child attributes
Show child attributes