Client Onboarding

Update a company's onboarding checklist

One action per call. details updates the client name and contact. agreement chooses esign (send the firm's engagement letter for signature), uploaded (use a signed letter already on the company), or not_needed. billing chooses checkout (a pay link that charges the first month plus any setup fee and starts a monthly subscription), linked_stripe (an existing Stripe subscription linked on the company), outside (billed outside LedgerHQ), or none. Billing cannot change once the client opened or paid the pay link, and checkout is refused while a linked subscription exists, so a company is never billed twice. mark marks a step done or not needed; undo reopens a hand-marked step. finish completes the onboarding; abandon closes it.

patch/companies/{companyId}/onboarding

Request

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

Path parameters

companyIdstring uuid required

LedgerHQ company UUID

Request body

OR
OR
OR
OR
OR
OR

Response

{onboarding}

Changes

No recorded changes to this operation across all 5 revisions of this API.