Prompts users to connect accounts and categorize transactions.
The onboarding component can be included on an accounting landing page to prompt users to connect accounts.
After connecting accounts, the component will change into a prompt to categorize transactions.
For a business that has already onboarded, this component will render nothing, so it’s safe to leave on the default page for all businesses.
By default, the onboarding component will infer the onboarding step by checking if the business has connected accounts.
If you want to override this behavior, you can set this parameter to 'connectAccount' or 'complete'.
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.
