curl --request GET \
--url https://instance.prod.onboardapp.io/v1/entities \
--header 'X-API-KEY: <api-key>'{
"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
}
}
}Retrieve entities with optional filtering by type, verification status, or case association. Results are sorted by creation date (newest first).
curl --request GET \
--url https://instance.prod.onboardapp.io/v1/entities \
--header 'X-API-KEY: <api-key>'{
"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.
Pagination cursor from a previous response. Pass to fetch the next page.
Maximum number of items to return per page.
1 <= x <= 100Filter by entity type.
Person, Company Filter by verification status.
Not Started, In Progress, Verified, Expired, Failed Filter entities belonging to a specific case.