---
title: "Send the client their onboarding link"
method: POST
path: "/companies/{companyId}/onboarding/send"
tags: ["Client Onboarding"]
---

# Send the client their onboarding link

`POST /companies/{companyId}/onboarding/send`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/companies/{companyId}/onboarding/send`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

Opens a 30-day client link showing only what the client still has to do: sign the engagement letter, complete the pay link, or both. Emails it to the client contact unless sendEmail is false, and returns the URL either way. Returns 409 when neither e-signature nor a pay link is outstanding, when no engagement letter is published, or when Stripe is not connected. Requires explicit user intent.

## Path parameters

- `companyId` string, uuid, required

## Request body

- object
  - `sendEmail` boolean: False returns the link without emailing it

## Response `200`

{url, onboarding}

## Other responses

- `409`: Nothing needs the client, or setup is missing
- `default`: Error response

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/9a8269f0a586?raw)