Client Onboarding

Start onboarding for an existing company

Starts the onboarding checklist for a company that already exists, such as a long-time client being moved over or a new client signed in a meeting. Idempotent: returns the existing checklist when already started. Returns 409 when the company's onboarding came from the firm's website. Sends nothing to the client.

post/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

Response

{onboarding, created:false}

Changes

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