> ## 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.

# Create and track onboarding jobs

> Create a client onboarding, send or save as draft, track recipients, and download required documents.

An onboarding job collects details, documents, and optional ID checks from one recipient on behalf of one or more clients.

## List and get

`GET /api/v1/onboardings/list` supports `statusID`, `searchFilter`, `userID`, `lastUpdated`, `excludeCompleted`, and `pageNumber`.

`GET /api/v1/onboardings/{key}` returns the full job.

## Create

`POST /api/v1/onboardings/create` needs write access, a `userKey`, a `recipient`, and one or more `clients`.

* `sendToRecipient: true` sends immediately. Wallet and subscription are checked **before** persist. Insufficient funds return **400** and nothing is created.
* `sendToRecipient: false` saves a draft.

Each client row is either an existing `entityKey` or a quick-add (type + name).

## Documents

| Route                                                          | Returns                                               |
| -------------------------------------------------------------- | ----------------------------------------------------- |
| `GET /api/v1/onboardings/{key}/documents`                      | Requirements per client (`isUploaded` / `isBypassed`) |
| `GET .../entities/{entityOnboardingId}/documents/{documentId}` | Short-lived signed URL for one file                   |
| `GET .../entities/{entityOnboardingId}/documents/zip`          | All uploaded files as a zip                           |