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>",
  "entity_type": "person",
  "categories": [
    "pep"
  ]
}
'
{
  "pep_status": "No Hit",
  "sanctions_status": "No Hit",
  "adverse_media_status": "No Hit",
  "adverse_media_count": 123,
  "screening_provider": "<string>",
  "screening_completed_at": "2023-11-07T05:31:56Z",
  "matches": [
    {
      "matchScore": 123,
      "primaryName": "<string>",
      "category": "pep",
      "categories": [
        "<string>"
      ],
      "nationality": "<string>",
      "dateOfBirth": "<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.