Skip to main content
GET
/
v1
/
entities
List entities with filters
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/entities \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "token": "ent_8f3k2m1n",
      "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",
      "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
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.zenoo.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Query Parameters

​
cursor
string

Pagination cursor from a previous response. Pass to fetch the next page.

​
limit
integer
default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100
​
type
enum<string>

Filter by entity type.

Available options:
Person,
Company
​
verification_status
enum<string>

Filter by verification status.

Available options:
Not Started,
In Progress,
Verified,
Expired,
Failed
​
case_token
string

Filter entities belonging to a specific case.

Response

List of entities.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

​
data
object[]

Response payload. Type varies by endpoint.

​
meta
object