The Entity

An entity is a client in an OnboardMe practice. Use entityKey as the foreign key for eForms, KYC, proposals, contacts, and bills.

An entity is a client: an individual, company, trust, or other type the practice has configured. Store entityKey in your system. It is stable across lead conversion and does not change when the client is renamed.

List rows are summaries. Call GET /api/v1/entities/{key} when you need addresses or partner / manager / in-charge assignments.

See Sync clients and Entities.

Attributes

entityKey · uuid

Stable identifier. Use this on every other resource that belongs to a client.

entityCode · string

Practice-facing client code. Not unique across practices and not a substitute for entityKey.

entityName · string

Display name. For individuals this is typically the given name; company names go here as well.

entitySurname · string

Family name for individuals and sole traders. Leave unset for companies.

entityType · string

Type name from GET /api/v1/settings/entity-types. Resolve entityTypeID from that list before you create a client.

status · string

Client status such as Active or Lead.

email · string

Primary email when the practice has one on file.

lastUpdated · datetime

UTC timestamp. Pass this back as lastUpdated on list endpoints for incremental sync.

The Entity object

{
  "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
  "entityCode": "MORGAN",
  "entityName": "Alex",
  "entitySurname": "Morgan",
  "entityType": "Individual",
  "status": "Active",
  "email": "[e-mail]",
  "lastUpdated": "2026-04-16T10:00:00Z"
}