Track connected account onboarding status
Monitor the status of connected accounts during the onboarding process.
A connected account’s onboarding status depends on its requested capabilities and the requirements needed to enable them. Because verifying requirements can take time, you need to track a connected account’s status to know when its capabilities become active.
Understand the connected account onboarding process
The onboarding and tracking process follows these steps:
- Create the Account object and send the connected account to your onboarding flow .
- When the connected account user exits the flow, check the status of the Account ’s capabilities in your Dashboard or using the API:
- [Find the connected account in your Dashboard](/the relevant part of the product) .
- Use the API to set up an event destination that listens for Account update events and checks an updated Account ’s capabilities.
- If any capabilities aren’t active, take one of the following actions:
- If you use Stripe-hosted or embedded onboarding, send the connected account back to the onboarding flow.
- If you use API-based onboarding for any outstanding requirements or related errors, address them .
- Check the connected account’s status again.
- If any outstanding requirements or errors remain, repeat the process of taking action and checking the connected account’s status.
Track a connected account’s onboarding status
Dashboard
API
To check the onboarding status of connected accounts, review the Connected accounts page in your Dashboard. If a connected account has any requested capabilities that aren’t active, it displays a Restricted badge. You can filter the view to restricted accounts by clicking the Restricted tab.
Click an account to open its details page. If it has any actionable open requirements, they appear in an Actions required section at the top of the page.
Partially restricted connected accounts
A connected account can display Restricted even if it’s actively taking payments and receiving payouts. For example, an account has fulfilled the requirements to activate card payments and payouts, but has outstanding requirements to activate a requested local payment method. You decide whether to consider onboarding complete for that account.