Breaking changes

Formats requirements for key persons associated with accounts Breaking changes

What’s new

The requirements hash on the Account and Capability objects, and the verification_fields hash on the Country Spec object have newly formatted strings for requirements that are related to key persons associated with an account:

• Fields that are required for persons with representative , owner , director , and executive roles will be prefixed with representative , owners , directors , and executives , respectively. Person requirements are previewed as follows:
• When the representative’s phone number is required, it appears as representative. phone instead of relationship. representative .
• When an owner’s full name is required, it appears as owners. first _ name and owners. last _ name instead of relationship. owner .
• When an executive’s ID number is required, it appears as executives. id _ number instead of relationship. executive .
• When a director’s date of birth is required, it appears as directors. dob. day , directors. dob. month , and directors. dob. year instead of relationship. director .
• The boolean values that indicate the associated owners, executives, or directors now appear as company. owners _ provided , company. executives _ provided , or company. directors _ provided instead of relationship. owner , relationship. executive , or relationship. director , respectively.

Impact

The new formatting of the requirements and verification_fields hashes creates a more intuitive naming convention, making it easier for you to identify and address the specific information needed for each person role.

Upgrade

1. View your current API version in Workbench.
2. If you use an SDK, upgrade to the corresponding SDK version for this API version.

• If you don’t use an SDK, update your API requests to include Stripe-Version: 2020-08-27

3. Upgrade the API version used for webhook endpoints .
4. Test your integration against the new version.
5. If you use Connect, test your Connect integration .
6. In Workbench, perform the upgrade . You can roll back the version for 72 hours.

Learn more about Stripe API upgrades.