Skip to main content
POST
/
v1
/
cases
Create case
curl --request POST \
  --url https://instance.prod.onboardapp.io/v1/cases \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "type": "Onboarding",
  "entity_category": "Company",
  "assigned_to": "<string>",
  "entity": {
    "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": {}
  },
  "external_reference": "<string>",
  "metadata": {}
}
'
{
  "data": {
    "token": "cas_9k4m2n1p",
    "name": "CAS-000142",
    "type": "Onboarding",
    "status": "New",
    "entity_category": "Company",
    "assigned_to": "<string>",
    "sla_deadline": "2023-11-07T05:31:56Z",
    "sla_status": "On Track",
    "open_alerts_count": 123,
    "total_entities_count": 123,
    "risk_tier": "High",
    "risk_score": 123,
    "decision": "Approve",
    "external_reference": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "closed_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.

Body

application/json

Request body for creating a new case.

​
type
enum<string>
required

Case type.

Available options:
Onboarding,
Review,
Perpetual
​
entity_category
enum<string>
required

Primary entity category.

Available options:
Company,
Person
​
assigned_to
string

User ID of the reviewer to assign.

​
entity
object

Request body for creating a new entity.

​
external_reference
string

Your internal reference ID.

Maximum string length: 255
​
metadata
object

Response

Case created.

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

​
data
object

An investigation case that groups entities, alerts, checks, risk assessments, and audit trail entries into a single compliance investigation unit. Cases follow a defined lifecycle from creation through investigation to closure.

​
meta
object