Skip to main content
PATCH
/
v1
/
entities
/
{entity_token}
Update entity
curl --request PATCH \
  --url https://instance.prod.onboardapp.io/v1/entities/{entity_token} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "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>"
  },
  "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
    }
  }
}

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

​
Idempotency-Key
string<uuid>

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.

Path Parameters

​
entity_token
string
required

Entity token.

Body

application/json

Request body for updating entity attributes. Only include fields to change.

​
first_name
string
​
last_name
string
​
date_of_birth
string<date>
​
nationality
string
​
company_name
string
​
registration_number
string
​
country
string
​
address
object

Structured address.

​
metadata
object

Response

Entity updated.

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