Account onboarding
The Account onboarding component uses the Accounts API to read requirements and generate an onboarding form that’s localized for all Stripe-supported countries and that validates data. In addition, Embedded onboarding handles all business types, various configurations of company representatives, document uploads, identity verification, and verification statuses. See Embedded onboarding for more information.
Requirements collection options
With embedded onboarding, you can control the collection of currently_due
or eventually_due
requirements, along with the inclusion of future requirements. You can customize this behavior by using the collectionOptions
attribute when integrating the account onboarding component.
External account collection
Use the external_account_collection feature to control whether the account onboarding component collects external account information. This parameter is enabled by default and can only be set to false for custom accounts. Note that when this option is enabled for custom accounts, user authentication will be required for certain embedded components like account onboarding.
Customize policies shown to your users
Stripe’s service agreement and Privacy Policy are surfaced to users in embedded onboarding. Users who have not accepted Stripe’s services agreement are asked to accept it on the final screen of onboarding. Embedded onboarding also has a footer with links to Stripe’s service agreement and Privacy Policy.
For Custom accounts, you have additional options to customize the experience, outlined below.
Handle service agreement acceptance on your own
If you’re a platform onboarding Custom accounts, you can collect Terms of Service acceptance using your own process instead of in our embedded account onboarding component. In that case, the final onboarding screen only asks your users to confirm the information they entered, and you must secure their acceptance of Stripe’s service agreement.
Embedded onboarding still has links to the terms of service (for example, in the footer) that you can choose to replace by surfacing your own policies.
Surfacing links to your agreements and privacy policy in embedded onboarding
Users see the Stripe service agreement and Privacy Policy throughout embedded onboarding. For your Custom accounts, you can replace those links with your own agreements and policy. To do so, follow these instructions to incorporate the Stripe services agreement and link to the Stripe Privacy Policy.
Creating an Account Session
When creating an Account Session, enable account management by specifying account_onboarding
in the components
parameter.
After creating the Account Session and initializing ConnectJS, you can render the Account onboarding component in the front end: