Skip to main content
GET
/
v1
/
entities
/
{entity_token}
Get entity details
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/entities/{entity_token} \
  --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
    }
  }
}

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.

Path Parameters

​
entity_token
string
required

Entity token (e.g., ent_abc123).

Pattern: ^ent_[a-zA-Z0-9]+$

Response

Entity details.

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

​
data
object

A person or company entity under compliance investigation. Entities are the subjects of verification checks and may generate alerts when screening matches are found. An entity can belong to multiple cases with different roles.

​
meta
object