> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onboardme.app/llms.txt
> Use this file to discover all available pages before exploring further.

# What Are Entities in OnboardMe?

> Entities are the clients in an OnboardMe practice — individuals and companies. Learn about entity keys, types, statuses, and how they map to external systems.

In OnboardMe, an **entity** is a client record in the practice. Entities represent the individuals and companies that the practice works with — for example, a company being onboarded, a tax entity, or an individual receiving a proposal.

## Entity types

Each entity has an `entityTypeID` and `entityTypeName`. Common types are:

* **Individual** (`entityTypeID: 1`) — a person
* **Company** (`entityTypeID: 2`) — a company or organisation

The practice may also have custom entity types. Use `GET /api/v1/settings/entity-types` to retrieve the full list of configured types for the practice.

## Entity keys

Every entity has a unique `entityKey` — a UUID that persists for the lifetime of the record. Use this key to:

* Retrieve full entity details with `GET /api/v1/entities/{key}`
* Get linked external IDs with `GET /api/v1/entities/{key}/integrations`
* Reference the entity when sending eForms (`entityKey` in the request body)
* Reference the entity when triggering identity verification

The `entityCode` is a human-readable code assigned by the practice (e.g., `RS-10492`). It is useful for display, but use `entityKey` for programmatic references.

## Client status

The `clientStatusName` field reflects the client's current status in the practice workflow, such as:

* `"Lead"` — a prospective client
* `"Active"` — a current client
* `"Terminated"` — a former client (the `entityTerminated` flag is also set to `true`)

## Integration IDs

Entities may be linked to records in external practice management or accounting systems. Use `GET /api/v1/entities/{key}/integrations` to retrieve linked IDs such as:

* `xpmClientID` — XPM (Xero Practice Manager)
* `karbonClientID` — Karbon
* `fyiClientID` — FYI
* `qbClientID` — QuickBooks
* `freeAgentClientUrl` — FreeAgent

These IDs help you correlate OnboardMe clients with records in your own system.

## Addresses

Entity records can include physical and postal addresses. Each address has fields: `address1`, `address2`, `address3`, `address4`, `city`, `state`, `postcode`, `country`, and a pre-formatted `fullAddress` string.

## Assigned staff

Entity detail responses include optional fields for the staff assigned to the client:

* `partnerName` / `partnerKey`
* `managerName` / `managerKey`
* `inChargeName` / `inChargeKey`
* `officeName`, `groupName`

These can be used to map practice staff assignments to your own system. Retrieve staff user IDs with `GET /api/v1/users/list`.