Onboarding component which walks users through connecting business accounts.
The Link Accounts component is intended to be used during onboarding into an accounting experience, regardless of whether the business is additionally enrolling in bookkeeping services or not.
It will prompt users to connect all their business accounts in sequence and prompt them to confirm whether any accounts are personal and should be excluded.This component is automatically included in the Onboarding component flow, but is available to be embedded standalone here as well.
Users will be first prompted to connect their bank.
After connecting accounts, the component will show cards for each transaction as well as loading progress.
Users will be prompted to confirm which accounts are used by their business.
Configuration for using Plaid Hosted Link instead of the embedded Plaid modal. When provided, account linking opens a Plaid-owned page in the browser rather than displaying an embedded modal.
Set to true when the user will open the hosted link in an ASWebAuthenticationSession (iOS) or Android Custom Tab. This tells Plaid to use the correct redirect handling for mobile contexts.
Universal Link (iOS) or App Link (Android) that opens your app. Used when Plaid redirects from a third-party OAuth app (e.g., a bank’s app) back to your app during app-to-app authentication.
URI to redirect to after the user completes the Plaid hosted link flow (e.g., myapp://plaid-complete). Recommended for mobile apps to automatically close the hosted link session and return to your app. If not provided, the user sees a “Return to app” message and must navigate back manually.
Callback function that navigates the user to the Plaid Hosted Link URL. This function receives the Plaid-owned URL and should open it in the device’s browser or an in-app browser. Required for all hosted link configurations.
