@get-asset/react

Onboarding

A self-contained business-onboarding wizard. It walks the operator through a bookkeeping plan, company details and a books start date, creates the business via the Asset API, then on the final step a single “Link With Plaid” card connects accounts (linked as business, no personal/business step) and shows them grouped by institution, read-only. Configure the available plans — pass a single plan and the bookkeeping step is skipped and that plan submitted automatically. Mount it under one AssetProvider with businessId omitted; once the business is created the wizard calls setBusinessId, and the provider re-provisions a business-scoped token for the connect step.

Built on the headless Onboarding compound from @get-asset/sdk.

Preview

Loading preview…

Required scopes

The access token used by AssetProvider must include these scopes for this primitive to fetch data successfully:

business:create
plaid:create
plaid:read
ledger:read

API reference

Root props

Prop	Type	Default	Description
`externalId`	`string`	—	Your stable identifier stored against the created business. Required.
`plans`	`BusinessPlan[]`	—	Plans offered on the bookkeeping step. Defaults to ["diy", "managed"]. One entry skips the step.
`entityTypes`	`BusinessEntityType[]`	—	Override the filing types offered.
`industries`	`string[]`	—	Override the industries offered.
`defaultValues`	`OnboardingDefaults`	—	Pre-populate any form field. Each value seeds the field's initial state and stays editable.
`status`	`BusinessStatus`	—	Initial business status, forwarded to the create request.
`onCreated`	`(business) => void`	—	Called once the business is created, before the connect step shows.
`onComplete`	`(business, reason: "finished" \| "skipped") => void`	—	Called when the user finishes on the last step. reason distinguishes Finish up ("finished") from Skip for now ("skipped").
`onConnected`	`(institutions, account) => void`	—	Called after bank accounts are linked on the connect step.
`onError`	`(error) => void`	—	Called if creating the business fails.
`className`	`string`	—	Forwarded to the wizard container.

States

PlanStep 1 — choose a bookkeeping plan (omitted when one plan).

Loading preview…

Company details

Loading preview…

Start date

Loading preview…

Connect accountsStep 4 — connect against the created business.

Loading preview…