@get-asset/react

AssetOnboarding

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

Bookkeeping

1/4

How would you like to manage your bookkeeping?

Choose how hands-on you want to be. You can change this later.

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).

Bookkeeping

1/4

How would you like to manage your bookkeeping?

Choose how hands-on you want to be. You can change this later.

Company details

2/4

Tell us about your business

These help us organize your finances and reports the way your business works.

Company name *Filing type *Industry *

Financial year start *

Calendar year (January 1)Runs from January 1 to December 31. This is the most common choice for small businesses.

Set a custom start date

Start date

3/4

How far back should we go?

We'll pull in and organize your transactions from this date forward. Most owners start at the beginning of their current financial year.

Start of this financial yearRecommendedFrom Jan 2026 · about 6 months of history

Start of last financial yearFrom Jan 2025 · about 18 months of history

A specific dateGo further back if you have older transactions to bring in.

Connect accountsStep 4 — connect against the created business.

Bank accounts

4/4

Link your business bank accounts

This lets us bring in your transactions automatically, so your finances stay current without manual entry.