Skip to main content
POST
/
api
/
gateway
/
execute
/
{project_hash}
/
screening
/
api
Screen entity for PEP/sanctions/adverse media
curl --request POST \
  --url https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/screening/api \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "John Smith",
  "date_of_birth": "2023-12-25",
  "country": "<string>",
  "categories": []
}
'
import requests

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

payload = {
"name": "John Smith",
"date_of_birth": "2023-12-25",
"country": "<string>",
"categories": []
}
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({
name: 'John Smith',
date_of_birth: '2023-12-25',
country: '<string>',
categories: []
})
};

fetch('https://instance.prod.onboardapp.io/api/gateway/execute/{project_hash}/screening/api', 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}/screening/api",
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([
'name' => 'John Smith',
'date_of_birth' => '2023-12-25',
'country' => '<string>',
'categories' => [

]
]),
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}/screening/api"

payload := strings.NewReader("{\n \"name\": \"John Smith\",\n \"date_of_birth\": \"2023-12-25\",\n \"country\": \"<string>\",\n \"categories\": []\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}/screening/api")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John Smith\",\n \"date_of_birth\": \"2023-12-25\",\n \"country\": \"<string>\",\n \"categories\": []\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"name\": \"John Smith\",\n \"date_of_birth\": \"2023-12-25\",\n \"country\": \"<string>\",\n \"categories\": []\n}"

response = http.request(request)
puts response.read_body
{
  "adverse_media_count": 123,
  "screening_provider": "<string>",
  "screening_completed_at": "2023-11-07T05:31:56Z",
  "matches": [
    {
      "matchScore": 123,
      "primaryName": "<string>",
      "categories": [
        "<string>"
      ],
      "nationality": "<string>",
      "dateOfBirth": "<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.

X-SYNC-TIMEOUT
integer

Sync timeout in milliseconds. Screening typically completes within 5-10 seconds. Recommended: 15000. Range: 5000-120000.

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 standalone AML screening.

name
string
required

Full name (person) or legal name (company).

Example:

"John Smith"

date_of_birth
string<date>

ISO 8601 date. Person screening only. Reduces false positives by 80-95%.

country
string

ISO 3166-1 alpha-2 code. Filters results by jurisdiction.

entity_type
enum<string>

Entity type. Defaults to person if omitted.

Available options:
person,
company
categories
enum<string>[]

Screening categories. Defaults to all if omitted.

Available options:
pep,
sanctions,
adverse_media,
watchlist

Response

Screening complete. Contains match results.

Result from standalone AML screening.

pep_status
enum<string>
Available options:
No Hit,
Hit
sanctions_status
enum<string>
Available options:
No Hit,
Hit
adverse_media_status
enum<string>
Available options:
No Hit,
Hit
adverse_media_count
integer

Number of adverse media matches.

screening_provider
string

Provider name (e.g., WorldCheck).

screening_completed_at
string<date-time>
matches
object[]

Detailed match information when hits are found.