Account management

Show account details and allow them to be edited.

Account management renders a UI component for connected accounts to view and proactively edit their account details. Connected accounts can view and edit account information such as personal or business information, public information, and bank accounts they use for payouts.

Account management isn’t optimized for collecting missing account information. For that use case, consider using account onboarding or the notification banner.

Requirements collection options

When a connected account has outstanding requirements, account management prompts them to update their information. It always collects currently_due requirements, and you can use the collectionOptions attribute to also request any of the following:

• eventually _ due requirements
• Future requirements
• Granular requirement restrictions

Requirement restrictions

When you specify collection options, you can configure granular requirement restrictions as only or exclude. Both options accept an array of strings representing required properties as they appear in requirements.entries[].description for v2 Accounts and the various requirement arrays for v1 Accounts. For details about which requirements apply to your connected accounts, see Required verification information.

Think of the options as filters, where exclude filters out matching account requirements, and only acts as an intersection between the account requirements and the specified values. They also support wildcard matching using * and relationship prefixes.

For example, if you have a connected account with several owners, you can collect the address information for all owners by specifying only: ["owners.address.*"].

A person can have multiple relationships associated to them, and relationships can be assigned to multiple persons. Therefore, when you use relationship prefixes, they apply to all persons on the account with the specified relationship. This is especially useful in situations where you don’t know a specific person’s ID, but do know their relationship.

Important considerations:

• Accounts still need to satisfy all KYC requirements in order to have capabilities enabled. The exclude option doesn’t remove a requirement, it only prevents collection at the time. The information must still be collected.
• These restrictions only apply within embedded components. They don’t affect accounts using other types of dashboards.
• The purpose of this feature is to improve the process, not to prevent accounts from accessing information.

only requirement restriction

This option scopes collection to the set of specified requirements that are also outstanding on the account. It’s most commonly used to build a remediation process, and you can use it for requirements that require some form of document upload or identity verification.

This option prevents account onboarding from presenting the standard final summary step. If all of the specified requirements have been provided, the account onboarding component exits immediately.

exclude requirement restriction

This option hides the specified fields, which prevents a connected account from providing or editing that information. It only hides fields from the component; it doesn’t remove information requirements. This option is useful when you want to prefill information that you don’t want the connected account to access during onboarding.

For Express accounts, if you want to exclude the business_type requirement (such as to prevent an account from changing their business type), the account country and capabilities must be set.

Displayed fields

The fields that the account management component displays depend on how you configured the connected account—specifically on the connected account country, business type, capabilities and service agreement type. This works similarly to how the onboarding component only collects the information that’s required for how the connected account is configured.

External account collection

Use the external_account_collection feature to control whether the component collects external account information. This parameter is enabled by default. When external_account_collection is enabled, user authentication is required. You can opt out of Stripe user authentication with the disable_stripe_user_authentication parameter.

Disable Stripe user authentication

Use the disable_stripe_user_authentication feature to control whether the component requires Stripe user authentication.

• By default, disable _ stripe _ user _ authentication is the opposite of the external_account_collection value.

• If you leave external _ account _ collection unset, it defaults to true, so disable _ stripe _ user _ authentication defaults to false.

• When controller. requirement _ collection is stripe , both values default to false.

This value can only be true for accounts where controller.requirement_collection is application.

We recommend implementing 2FA or equivalent security measures as a best practice. For account configurations that support this feature, such as Custom accounts, you assume liability for connected accounts if they can’t pay back negative balances.

Create an Account Session

When creating an Account Session, enable account management by specifying account_management in the components parameter.

Command Line

Select a language

cURL

Stripe CLI

Ruby

Python

PHP

Java

Node.js

Go

.NET

No results

Render the account management component

account-management.js

Select a language

JavaScript

React

No results

// Include this element in your HTML
const accountManagement = stripeConnectInstance.create('account-management');
container.appendChild(accountManagement);

// Optional:
// accountManagement.setCollectionOptions({
// fields: 'eventually_due',
// futureRequirements: 'include',
// })

The SectionOpenEvent object

The SectionOpenEvent type is defined in connect.js. Every time the connected account opens a section in account management, the section open handler receives a SectionOpenEvent object with the following property:

Section restrictions

• The SectionOpenEvent object is only for analytics.
• The event fires only when the connected account opens a section. If the connected account navigates between different views within the same section without closing it, no additional event fires.
• The list of valid sectionName values can change at any time, without notice. New values can be added and existing values can be removed.

Section names

Each section in account management has one of the following section names.