curl --request POST \
--url https://instance.prod.onboardapp.io/v1/entities \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"type": "Person",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"nationality": "<string>",
"company_name": "<string>",
"registration_number": "<string>",
"country": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"external_reference": "<string>",
"metadata": {}
}
'{
"data": {
"token": "ent_8f3k2m1n",
"type": "Person",
"first_name": "John",
"last_name": "Smith",
"full_name": "John Smith",
"company_name": "<string>",
"date_of_birth": "2023-12-25",
"nationality": "GB",
"registration_number": "<string>",
"country": "GB",
"role": "Primary",
"verification_status": "Not Started",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"checks_summary": {
"total": 123,
"complete": 123,
"pending": 123,
"failed": 123
},
"alerts_summary": {
"total": 123,
"open": 123,
"resolved": 123
},
"external_reference": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "req_9k4m2n1p3q",
"page": {
"cursor": "<string>",
"has_more": true
}
}
}Create a new entity for compliance investigation. The entity type determines which fields are required and which checks can be executed.
Person entities require first_name, last_name, and at least one of
date_of_birth or nationality for effective screening.
Company entities require company_name and country. Include
registration_number for registry lookups.
curl --request POST \
--url https://instance.prod.onboardapp.io/v1/entities \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"type": "Person",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"nationality": "<string>",
"company_name": "<string>",
"registration_number": "<string>",
"country": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"external_reference": "<string>",
"metadata": {}
}
'{
"data": {
"token": "ent_8f3k2m1n",
"type": "Person",
"first_name": "John",
"last_name": "Smith",
"full_name": "John Smith",
"company_name": "<string>",
"date_of_birth": "2023-12-25",
"nationality": "GB",
"registration_number": "<string>",
"country": "GB",
"role": "Primary",
"verification_status": "Not Started",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"checks_summary": {
"total": 123,
"complete": 123,
"pending": 123,
"failed": 123
},
"alerts_summary": {
"total": 123,
"open": 123,
"resolved": 123
},
"external_reference": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "req_9k4m2n1p3q",
"page": {
"cursor": "<string>",
"has_more": true
}
}
}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.
Unique key for idempotent request handling. If a request with the same key was already processed within the last 24 hours, the original response is returned.
Request body for creating a new entity.
Entity type.
Person, Company Person first name (required for Person type).
Person last name (required for Person type).
Person date of birth (YYYY-MM-DD).
ISO 3166-1 alpha-2 nationality code.
Company legal name (required for Company type).
Company registration number.
ISO 3166-1 alpha-2 country code.
Structured address.
Show child attributes
Your internal reference ID. Used for idempotency.
255Arbitrary key-value metadata.
Show child attributes
Entity created.
Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.