Client Onboarding

Send the client their onboarding link

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.

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

Path parameters

companyIdstring uuid required

LedgerHQ company UUID

Request body

sendEmailboolean

False returns the link without emailing it

Response

{url, onboarding}

Changes

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