Stripe: Accounts schemas (part 2)

← Accounts operations · All schemas

Create an account — response body — requirements

Field	Type	Presence	Description and constraints
$	object	Root
alternatives	JSON	Optional
alternatives (anyOf 1)	array	Alternative	Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again.
alternatives (anyOf 1)[]	Model	Each item	Expand Create an account — response body — requirements alternatives array item
alternatives (anyOf 2)	null	Alternative
current_deadline	JSON	Optional
current_deadline (anyOf 1)	JSON	Alternative
current_deadline (anyOf 1) (anyOf 1)	integer	Alternative	Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. Format: unix-time
current_deadline (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_deadline (anyOf 2)	null	Alternative
currently_due	JSON	Optional
currently_due (anyOf 1)	array	Alternative	Fields that need to be resolved to keep the account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account will be disabled.
currently_due (anyOf 1)[]	string	Each item	Maximum length: 5000
currently_due (anyOf 2)	null	Alternative
disabled_reason	JSON	Optional
disabled_reason (anyOf 1)	string	Alternative	If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification). Known values: action_required.requested_capabilities, listed, other, platform_paused, rejected.fraud, rejected.incomplete_verification, rejected.listed, rejected.other, rejected.platform_fraud, rejected.platform_other, rejected.platform_terms_of_service, rejected.terms_of_service, requirements.past_due, requirements.pending_verification, under_review
disabled_reason (anyOf 2)	null	Alternative
errors	JSON	Optional
errors (anyOf 1)	array	Alternative	Fields that are `currently_due` and need to be collected again because validation or verification failed.
errors (anyOf 1)[]	Model	Each item	Expand Update an Account Capability — response body — requirements errors item
errors (anyOf 2)	null	Alternative
eventually_due	JSON	Optional
eventually_due (anyOf 1)	array	Alternative	Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
eventually_due (anyOf 1)[]	string	Each item	Maximum length: 5000
eventually_due (anyOf 2)	null	Alternative
past_due	JSON	Optional
past_due (anyOf 1)	array	Alternative	Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the account.
past_due (anyOf 1)[]	string	Each item	Maximum length: 5000
past_due (anyOf 2)	null	Alternative
pending_verification	JSON	Optional
pending_verification (anyOf 1)	array	Alternative	Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
pending_verification (anyOf 1)[]	string	Each item	Maximum length: 5000
pending_verification (anyOf 2)	null	Alternative

Referenced models: Create an account — response body — requirements alternatives array item, Update an Account Capability — response body — requirements errors item

Create an account — response body — requirements alternatives array item

Field	Type	Presence	Description and constraints
$	object	Root
alternative_fields_due	array	Required within parent	Fields that can be provided to resolve all fields in `original_fields_due`.
alternative_fields_due[]	string	Each item	Maximum length: 5000
original_fields_due	array	Required within parent	Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
original_fields_due[]	string	Each item	Maximum length: 5000

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury

Field	Type	Presence	Description and constraints
$	object	Root
bacs_debit_payments	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury bacs debit payments
branding	Model	Required within parent	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury branding
card_issuing	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury treasury
card_payments	Model	Required within parent	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury card payments
dashboard	Model	Required within parent	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury dashboard
invoices	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury invoices
payments	Model	Required within parent	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury payments
payouts	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury payouts
paypay_payments	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments
sepa_debit_payments	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury sepa debit payments
treasury	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury treasury

Referenced models: Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury bacs debit payments, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury branding, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury treasury, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury card payments, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury dashboard, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury invoices, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury payments, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury payouts, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury sepa debit payments

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury bacs debit payments

Field	Type	Presence	Description and constraints
$	object	Root
display_name	JSON	Optional
display_name (anyOf 1)	string	Alternative	The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free. Maximum length: 5000
display_name (anyOf 2)	null	Alternative
service_user_number	JSON	Optional
service_user_number (anyOf 1)	string	Alternative	The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners. Maximum length: 5000
service_user_number (anyOf 2)	null	Alternative

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury branding

