Sign in
An image of the Stripe logo
Create account
Sign in
Home
Payments
Business operations
Financial services
Developer tools
No-code
All products
Home
Payments
Business operations
Home
Payments
Business operations
Financial services
Developer tools
Support
Overview
Online payments
Products and prices
Invoicing
Subscriptions
Quotes
In-person payments
Multiparty payments
    Overview
    Get started
    Collect payments then pay out
    Enable other businesses to accept payments directly
    Pay out money
    Explore Connect
    Onboard your accounts
    Choose your account type
    Standard
    Express
    Custom
    Service agreement types
    Payment methods
    Account capabilities
    Additional verifications
    Update verified info
    Connect embedded UIs
    Quickstart
    Get started with Connect embedded UIs
    Accept payments
    Create a charge
    Create a payments page
    Create payment links with Connect
    Connect integration guide
    Automatic payment methods
    Set statement descriptors
    Connect platforms using the Payment Methods API
    Create subscriptions
    Create invoices
    Debit Express and Custom connected accounts
    Pay out
    Set bank and debit card payouts
    Bank accounts
    Manage payout schedule
    Manual payouts
    Payout reversals
    Instant Payouts
    Cross-border payouts
    Crypto payouts
    Manage funds
    Add money to your platform balance
    Account balance
    Handle multiple currencies
    Manage accounts
    Best practices
    Listen for updates
    Dashboard account management
    Understanding risk offerings
    Platform controls for Standard accounts
    Make API calls for connected accounts
    Set MCCs
    Testing
    Manage tax forms
    Overview
    Get started with tax reporting
    1099 Tax Support and Communication Guide
    Tax form settings
    Calculation methods
    File tax forms
    File tax forms with states
    Identify forms with missing information
    Update tax forms
    Deliver tax forms
    E-delivery for 1099 tax forms
    Correct tax forms
    Split tax forms
    Tax year changeover
    What's new for tax year 2022
After the payment
Add payment methods
Payment Links
Stripe Checkout
Stripe Elements
About the APIs
Regulation support
Implementation guides
Testing
Connect
·
HomePaymentsMultiparty payments

Using Connect with Standard accounts

Integrate with Standard accounts to get started using Connect right away, and let Stripe handle the majority of the user experience and user communication.

Connect Onboarding

This is the recommended method for creating standard accounts. If you’re an extension or an application that needs access to an existing account so you can provide services to your users, you can still use OAuth.

A Standard Stripe account is a conventional Stripe account where the account holder (that is, your platform’s user) has a relationship with Stripe, is able to log in to the Dashboard, and can process charges on their own.

Stripe’s sample integration, Kavholm, shows you how to use Connect Onboarding for a seamless user onboarding experience.

Screenshot of Connect Onboarding form

Get started

If you’re new to Connect, start with a guide to use Standard accounts to enable other businesses to accept payments directly.

How to use Connect Onboarding for Standard accounts

  1. Go to your Connect settings page to customize the visual appearance of the form with the name, color, and icon of your brand. Connect Onboarding requires this information.

  2. Use the /v1/accounts API to create a new account and get the account ID. You can prefill information on the account object for the user before you generate the account link. You must pass the following parameter:

    • type = standard

    After you’ve created the new account, check to see that the account displays in the Dashboard.

  3. Call the Account Links API to create a link for the account to onboard with.

  4. In the onboarding flow for your own platform, redirect your user to the url returned by Account Links.

  5. Handle additional account states, redirecting your user to the Connect Onboarding flow if necessary.

Create a Standard account and prefill information

Use the /v1/accounts API to create a Standard account and set type to standard in the account creation request.

Command Line
curl https://api.stripe.com/v1/accounts \ -u
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \ -d type=standard

If you’ve already collected information for your connected accounts, you can pre-fill that information on the account object for the user. Connect Onboarding won’t ask for the pre-filled information during account onboarding. The account holder confirms the pre-filled information before accepting the Connect service agreement. You can pre-fill any information on the account, including personal and business information, external account information, and more.

Create an account link

You can create an account link by calling the Account Links API with the following parameters:

  • account - use the account ID returned by the API from the previous step
  • refresh_url
  • return_url
  • type = account_onboarding
Command Line
curl https://api.stripe.com/v1/account_links \ -u
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \ -d account=
{{CONNECTED_ACCOUNT_ID}}
\ -d refresh_url="https://example.com/reauth" \ -d return_url="https://example.com/return" \ -d type=account_onboarding

Redirect your user to the account link URL

The response to your Account Links request includes a value for the key url. Redirect to this link to send your user into the flow. You can only use URLs from the Account Links once because they grant access to the account holder’s personal information. Authenticate the user in your application before redirecting them to this URL. If you want to prefill information, you must do so before generating the account link. After you create the account link for a Standard account, you won’t be able to read or write information for the account.

Don’t email, text, or otherwise send account link URLs directly to your user. Instead, redirect the authenticated user to the account link URL from within your platform’s application.

Handle the user returning to your platform

Connect Onboarding requires you to pass both a return_url and refresh_url to handle all cases where you redirect the user to your platform. It’s important that you implement these correctly to provide the best experience for your user.

You can use HTTP for your return_url and refresh_url while in test mode (for example, to test with localhost), but you can only use HTTPS in live mode. Be sure to swap testing URLs for HTTPS URLs before going live.

return_url

Stripe issues a redirect to this URL when the user completes the Connect Onboarding flow. This doesn’t mean that all information has been collected or that there are no outstanding requirements on the account. This only means the flow was entered and exited properly.

No state is passed through this URL. After redirecting a user to your return_url, check the state of the details_submitted parameter on their account by doing either of the following:

  • Listening to account.updated webhooks
  • Calling the Accounts API and inspecting the returned object

refresh_url

Your user redirects to the refresh_url in these cases:

  • The link expired (a few minutes went by since the link was created)
  • The user already visited the link (they refreshed the page, or clicked back or forward in the browser)
  • Your platform is no longer able to access the account
  • The account has been rejected

Your refresh_url triggers a method on your server to call Account Links again with the same parameters, and redirect the user to the Connect Onboarding flow to create a seamless experience.

Handle users that have not completed onboarding

A user that is redirected to your return_url might not have completed the onboarding process. Use the /v1/accounts endpoint to retrieve the user’s account and check for charges_enabled. If the account isn’t fully onboarded, provide UI prompts to allow the user to continue onboarding later. The user can complete their account activation through a new account link (generated by your integration). You can check the state of the details_submitted parameter on their account to see if they’ve completed the onboarding process.

See also

  • Creating charges
  • Authentication
  • OAuth reference
Was this page helpful?
Questions? Contact us.
Watch our developer tutorials.
Check out our product changelog.
Powered by Markdoc
You can unsubscribe at any time. Read our privacy policy.
On this page
Get started
How to use Connect Onboarding for Standard accounts
Create a Standard account and prefill information
Create an account link
Redirect your user to the account link URL
Handle the user returning to your platform
Handle users that have not completed onboarding
See also
Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Login to your Stripe account and press Control + Backtick on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g. )
The Stripe Shell is best experienced on desktop.
$