onboarding · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: onboarding · React: <FinBazeOnboarding />

Create the session#

mutation {
  createEmbedSession(input: {
    companyId: "…"
    user: { externalUserId: "…" }
    components: { onboarding: { enabled: true } }
  }) { clientSecret }
}

Requirements#

No feature requirements.

Component features#

Switch these off per session with components.onboarding.features.

Feature	Default
`editCompany`	on
`taxSetup`	on
`filingConsent`	on

Options#

Passed to instance.create("onboarding", options) or as props.

Option	Type
`collect`	`"currently_due" \| "eventually_due"`	Which requirements to ask for.

Every component also takes appearance and navigation ("internal" or "external").

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`tax_authorisation.granted`	`onTaxAuthorisationGranted`
`onboarding.step_completed`	`onOnboardingStepCompleted`
`onboarding.completed`	`onOnboardingCompleted`

Use it#

import { FinBazeOnboarding } from "@finbaze/embed-react";

<FinBazeOnboarding />

const component = instance.create("onboarding");
component.mount("#finbaze");