Field	Type	Presence	Description and constraints
$	object	Root
icon	JSON	Optional
icon (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.
icon (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
icon (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
icon (anyOf 2)	null	Alternative
logo	JSON	Optional
logo (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
logo (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
logo (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
logo (anyOf 2)	null	Alternative
primary_color	JSON	Optional
primary_color (anyOf 1)	string	Alternative	A CSS hex color value representing the primary branding color for this account Maximum length: 5000
primary_color (anyOf 2)	null	Alternative
secondary_color	JSON	Optional
secondary_color (anyOf 1)	string	Alternative	A CSS hex color value representing the secondary branding color for this account Maximum length: 5000
secondary_color (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury card payments

Field	Type	Presence	Description and constraints
$	object	Root
decline_on	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury card payments decline on
statement_descriptor_prefix	JSON	Optional
statement_descriptor_prefix (anyOf 1)	string	Alternative	The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. Maximum length: 5000
statement_descriptor_prefix (anyOf 2)	null	Alternative
statement_descriptor_prefix_kana	JSON	Optional
statement_descriptor_prefix_kana (anyOf 1)	string	Alternative	The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. Maximum length: 5000
statement_descriptor_prefix_kana (anyOf 2)	null	Alternative
statement_descriptor_prefix_kanji	JSON	Optional
statement_descriptor_prefix_kanji (anyOf 1)	string	Alternative	The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. Maximum length: 5000
statement_descriptor_prefix_kanji (anyOf 2)	null	Alternative

Referenced models: Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury card payments decline on

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury card payments decline on

Field	Type	Presence	Description and constraints
$	object	Root
avs_failure	boolean	Required within parent	Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
cvc_failure	boolean	Required within parent	Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury dashboard

Field	Type	Presence	Description and constraints
$	object	Root
display_name	JSON	Optional
display_name (anyOf 1)	string	Alternative	The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. Maximum length: 5000
display_name (anyOf 2)	null	Alternative
timezone	JSON	Optional
timezone (anyOf 1)	string	Alternative	The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Maximum length: 5000
timezone (anyOf 2)	null	Alternative

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury invoices

Field	Type	Presence	Description and constraints
$	object	Root
default_account_tax_ids	JSON	Optional
default_account_tax_ids (anyOf 1)	array	Alternative	The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.
default_account_tax_ids (anyOf 1)[]	JSON	Each item
default_account_tax_ids (anyOf 1)[] (anyOf 1)	string	Alternative	Maximum length: 5000
default_account_tax_ids (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Create a tax ID — response body
default_account_tax_ids (anyOf 2)	null	Alternative
hosted_payment_method_save	JSON	Optional
hosted_payment_method_save (anyOf 1)	string	Alternative	Whether to save the payment method after a payment is completed for a one-time invoice or a subscription invoice when the customer already has a default payment method on the hosted invoice page. Known values: always, never, offer
hosted_payment_method_save (anyOf 2)	null	Alternative

Referenced models: Create a tax ID — response body

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury payments

Field	Type	Presence	Description and constraints
$	object	Root
statement_descriptor	JSON	Optional
statement_descriptor (anyOf 1)	string	Alternative	The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. Maximum length: 5000
statement_descriptor (anyOf 2)	null	Alternative
statement_descriptor_kana	JSON	Optional
statement_descriptor_kana (anyOf 1)	string	Alternative	The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). Maximum length: 5000
statement_descriptor_kana (anyOf 2)	null	Alternative
statement_descriptor_kanji	JSON	Optional
statement_descriptor_kanji (anyOf 1)	string	Alternative	The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). Maximum length: 5000
statement_descriptor_kanji (anyOf 2)	null	Alternative

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury payouts

Field	Type	Presence	Description and constraints
$	object	Root
debit_negative_balances	boolean	Required within parent	A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.
schedule	Model	Required within parent	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury payouts schedule
statement_descriptor	JSON	Optional
statement_descriptor (anyOf 1)	string	Alternative	The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. Maximum length: 5000
statement_descriptor (anyOf 2)	null	Alternative

Referenced models: Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury payouts schedule

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury payouts schedule

Field	Type	Presence	Description and constraints
$	object	Root
delay_days	JSON	Required within parent
delay_days (anyOf 1)	integer	Alternative	The number of days charges for the account will be held before being paid out.
delay_days (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
interval	string	Required within parent	How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. Maximum length: 5000
monthly_anchor	JSON	Optional
monthly_anchor (anyOf 1)	integer	Alternative	The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
monthly_anchor (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthly_payout_days	array	Optional	The days of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
monthly_payout_days[]	JSON	Each item
monthly_payout_days[] (anyOf 1)	integer	Alternative
monthly_payout_days[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
weekly_anchor	string	Optional	The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. Maximum length: 5000
weekly_payout_days	array	Optional	The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.
weekly_payout_days[]	string	Each item	Known values: friday, monday, thursday, tuesday, wednesday

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments

Field	Type	Presence	Description and constraints
$	object	Root
additional_files	array	Optional	Additional files that are required to support the onboarding process of your business.
additional_files[]	string	Each item	Maximum length: 5000
goods_type	string	Optional	The type of goods your business sells. Use `digital_content` if you sell digital content. Use `other` for all other types of goods or services. Known values: digital_content, other
site	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments site

Referenced models: Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments site

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments site

Field	Type	Presence	Description and constraints
$	object	Root
accessible	Model	Optional	Expand Create a Payment Method — response body — zip
in_development	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments site in development
restricted	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments site restricted
type	string	Optional	The status of your business's website. Known values: accessible, in_development, restricted

Referenced models: Create a Payment Method — response body — zip, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments site in development, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments site restricted

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments site in development

Field	Type	Presence	Description and constraints
$	object	Root
password_provided	boolean	Optional	Field to indicate that the website password has been provided.
username	JSON	Optional
username (anyOf 1)	string	Alternative	The username needed to access your business's website. Maximum length: 5000
username (anyOf 2)	null	Alternative

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury paypay payments site restricted

Field	Type	Presence	Description and constraints
$	object	Root
payment_flow_file	JSON	Optional
payment_flow_file (anyOf 1)	string	Alternative	File explaining the payment flow for your business. Maximum length: 5000
payment_flow_file (anyOf 2)	null	Alternative

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury sepa debit payments

Field	Type	Presence	Description and constraints
$	object	Root
creditor_id	string	Optional	SEPA creditor identifier that identifies the company making the payment. Maximum length: 5000

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury treasury

Field	Type	Presence	Description and constraints
$	object	Root
tos_acceptance	Model	Optional	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury treasury tos acceptance

Referenced models: Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury treasury tos acceptance

Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury treasury tos acceptance

Field	Type	Presence	Description and constraints
$	object	Root
date	JSON	Optional
date (anyOf 1)	JSON	Alternative
date (anyOf 1) (anyOf 1)	integer	Alternative	The Unix timestamp marking when the account representative accepted the service agreement.
date (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
date (anyOf 2)	null	Alternative
ip	JSON	Optional
ip (anyOf 1)	string	Alternative	The IP address from which the account representative accepted the service agreement. Maximum length: 5000
ip (anyOf 2)	null	Alternative
user_agent	string	Optional	The user agent of the browser from which the account representative accepted the service agreement. Maximum length: 5000

Create an account — response body — tos acceptance

Field	Type	Presence	Description and constraints
$	object	Root
date	JSON	Optional
date (anyOf 1)	JSON	Alternative
date (anyOf 1) (anyOf 1)	integer	Alternative	The Unix timestamp marking when the account representative accepted their service agreement Format: unix-time
date (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
date (anyOf 2)	null	Alternative
ip	JSON	Optional
ip (anyOf 1)	string	Alternative	The IP address from which the account representative accepted their service agreement Maximum length: 5000
ip (anyOf 2)	null	Alternative
service_agreement	string	Optional	The user's service agreement type Maximum length: 5000
user_agent	JSON	Optional
user_agent (anyOf 1)	string	Alternative	The user agent of the browser from which the account representative accepted their service agreement Maximum length: 5000
user_agent (anyOf 2)	null	Alternative

Create an external account — accounts post Accounts Account Bank Accounts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
bank_account	JSON	Optional	Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details.
bank_account (anyOf 1)	Model	Alternative	Expand Create an account — request body — body / bank_account / account_holder_type: company, individual, account type: checking, futsu, savings, toza, object: bank account
bank_account (anyOf 2)	string	Alternative	Maximum length: 5000
default_for_currency	boolean	Optional	When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
expand	array	Optional	Specifies which fields in the response should be expanded.
expand[]	string	Each item	Maximum length: 5000
external_account	string	Optional	A token, like the ones returned by [Stripe.js](https://docs.stripe.com/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead. Maximum length: 5000
metadata	object	Optional	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Additional keys: see wildcard field
metadata.*	string	Additional keys

Referenced models: Create an account — request body — body / bank_account / account_holder_type: company, individual, account type: checking, futsu, savings, toza, object: bank account

Delete a person — accounts delete Accounts Account People Person — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: person

Delete an account — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: account

Delete an external account — accounts delete Accounts Account Bank Accounts Id — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: bank account
$ (anyOf 2)	Model	Alternative	Expand Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: card

Referenced models: Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: bank account, Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: card

Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: bank account

Field	Type	Presence	Description and constraints
$	object	Root
currency	JSON	Optional
currency (anyOf 1)	string	Alternative	Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. Maximum length: 5000
currency (anyOf 2)	null	Alternative
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: bank_account

Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: card

Field	Type	Presence	Description and constraints
$	object	Root
currency	JSON	Optional
currency (anyOf 1)	string	Alternative	Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. Maximum length: 5000
currency (anyOf 2)	null	Alternative
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: card

List all persons — accounts get Accounts Account People — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
ending_before	string	Optional	Maximum length: 5000
expand	array	Optional
expand[]	string	Each item	Maximum length: 5000
limit	integer	Optional
relationship	object	Optional
relationship.authorizer	boolean	Optional
relationship.director	boolean	Optional
relationship.executive	boolean	Optional
relationship.legal_guardian	boolean	Optional
relationship.owner	boolean	Optional
relationship.representative	boolean	Optional
starting_after	string	Optional	Maximum length: 5000

Update an Account Capability — response body

Field	Type	Presence	Description and constraints
$	object	Root	This is an object representing a capability for a Stripe account. Related guide: [Account capabilities](https://docs.stripe.com/connect/account-capabilities)
account	JSON	Required within parent	The account for which the capability enables functionality.
account (anyOf 1)	string	Alternative	Maximum length: 5000
account (anyOf 2)	Model	Alternative	Expand Create an account — response body
future_requirements	Model	Optional	Expand Update an Account Capability — response body — future requirements
id	string	Required within parent	The identifier for the capability. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: capability
requested	boolean	Required within parent	Whether the capability has been requested.
requested_at	JSON	Optional
requested_at (anyOf 1)	JSON	Alternative
requested_at (anyOf 1) (anyOf 1)	integer	Alternative	Time at which the capability was requested. Measured in seconds since the Unix epoch. Format: unix-time
requested_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requested_at (anyOf 2)	null	Alternative
requirements	Model	Optional	Expand Update an Account Capability — response body — requirements
status	string	Required within parent	The status of the capability. Known values: active, inactive, pending, unrequested

Referenced models: Create an account — response body, Update an Account Capability — response body — future requirements, Update an Account Capability — response body — requirements

Update an Account Capability — response body — future requirements

Field	Type	Presence	Description and constraints
$	object	Root
alternatives	JSON	Optional
alternatives (anyOf 1)	array	Alternative	Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields.
alternatives (anyOf 1)[]	Model	Each item	Expand Create an account — response body — requirements alternatives array item
alternatives (anyOf 2)	null	Alternative
current_deadline	JSON	Optional
current_deadline (anyOf 1)	JSON	Alternative
current_deadline (anyOf 1) (anyOf 1)	integer	Alternative	Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning. Format: unix-time
current_deadline (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_deadline (anyOf 2)	null	Alternative
currently_due	array	Required within parent	Fields that need to be resolved to keep the capability enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
currently_due[]	string	Each item	Maximum length: 5000
disabled_reason	JSON	Optional
disabled_reason (anyOf 1)	string	Alternative	This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account. Known values: other, paused.inactivity, pending.onboarding, pending.review, platform_disabled, platform_paused, rejected.inactivity, rejected.other, rejected.unsupported_business, requirements.fields_needed
disabled_reason (anyOf 2)	null	Alternative
errors	array	Required within parent	Fields that are `currently_due` and need to be collected again because validation or verification failed.
errors[]	Model	Each item	Expand Update an Account Capability — response body — requirements errors item
eventually_due	array	Required within parent	Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
eventually_due[]	string	Each item	Maximum length: 5000
past_due	array	Required within parent	Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`.
past_due[]	string	Each item	Maximum length: 5000
pending_verification	array	Required within parent	Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
pending_verification[]	string	Each item	Maximum length: 5000

Referenced models: Create an account — response body — requirements alternatives array item, Update an Account Capability — response body — requirements errors item

Update an Account Capability — response body — requirements

Field	Type	Presence	Description and constraints
$	object	Root
alternatives	JSON	Optional
alternatives (anyOf 1)	array	Alternative	Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields.
alternatives (anyOf 1)[]	Model	Each item	Expand Create an account — response body — requirements alternatives array item
alternatives (anyOf 2)	null	Alternative
current_deadline	JSON	Optional
current_deadline (anyOf 1)	JSON	Alternative
current_deadline (anyOf 1) (anyOf 1)	integer	Alternative	The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested. Format: unix-time
current_deadline (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_deadline (anyOf 2)	null	Alternative
currently_due	array	Required within parent	Fields that need to be resolved to keep the capability enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the capability is disabled.
currently_due[]	string	Each item	Maximum length: 5000
disabled_reason	JSON	Optional
disabled_reason (anyOf 1)	string	Alternative	Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification). Known values: other, paused.inactivity, pending.onboarding, pending.review, platform_disabled, platform_paused, rejected.inactivity, rejected.other, rejected.unsupported_business, requirements.fields_needed
disabled_reason (anyOf 2)	null	Alternative
errors	array	Required within parent	Fields that are `currently_due` and need to be collected again because validation or verification failed.
errors[]	Model	Each item	Expand Update an Account Capability — response body — requirements errors item
eventually_due	array	Required within parent	Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
eventually_due[]	string	Each item	Maximum length: 5000
past_due	array	Required within parent	Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the capability on the account.
past_due[]	string	Each item	Maximum length: 5000
pending_verification	array	Required within parent	Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
pending_verification[]	string	Each item	Maximum length: 5000

Referenced models: Create an account — response body — requirements alternatives array item, Update an Account Capability — response body — requirements errors item

Update an Account Capability — response body — requirements errors item

Field	Type	Presence	Description and constraints
$	object	Root
code	string	Required within parent	The code for the type of error. Known values: external_request, information_missing, invalid_address_city_state_postal_code, invalid_address_cmra_address, invalid_address_highway_contract_box, invalid_address_private_mailbox, invalid_address_registered_agent_address, invalid_business_profile_name, invalid_business_profile_name_denylisted, invalid_company_name_denylisted, invalid_dob_age_over_maximum, invalid_dob_age_under_18, invalid_dob_age_under_minimum, invalid_product_description_length, invalid_product_description_url_match, invalid_representative_country, invalid_signator, invalid_statement_descriptor_business_mismatch, invalid_statement_descriptor_denylisted, invalid_statement_descriptor_length, invalid_statement_descriptor_prefix_denylisted, invalid_statement_descriptor_prefix_mismatch, invalid_street_address, invalid_tax_id, invalid_tax_id_format, invalid_tos_acceptance, invalid_url_denylisted, invalid_url_format, invalid_url_web_presence_detected, invalid_url_website_business_information_mismatch, invalid_url_website_empty, invalid_url_website_inaccessible, invalid_url_website_inaccessible_geoblocked, invalid_url_website_inaccessible_password_protected, invalid_url_website_incomplete, invalid_url_website_incomplete_cancellation_policy, invalid_url_website_incomplete_customer_service_details, invalid_url_website_incomplete_legal_restrictions, invalid_url_website_incomplete_refund_policy, invalid_url_website_incomplete_return_policy, invalid_url_website_incomplete_terms_and_conditions, invalid_url_website_incomplete_under_construction, invalid_url_website_other, invalid_value_other, unsupported_business_type, verification_directors_mismatch, verification_document_address_mismatch, verification_document_address_missing, verification_document_corrupt, verification_document_country_not_supported, verification_document_directors_mismatch, verification_document_dob_mismatch, verification_document_duplicate_type, verification_document_expired, verification_document_failed_copy, verification_document_failed_greyscale, verification_document_failed_other, verification_document_failed_test_mode, verification_document_fraudulent, verification_document_id_number_mismatch, verification_document_id_number_missing, verification_document_incomplete, verification_document_invalid, verification_document_issue_or_expiry_date_missing, verification_document_manipulated, verification_document_missing_back, verification_document_missing_front, verification_document_name_mismatch, verification_document_name_missing, verification_document_nationality_mismatch, verification_document_not_readable, verification_document_not_signed, verification_document_not_uploaded, verification_document_photo_mismatch, verification_document_too_large, verification_document_type_not_supported, verification_extraneous_directors, verification_failed_address_match, verification_failed_authorizer_authority, verification_failed_business_iec_number, verification_failed_document_match, verification_failed_id_number_match, verification_failed_keyed_identity, verification_failed_keyed_match, verification_failed_name_match, verification_failed_other, verification_failed_representative_authority, verification_failed_residential_address, verification_failed_tax_id_match, verification_failed_tax_id_not_issued, verification_legal_entity_structure_mismatch, verification_missing_directors, verification_missing_executives, verification_missing_owners, verification_rejected_ownership_exemption_reason, verification_requires_additional_memorandum_of_associations, verification_requires_additional_proof_of_registration, verification_supportability
reason	string	Required within parent	An informative message that indicates the error type and provides additional details about the error. Maximum length: 5000
requirement	string	Required within parent	The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. Maximum length: 5000