The Client
A client is who your organisation works for or investigates — either a
company or a person. For a law firm that's someone the firm represents; for
other organisations it may be a customer, a debtor, or a subject of analysis.
It's the anchor most work hangs off: cases belong to clients, and a client
carries your organisation's compliance view of that relationship.
How you address it
/clients/v1 # list, create
/clients/v1/{client} # retrieve, update (PATCH/PUT), delete
All client endpoints are scoped; a new client is
anchored to the scope in your X-Scope header. See
Working with Clients & Cases for the full
workflow.
Key fields
| Field | Notes |
|---|---|
type | company or person — determines which identity fields apply |
displayName | Required; how the client is shown |
countryCode | Required; ISO country code |
registrationNumber | Company identity (null for a person) |
nationalId / dateOfBirth | Person identity (null for a company) |
status | Lifecycle state — see below |
engagementType | advisory, litigation, transactional, compliance, other |
riskClassification, pepStatus, sanctionsStatus, cddLevel | Read-only AML/compliance summary, maintained by compliance workflows |
conflictCheckStatus | Conflict-of-interest state |
taxResidenceCountryCode, vatNumber, lei | Tax / financial identifiers |
tags, notes | Freeform |
riskClassification, pepStatus, sanctionsStatus, cddLevel, and the AML
review dates are set by your organisation's compliance workflows — you can read them on a
client, but they aren't accepted on create/update.
Lifecycle
A client's status moves through:
prospect ──▶ active ──▶ inactive ──▶ archived
│ ▲ │
└────────────┴───────────┘ (can move back to active)
- prospect — a potential client, not yet engaged.
- active — an engaged client you're doing work for.
- inactive — engagement paused; retained but not current.
- archived — closed out; soft-deleted (a
DELETEarchives a client).
Relationships
- Belongs to a tenant (and the scope it was created in).
- Has many cases (
/cases/v1?filter[clientId]=…). - Carries the shared sub-resources
— contacts, addresses, profile, media — under
/entitymanagement/v1/client/{id}/….