GET/watchlist/entities/{id}

Get a watchlist entity

Returns a single watchlist entity by its id, including risk fields computed from its active cases.

Overview

Returns a single watchlist entity by its id, including risk fields computed from its active cases. You can read entities that belong to your account or have been shared with you or your team.

Auth API key

Send your API key in the X-CasePrimus-Api-Key header. See Authentication for how to create a key, and Rate limits & errors for how requests are counted.

Parameters

Name	In	Description
`id` string Required	path	The id returned when the resource was created.

Example request

Replace CASEPRIMUS_API_KEY with your key.

Request

BASE="https://api.caseprimus.ai/api/caseprimus/v1"

curl "$BASE/watchlist/entities/ENTITY_ID" \
  -H "X-CasePrimus-Api-Key: $CASEPRIMUS_API_KEY"

const BASE = "https://api.caseprimus.ai/api/caseprimus/v1";

const res = await fetch(BASE + "/watchlist/entities/ENTITY_ID", {
  method: "GET",
  headers: {
    "X-CasePrimus-Api-Key": process.env.CASEPRIMUS_API_KEY,
  },
});

const data = await res.json();

import os
import requests

BASE = "https://api.caseprimus.ai/api/caseprimus/v1"

res = requests.request(
    "GET",
    BASE + "/watchlist/entities/ENTITY_ID",
    headers={"X-CasePrimus-Api-Key": os.environ["CASEPRIMUS_API_KEY"]},
)

data = res.json()

Responses

200The entity.

Field	Description
`_id` string
`number` integer
`accountId` string
`name` string
`entityType` enum	`PERSONBUSINESS`
`fatherName` string or null
`birthDate` string or null
`location` string or null
`registrationNumber` string or null
`monitoredCourts` array of string
`status` enum	`ACTIVEPAUSEDARCHIVED`
`nameVariations` array of string	AI-generated alternate spellings/forms of the company name, used to widen court-record name matching. Empty for PERSON entities.
`lastCourtSyncAt` integer (int64) or null	When the daily/on-demand court-record search last ran for this entity.
`sharedWith` array of object
`type` enum	`teamuser`
`id` string	A team ID when type is 'team', a user ID otherwise.
`created` integer (int64)
`createdBy` string
`updated` integer (int64) or null
`updatedBy` string or null
`riskLevel` enum	The single highest risk level among this entity's active cases. `VERY_HIGHHIGHMODERATELOWUNCLASSIFIED`
`riskCounts` object
`VERY_HIGH` integer
`HIGH` integer
`MODERATE` integer
`LOW` integer
`UNCLASSIFIED` integer
`caseCount` integer	Count of ACTIVE cases tracked against this entity.

Response 200

{
  "_id": "CPWLE0exampledemo0001",
  "number": 100001,
  "accountId": "CPA0exampledemo0001",
  "name": "Acme Traders Pvt Ltd",
  "entityType": "BUSINESS",
  "fatherName": null,
  "birthDate": null,
  "location": "Mumbai, Maharashtra",
  "registrationNumber": "U12345MH2015PTC100001",
  "monitoredCourts": [
    "ALL"
  ],
  "status": "ACTIVE",
  "nameVariations": [
    "Acme Traders Private Limited",
    "Acme Traders"
  ],
  "lastCourtSyncAt": 1757500000000,
  "sharedWith": [],
  "created": 1757000000000,
  "createdBy": "CPU0exampledemo0001",
  "updated": null,
  "updatedBy": null,
  "riskLevel": "MODERATE",
  "riskCounts": {
    "VERY_HIGH": 0,
    "HIGH": 1,
    "MODERATE": 2,
    "LOW": 1,
    "UNCLASSIFIED": 0
  },
  "caseCount": 4
}

400Entity does not exist.

Response 400

{
  "httpStatusCode": 400,
  "code": 60400,
  "message": "Watchlist entity does not exist",
  "appError": true
}

403This entity has not been shared with you.

Error responses share one shape, listed on Rate limits & errors.

Get a watchlist entity

Overview

Parameters

Example request

Responses

Related