Skip to content

Stripe: Accounts schemas (part 1)

44 Stripe schemas with complete fields and constraints.

← Accounts operations · All schemas

Create a login link — response body

FieldTypePresenceDescription and constraints
$objectRootLogin Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.
A Login Link differs from an [Account Link](https://docs.stripe.com/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link)
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: login_link
urlstringRequired within parentThe URL for the login link.
Maximum length: 5000

Create a person — accounts post Accounts Account People — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
additional_tos_acceptancesobjectOptionalDetails on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
additional_tos_acceptances.accountobjectOptional
additional_tos_acceptances.account.dateintegerOptionalFormat: unix-time
additional_tos_acceptances.account.ipstringOptional
additional_tos_acceptances.account.user_agentJSONOptional
additional_tos_acceptances.account.user_agent (anyOf 1)stringAlternativeMaximum length: 5000
additional_tos_acceptances.account.user_agent (anyOf 2)stringAlternativeOne of:
addressobjectOptionalThe person's address.
address.citystringOptionalMaximum length: 100
address.countrystringOptionalMaximum length: 5000
address.line1stringOptionalMaximum length: 200
address.line2stringOptionalMaximum length: 200
address.postal_codestringOptionalMaximum length: 5000
address.statestringOptionalMaximum length: 5000
address_kanaobjectOptionalThe Kana variation of the person's address (Japan only).
address_kana.citystringOptionalMaximum length: 5000
address_kana.countrystringOptionalMaximum length: 5000
address_kana.line1stringOptionalMaximum length: 5000
address_kana.line2stringOptionalMaximum length: 5000
address_kana.postal_codestringOptionalMaximum length: 5000
address_kana.statestringOptionalMaximum length: 5000
address_kana.townstringOptionalMaximum length: 5000
address_kanjiobjectOptionalThe Kanji variation of the person's address (Japan only).
address_kanji.citystringOptionalMaximum length: 5000
address_kanji.countrystringOptionalMaximum length: 5000
address_kanji.line1stringOptionalMaximum length: 5000
address_kanji.line2stringOptionalMaximum length: 5000
address_kanji.postal_codestringOptionalMaximum length: 5000
address_kanji.statestringOptionalMaximum length: 5000
address_kanji.townstringOptionalMaximum length: 5000
dobJSONOptionalThe person's date of birth.
dob (anyOf 1)objectAlternative
dob (anyOf 1).dayintegerRequired within parent
dob (anyOf 1).monthintegerRequired within parent
dob (anyOf 1).yearintegerRequired within parent
dob (anyOf 2)stringAlternativeOne of:
documentsModelOptionalExpand Create a person — accounts post Accounts Account People — request body — body documents
emailstringOptionalThe person's email address.
expandarrayOptionalSpecifies which fields in the response should be expanded.
expand[]stringEach itemMaximum length: 5000
first_namestringOptionalThe person's first name.
Maximum length: 5000
first_name_kanastringOptionalThe Kana variation of the person's first name (Japan only).
Maximum length: 5000
first_name_kanjistringOptionalThe Kanji variation of the person's first name (Japan only).
Maximum length: 5000
full_name_aliasesJSONOptionalA list of alternate names or aliases that the person is known by.
full_name_aliases (anyOf 1)arrayAlternative
full_name_aliases (anyOf 1)[]stringEach itemMaximum length: 5000
full_name_aliases (anyOf 2)stringAlternativeOne of:
genderstringOptionalThe person's gender (International regulations require either "male" or "female").
id_numberstringOptionalThe person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).

Changing this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
Maximum length: 5000
id_number_secondarystringOptionalThe person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).

Changing this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
Maximum length: 5000
last_namestringOptionalThe person's last name.
Maximum length: 5000
last_name_kanastringOptionalThe Kana variation of the person's last name (Japan only).
Maximum length: 5000
last_name_kanjistringOptionalThe Kanji variation of the person's last name (Japan only).
Maximum length: 5000
maiden_namestringOptionalThe person's maiden name.
Maximum length: 5000
metadataJSONOptionalSet 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`.
metadata (anyOf 1)objectAlternativeAdditional keys: see wildcard field
metadata (anyOf 1).*stringAdditional keys
metadata (anyOf 2)stringAlternativeOne of:
nationalitystringOptionalThe country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
Maximum length: 5000
person_tokenstringOptionalA [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.
Maximum length: 5000
phonestringOptionalThe person's phone number.
political_exposurestringOptionalIndicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
One of: existing, none
registered_addressobjectOptionalThe person's registered address.
registered_address.citystringOptionalMaximum length: 100
registered_address.countrystringOptionalMaximum length: 5000
registered_address.line1stringOptionalMaximum length: 200
registered_address.line2stringOptionalMaximum length: 200
registered_address.postal_codestringOptionalMaximum length: 5000
registered_address.statestringOptionalMaximum length: 5000
relationshipobjectOptionalThe relationship that this person has with the account's legal entity.
relationship.authorizerbooleanOptional
relationship.directorbooleanOptional
relationship.executivebooleanOptional
relationship.legal_guardianbooleanOptional
relationship.ownerbooleanOptional
relationship.percent_ownershipJSONOptional
relationship.percent_ownership (anyOf 1)numberAlternative
relationship.percent_ownership (anyOf 2)stringAlternativeOne of:
relationship.representativebooleanOptional
relationship.titlestringOptionalMaximum length: 5000
ssn_last_4stringOptionalThe last four digits of the person's Social Security number (U.S. only).

Changing this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
us_cfpb_dataModelOptionalExpand Create a person — accounts post Accounts Account People — request body — body us cfpb data
verificationobjectOptionalThe person's verification status.
verification.additional_documentobjectOptional
verification.additional_document.backstringOptionalMaximum length: 500
verification.additional_document.frontstringOptionalMaximum length: 500
verification.documentobjectOptional
verification.document.backstringOptionalMaximum length: 500
verification.document.frontstringOptionalMaximum length: 500

Referenced models: Create a person — accounts post Accounts Account People — request body — body documents, Create a person — accounts post Accounts Account People — request body — body us cfpb data

Create a person — accounts post Accounts Account People — request body — body documents

FieldTypePresenceDescription and constraints
$objectRootDocuments that may be submitted to satisfy various informational requests.
company_authorizationobjectOptional
company_authorization.filesarrayOptional
company_authorization.files[]JSONEach item
company_authorization.files[] (anyOf 1)stringAlternativeMaximum length: 500
company_authorization.files[] (anyOf 2)stringAlternativeOne of:
passportobjectOptional
passport.filesarrayOptional
passport.files[]JSONEach item
passport.files[] (anyOf 1)stringAlternativeMaximum length: 500
passport.files[] (anyOf 2)stringAlternativeOne of:
visaobjectOptional
visa.filesarrayOptional
visa.files[]JSONEach item
visa.files[] (anyOf 1)stringAlternativeMaximum length: 500
visa.files[] (anyOf 2)stringAlternativeOne of:

Create a person — accounts post Accounts Account People — request body — body us cfpb data

FieldTypePresenceDescription and constraints
$objectRootDemographic data related to the person.
ethnicity_detailsobjectOptional
ethnicity_details.ethnicityarrayOptional
ethnicity_details.ethnicity[]stringEach itemOne of: cuban, hispanic_or_latino, mexican, not_hispanic_or_latino, other_hispanic_or_latino, prefer_not_to_answer, puerto_rican
ethnicity_details.ethnicity_otherstringOptionalMaximum length: 5000
race_detailsModelOptionalExpand Create a person — accounts post Accounts Account People — request body — body us cfpb data race details
self_identified_genderstringOptionalMaximum length: 5000

Referenced models: Create a person — accounts post Accounts Account People — request body — body us cfpb data race details

Create a person — accounts post Accounts Account People — request body — body us cfpb data race details

FieldTypePresenceDescription and constraints
$objectRoot
racearrayOptional
race[]stringEach itemOne of: african_american, american_indian_or_alaska_native, asian, asian_indian, black_or_african_american, chinese, ethiopian, filipino, guamanian_or_chamorro, haitian, jamaican, japanese, korean, native_hawaiian, native_hawaiian_or_other_pacific_islander, nigerian, other_asian, other_black_or_african_american, other_pacific_islander, prefer_not_to_answer, samoan, somali, vietnamese, white
race_otherstringOptionalMaximum length: 5000

Create a person — accounts post Accounts Account People — response body

FieldTypePresenceDescription and constraints
$objectRootThis is an object representing a person associated with a Stripe account.

A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.

See the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).
accountstringRequired within parentThe account the person is associated with.
Maximum length: 5000
additional_tos_acceptancesModelOptionalExpand Create a person — accounts post Accounts Account People — response body — additional tos acceptances
addressModelOptionalExpand Create a Location — response body — address
address_kanaJSONOptional
address_kana (anyOf 1)JSONAlternative
address_kana (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Location — response body — address kana
address_kana (anyOf 2)nullAlternative
address_kanjiJSONOptional
address_kanji (anyOf 1)JSONAlternative
address_kanji (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Location — response body — address kana
address_kanji (anyOf 2)nullAlternative
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dobModelOptionalExpand Create a person — accounts post Accounts Account People — response body — dob
emailJSONOptional
email (anyOf 1)stringAlternativeThe person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
email (anyOf 2)nullAlternative
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeThe person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
first_name (anyOf 2)nullAlternative
first_name_kanaJSONOptional
first_name_kana (anyOf 1)stringAlternativeThe Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
first_name_kana (anyOf 2)nullAlternative
first_name_kanjiJSONOptional
first_name_kanji (anyOf 1)stringAlternativeThe Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
first_name_kanji (anyOf 2)nullAlternative
full_name_aliasesarrayOptionalA list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
full_name_aliases[]stringEach itemMaximum length: 5000
future_requirementsJSONOptional
future_requirements (anyOf 1)JSONAlternative
future_requirements (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a person — accounts post Accounts Account People — response body — future requirements value alternatives, currently due, errors, eventually due, past due, pending verification
future_requirements (anyOf 2)nullAlternative
genderJSONOptional
gender (anyOf 1)stringAlternativeThe person's gender.
gender (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
id_number_providedbooleanOptionalWhether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`).
id_number_secondary_providedbooleanOptionalWhether the person's `id_number_secondary` was provided.
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeThe person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
last_name (anyOf 2)nullAlternative
last_name_kanaJSONOptional
last_name_kana (anyOf 1)stringAlternativeThe Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
last_name_kana (anyOf 2)nullAlternative
last_name_kanjiJSONOptional
last_name_kanji (anyOf 1)stringAlternativeThe Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
last_name_kanji (anyOf 2)nullAlternative
maiden_nameJSONOptional
maiden_name (anyOf 1)stringAlternativeThe person's maiden name.
Maximum length: 5000
maiden_name (anyOf 2)nullAlternative
metadataobjectOptionalSet 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.
Additional keys: see wildcard field
metadata.*stringAdditional keysMaximum length: 500
nationalityJSONOptional
nationality (anyOf 1)stringAlternativeThe country where the person is a national.
Maximum length: 5000
nationality (anyOf 2)nullAlternative
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: person
phoneJSONOptional
phone (anyOf 1)stringAlternativeThe person's phone number.
Maximum length: 5000
phone (anyOf 2)nullAlternative
political_exposurestringOptionalIndicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
Known values: existing, none
registered_addressModelOptionalExpand Create a Location — response body — address
relationshipModelOptionalExpand Create a person — accounts post Accounts Account People — response body — relationship
requirementsJSONOptional
requirements (anyOf 1)JSONAlternative
requirements (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a person — accounts post Accounts Account People — response body — requirements value alternatives, currently due, errors, eventually due, past due, pending verification
requirements (anyOf 2)nullAlternative
ssn_last_4_providedbooleanOptionalWhether the last four digits of the person's Social Security number have been provided (U.S. only).
us_cfpb_dataJSONOptional
us_cfpb_data (anyOf 1)JSONAlternativeDemographic data related to the person.
us_cfpb_data (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a person — accounts post Accounts Account People — response body — us cfpb data Demographic data related to the person ethnicity details, race details, self identified gender
us_cfpb_data (anyOf 2)nullAlternative
verificationModelOptionalExpand Create a person — accounts post Accounts Account People — response body — verification

Referenced models: Create a Location — response body — address, Create a person — accounts post Accounts Account People — response body — dob, Create a Location — response body — address kana, Create a person — accounts post Accounts Account People — response body — verification, Create a person — accounts post Accounts Account People — response body — additional tos acceptances, Create a person — accounts post Accounts Account People — response body — future requirements value alternatives, currently due, errors, eventually due, past due, pending verification, Create a person — accounts post Accounts Account People — response body — relationship, Create a person — accounts post Accounts Account People — response body — requirements value alternatives, currently due, errors, eventually due, past due, pending verification, Create a person — accounts post Accounts Account People — response body — us cfpb data Demographic data related to the person ethnicity details, race details, self identified gender

Create a person — accounts post Accounts Account People — response body — additional tos acceptances

FieldTypePresenceDescription and constraints
$objectRoot
accountJSONOptional
account (anyOf 1)JSONAlternativeDetails on the legal guardian's acceptance of the main Stripe service agreement.
account (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a person — accounts post Accounts Account People — response body — additional tos acceptances account value date, ip, user agent
account (anyOf 2)nullAlternative

Referenced models: Create a person — accounts post Accounts Account People — response body — additional tos acceptances account value date, ip, user agent

Create a person — accounts post Accounts Account People — response body — additional tos acceptances account value date, ip, user agent

FieldTypePresenceDescription and constraints
$objectRoot
dateJSONOptional
date (anyOf 1)JSONAlternative
date (anyOf 1) (anyOf 1)integerAlternativeThe Unix timestamp marking when the legal guardian accepted the service agreement.
Format: unix-time
date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
date (anyOf 2)nullAlternative
ipJSONOptional
ip (anyOf 1)stringAlternativeThe IP address from which the legal guardian accepted the service agreement.
Maximum length: 5000
ip (anyOf 2)nullAlternative
user_agentJSONOptional
user_agent (anyOf 1)stringAlternativeThe user agent of the browser from which the legal guardian accepted the service agreement.
Maximum length: 5000
user_agent (anyOf 2)nullAlternative

Create a person — accounts post Accounts Account People — response body — dob

FieldTypePresenceDescription and constraints
$objectRoot
dayJSONOptional
day (anyOf 1)JSONAlternative
day (anyOf 1) (anyOf 1)integerAlternativeThe day of birth, between 1 and 31.
day (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
day (anyOf 2)nullAlternative
monthJSONOptional
month (anyOf 1)JSONAlternative
month (anyOf 1) (anyOf 1)integerAlternativeThe month of birth, between 1 and 12.
month (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month (anyOf 2)nullAlternative
yearJSONOptional
year (anyOf 1)JSONAlternative
year (anyOf 1) (anyOf 1)integerAlternativeThe four-digit year of birth.
year (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
year (anyOf 2)nullAlternative

Create a person — accounts post Accounts Account People — response body — future requirements value alternatives, currently due, errors, eventually due, past due, pending verification

FieldTypePresenceDescription and constraints
$objectRoot
alternativesJSONOptional
alternatives (anyOf 1)arrayAlternativeFields 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)[]ModelEach itemExpand Create an account — response body — requirements alternatives array item
alternatives (anyOf 2)nullAlternative
currently_duearrayRequired within parentFields that need to be resolved to keep the person's account enabled. If not resolved by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.
currently_due[]stringEach itemMaximum length: 5000
errorsarrayRequired within parentFields that are `currently_due` and need to be collected again because validation or verification failed.
errors[]ModelEach itemExpand Update an Account Capability — response body — requirements errors item
eventually_duearrayRequired within parentFields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.
eventually_due[]stringEach itemMaximum length: 5000
past_duearrayRequired within parentFields that haven't been resolved by the account's `requirements.current_deadline`. These fields need to be resolved to enable the person's account. `future_requirements.past_due` is a subset of `requirements.past_due`.
past_due[]stringEach itemMaximum length: 5000
pending_verificationarrayRequired within parentFields 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[]stringEach itemMaximum length: 5000

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

Create a person — accounts post Accounts Account People — response body — relationship

FieldTypePresenceDescription and constraints
$objectRoot
authorizerJSONOptional
authorizer (anyOf 1)booleanAlternativeWhether the person is the authorizer of the account's representative.
authorizer (anyOf 2)nullAlternative
directorJSONOptional
director (anyOf 1)booleanAlternativeWhether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
director (anyOf 2)nullAlternative
executiveJSONOptional
executive (anyOf 1)booleanAlternativeWhether the person has significant responsibility to control, manage, or direct the organization.
executive (anyOf 2)nullAlternative
legal_guardianJSONOptional
legal_guardian (anyOf 1)booleanAlternativeWhether the person is the legal guardian of the account's representative.
legal_guardian (anyOf 2)nullAlternative
ownerJSONOptional
owner (anyOf 1)booleanAlternativeWhether the person is an owner of the account’s legal entity.
owner (anyOf 2)nullAlternative
percent_ownershipJSONOptional
percent_ownership (anyOf 1)JSONAlternative
percent_ownership (anyOf 1) (anyOf 1)numberAlternativeThe percent owned by the person of the account's legal entity.
percent_ownership (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
percent_ownership (anyOf 2)nullAlternative
representativeJSONOptional
representative (anyOf 1)booleanAlternativeWhether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
representative (anyOf 2)nullAlternative
titleJSONOptional
title (anyOf 1)stringAlternativeThe person's title (e.g., CEO, Support Engineer).
Maximum length: 5000
title (anyOf 2)nullAlternative

Create a person — accounts post Accounts Account People — response body — requirements value alternatives, currently due, errors, eventually due, past due, pending verification

FieldTypePresenceDescription and constraints
$objectRoot
alternativesJSONOptional
alternatives (anyOf 1)arrayAlternativeFields 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)[]ModelEach itemExpand Create an account — response body — requirements alternatives array item
alternatives (anyOf 2)nullAlternative
currently_duearrayRequired within parentFields that need to be resolved to keep the person's account enabled. If not resolved by the account's `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
currently_due[]stringEach itemMaximum length: 5000
errorsarrayRequired within parentFields that are `currently_due` and need to be collected again because validation or verification failed.
errors[]ModelEach itemExpand Update an Account Capability — response body — requirements errors item
eventually_duearrayRequired within parentFields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.
eventually_due[]stringEach itemMaximum length: 5000
past_duearrayRequired within parentFields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the person's account.
past_due[]stringEach itemMaximum length: 5000
pending_verificationarrayRequired within parentFields 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[]stringEach itemMaximum length: 5000

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

Create a person — accounts post Accounts Account People — response body — us cfpb data Demographic data related to the person ethnicity details, race details, self identified gender

FieldTypePresenceDescription and constraints
$objectRoot
ethnicity_detailsJSONOptional
ethnicity_details (anyOf 1)JSONAlternativeThe persons ethnicity details
ethnicity_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a person — accounts post Accounts Account People — response body — us cfpb data Demographic data related to the person ethnicity details, race details, self identified gender ethnicity details The persons ethnicity details ethnicity, ethnicity other
ethnicity_details (anyOf 2)nullAlternative
race_detailsJSONOptional
race_details (anyOf 1)JSONAlternativeThe persons race details
race_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a person — accounts post Accounts Account People — response body — us cfpb data Demographic data related to the person ethnicity details, race details, self identified gender race details The persons race details race, race other
race_details (anyOf 2)nullAlternative
self_identified_genderJSONOptional
self_identified_gender (anyOf 1)stringAlternativeThe persons self-identified gender
Maximum length: 5000
self_identified_gender (anyOf 2)nullAlternative

Referenced models: Create a person — accounts post Accounts Account People — response body — us cfpb data Demographic data related to the person ethnicity details, race details, self identified gender ethnicity details The persons ethnicity details ethnicity, ethnicity other, Create a person — accounts post Accounts Account People — response body — us cfpb data Demographic data related to the person ethnicity details, race details, self identified gender race details The persons race details race, race other

Create a person — accounts post Accounts Account People — response body — us cfpb data Demographic data related to the person ethnicity details, race details, self identified gender ethnicity details The persons ethnicity details ethnicity, ethnicity other

FieldTypePresenceDescription and constraints
$objectRoot
ethnicityJSONOptional
ethnicity (anyOf 1)arrayAlternativeThe persons ethnicity
ethnicity (anyOf 1)[]stringEach itemKnown values: cuban, hispanic_or_latino, mexican, not_hispanic_or_latino, other_hispanic_or_latino, prefer_not_to_answer, puerto_rican
ethnicity (anyOf 2)nullAlternative
ethnicity_otherJSONOptional
ethnicity_other (anyOf 1)stringAlternativePlease specify your origin, when other is selected.
Maximum length: 5000
ethnicity_other (anyOf 2)nullAlternative

Create a person — accounts post Accounts Account People — response body — us cfpb data Demographic data related to the person ethnicity details, race details, self identified gender race details The persons race details race, race other

FieldTypePresenceDescription and constraints
$objectRoot
raceJSONOptional
race (anyOf 1)arrayAlternativeThe persons race.
race (anyOf 1)[]stringEach itemKnown values: african_american, american_indian_or_alaska_native, asian, asian_indian, black_or_african_american, chinese, ethiopian, filipino, guamanian_or_chamorro, haitian, jamaican, japanese, korean, native_hawaiian, native_hawaiian_or_other_pacific_islander, nigerian, other_asian, other_black_or_african_american, other_pacific_islander, prefer_not_to_answer, samoan, somali, vietnamese, white
race (anyOf 2)nullAlternative
race_otherJSONOptional
race_other (anyOf 1)stringAlternativePlease specify your race, when other is selected.
Maximum length: 5000
race_other (anyOf 2)nullAlternative

Create a person — accounts post Accounts Account People — response body — verification

FieldTypePresenceDescription and constraints
$objectRoot
additional_documentJSONOptional
additional_document (anyOf 1)JSONAlternativeA document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
additional_document (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a person — accounts post Accounts Account People — response body — verification document
additional_document (anyOf 2)nullAlternative
detailsJSONOptional
details (anyOf 1)stringAlternativeA user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
Maximum length: 5000
details (anyOf 2)nullAlternative
details_codeJSONOptional
details_code (anyOf 1)stringAlternativeOne of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person.
Maximum length: 5000
details_code (anyOf 2)nullAlternative
documentModelOptionalExpand Create a person — accounts post Accounts Account People — response body — verification document
statusstringRequired within parentThe state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://docs.stripe.com/connect/handling-api-verification) to handle verification updates.
Maximum length: 5000

Referenced models: Create a person — accounts post Accounts Account People — response body — verification document

Create a person — accounts post Accounts Account People — response body — verification document

FieldTypePresenceDescription and constraints
$objectRoot
backJSONOptional
back (anyOf 1)JSONAlternativeThe back of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`.
back (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
back (anyOf 1) (anyOf 2)ModelAlternativeExpand Create a file — response body
back (anyOf 2)nullAlternative
detailsJSONOptional
details (anyOf 1)stringAlternativeA user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
Maximum length: 5000
details (anyOf 2)nullAlternative
details_codeJSONOptional
details_code (anyOf 1)stringAlternativeOne of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.
Maximum length: 5000
details_code (anyOf 2)nullAlternative
frontJSONOptional
front (anyOf 1)JSONAlternativeThe front of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`.
front (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
front (anyOf 1) (anyOf 2)ModelAlternativeExpand Create a file — response body
front (anyOf 2)nullAlternative

Referenced models: Create a file — response body

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

FieldTypePresenceDescription and constraints
$objectRoot
account_holder_namestringOptionalMaximum length: 5000
account_holder_typestringOptionalOne of: company, individual
Maximum length: 5000
account_numberstringRequired within parentMaximum length: 5000
account_typestringOptionalOne of: checking, futsu, savings, toza
Maximum length: 5000
countrystringRequired within parentMaximum length: 5000
currencystringOptionalFormat: currency
documentsobjectOptional
documents.bank_account_ownership_verificationobjectOptional
documents.bank_account_ownership_verification.filesarrayOptional
documents.bank_account_ownership_verification.files[]stringEach itemMaximum length: 500
objectstringOptionalOne of: bank_account
Maximum length: 5000
routing_numberstringOptionalMaximum length: 5000

Create an account — request body — body business profile

FieldTypePresenceDescription and constraints
$objectRootBusiness information about the account.
annual_revenueobjectOptional
annual_revenue.amountintegerRequired within parent
annual_revenue.currencystringRequired within parentFormat: currency
annual_revenue.fiscal_year_endstringRequired within parentMaximum length: 5000
estimated_worker_countintegerOptional
mccstringOptionalMaximum length: 4
minority_owned_business_designationarrayOptional
minority_owned_business_designation[]stringEach itemOne of: lgbtqi_owned_business, minority_owned_business, none_of_these_apply, prefer_not_to_answer, women_owned_business
monthly_estimated_revenueobjectOptional
monthly_estimated_revenue.amountintegerRequired within parent
monthly_estimated_revenue.currencystringRequired within parentFormat: currency
namestringOptionalMaximum length: 5000
product_descriptionstringOptionalMaximum length: 40000
specified_commercial_transactions_act_urlJSONOptional
specified_commercial_transactions_act_url (anyOf 1)stringAlternative
specified_commercial_transactions_act_url (anyOf 2)stringAlternativeOne of:
support_addressobjectOptional
support_address.citystringOptionalMaximum length: 100
support_address.countrystringOptionalMaximum length: 5000
support_address.line1stringOptionalMaximum length: 200
support_address.line2stringOptionalMaximum length: 200
support_address.postal_codestringOptionalMaximum length: 5000
support_address.statestringOptionalMaximum length: 5000
support_emailstringOptional
support_phonestringOptionalMaximum length: 5000
support_urlJSONOptional
support_url (anyOf 1)stringAlternative
support_url (anyOf 2)stringAlternativeOne of:
urlstringOptional

Create an account — request body — body capabilities

FieldTypePresenceDescription and constraints
$objectRootEach key of the dictionary represents a capability, and each capability
maps to its settings (for example, whether it has been requested or not). Each
capability is inactive until you have provided its specific
requirements and Stripe has verified them. An account might have some
of its requested capabilities be active and some be inactive.

Required when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)
is `none`, which includes Custom accounts.
acss_debit_paymentsobjectOptional
acss_debit_payments.requestedbooleanOptional
affirm_paymentsobjectOptional
affirm_payments.requestedbooleanOptional
afterpay_clearpay_paymentsobjectOptional
afterpay_clearpay_payments.requestedbooleanOptional
alma_paymentsobjectOptional
alma_payments.requestedbooleanOptional
amazon_pay_paymentsobjectOptional
amazon_pay_payments.requestedbooleanOptional
app_distributionobjectOptional
app_distribution.requestedbooleanOptional
au_becs_debit_paymentsobjectOptional
au_becs_debit_payments.requestedbooleanOptional
bacs_debit_paymentsobjectOptional
bacs_debit_payments.requestedbooleanOptional
bancontact_paymentsobjectOptional
bancontact_payments.requestedbooleanOptional
bank_transfer_paymentsobjectOptional
bank_transfer_payments.requestedbooleanOptional
billie_paymentsobjectOptional
billie_payments.requestedbooleanOptional
bizum_paymentsobjectOptional
bizum_payments.requestedbooleanOptional
blik_paymentsobjectOptional
blik_payments.requestedbooleanOptional
blik_recurring_paymentsobjectOptional
blik_recurring_payments.requestedbooleanOptional
boleto_paymentsobjectOptional
boleto_payments.requestedbooleanOptional
card_issuingobjectOptional
card_issuing.requestedbooleanOptional
card_paymentsobjectOptional
card_payments.requestedbooleanOptional
cartes_bancaires_paymentsobjectOptional
cartes_bancaires_payments.requestedbooleanOptional
cashapp_paymentsobjectOptional
cashapp_payments.requestedbooleanOptional
crypto_paymentsobjectOptional
crypto_payments.requestedbooleanOptional
eps_paymentsobjectOptional
eps_payments.requestedbooleanOptional
fpx_paymentsobjectOptional
fpx_payments.requestedbooleanOptional
gb_bank_transfer_paymentsobjectOptional
gb_bank_transfer_payments.requestedbooleanOptional
giropay_paymentsobjectOptional
giropay_payments.requestedbooleanOptional
grabpay_paymentsobjectOptional
grabpay_payments.requestedbooleanOptional
ideal_paymentsobjectOptional
ideal_payments.requestedbooleanOptional
india_international_paymentsobjectOptional
india_international_payments.requestedbooleanOptional
jcb_paymentsobjectOptional
jcb_payments.requestedbooleanOptional
jp_bank_transfer_paymentsobjectOptional
jp_bank_transfer_payments.requestedbooleanOptional
kakao_pay_paymentsobjectOptional
kakao_pay_payments.requestedbooleanOptional
klarna_paymentsobjectOptional
klarna_payments.requestedbooleanOptional
konbini_paymentsobjectOptional
konbini_payments.requestedbooleanOptional
kr_card_paymentsobjectOptional
kr_card_payments.requestedbooleanOptional
legacy_paymentsobjectOptional
legacy_payments.requestedbooleanOptional
link_paymentsobjectOptional
link_payments.requestedbooleanOptional
mb_way_paymentsobjectOptional
mb_way_payments.requestedbooleanOptional
mobilepay_paymentsobjectOptional
mobilepay_payments.requestedbooleanOptional
multibanco_paymentsobjectOptional
multibanco_payments.requestedbooleanOptional
mx_bank_transfer_paymentsobjectOptional
mx_bank_transfer_payments.requestedbooleanOptional
naver_pay_paymentsobjectOptional
naver_pay_payments.requestedbooleanOptional
nz_bank_account_becs_debit_paymentsobjectOptional
nz_bank_account_becs_debit_payments.requestedbooleanOptional
oxxo_paymentsobjectOptional
oxxo_payments.requestedbooleanOptional
p24_paymentsobjectOptional
p24_payments.requestedbooleanOptional
pay_by_bank_paymentsobjectOptional
pay_by_bank_payments.requestedbooleanOptional
payco_paymentsobjectOptional
payco_payments.requestedbooleanOptional
paynow_paymentsobjectOptional
paynow_payments.requestedbooleanOptional
paypay_paymentsobjectOptional
paypay_payments.requestedbooleanOptional
payto_paymentsobjectOptional
payto_payments.requestedbooleanOptional
pix_paymentsobjectOptional
pix_payments.requestedbooleanOptional
promptpay_paymentsobjectOptional
promptpay_payments.requestedbooleanOptional
revolut_pay_paymentsobjectOptional
revolut_pay_payments.requestedbooleanOptional
samsung_pay_paymentsobjectOptional
samsung_pay_payments.requestedbooleanOptional
satispay_paymentsobjectOptional
satispay_payments.requestedbooleanOptional
scalapay_paymentsobjectOptional
scalapay_payments.requestedbooleanOptional
sepa_bank_transfer_paymentsobjectOptional
sepa_bank_transfer_payments.requestedbooleanOptional
sepa_debit_paymentsobjectOptional
sepa_debit_payments.requestedbooleanOptional
sequra_paymentsobjectOptional
sequra_payments.requestedbooleanOptional
sofort_paymentsobjectOptional
sofort_payments.requestedbooleanOptional
sunbit_paymentsobjectOptional
sunbit_payments.requestedbooleanOptional
swish_paymentsobjectOptional
swish_payments.requestedbooleanOptional
tax_reporting_us_1099_kobjectOptional
tax_reporting_us_1099_k.requestedbooleanOptional
tax_reporting_us_1099_miscobjectOptional
tax_reporting_us_1099_misc.requestedbooleanOptional
transfersobjectOptional
transfers.requestedbooleanOptional
treasuryobjectOptional
treasury.requestedbooleanOptional
twint_paymentsobjectOptional
twint_payments.requestedbooleanOptional
upi_paymentsobjectOptional
upi_payments.requestedbooleanOptional
us_bank_account_ach_paymentsobjectOptional
us_bank_account_ach_payments.requestedbooleanOptional
us_bank_transfer_paymentsobjectOptional
us_bank_transfer_payments.requestedbooleanOptional
zip_paymentsobjectOptional
zip_payments.requestedbooleanOptional

Create an account — request body — body company

FieldTypePresenceDescription and constraints
$objectRootInformation about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
addressobjectOptional
address.citystringOptionalMaximum length: 100
address.countrystringOptionalMaximum length: 5000
address.line1stringOptionalMaximum length: 200
address.line2stringOptionalMaximum length: 200
address.postal_codestringOptionalMaximum length: 5000
address.statestringOptionalMaximum length: 5000
address_kanaobjectOptional
address_kana.citystringOptionalMaximum length: 5000
address_kana.countrystringOptionalMaximum length: 5000
address_kana.line1stringOptionalMaximum length: 5000
address_kana.line2stringOptionalMaximum length: 5000
address_kana.postal_codestringOptionalMaximum length: 5000
address_kana.statestringOptionalMaximum length: 5000
address_kana.townstringOptionalMaximum length: 5000
address_kanjiobjectOptional
address_kanji.citystringOptionalMaximum length: 5000
address_kanji.countrystringOptionalMaximum length: 5000
address_kanji.line1stringOptionalMaximum length: 5000
address_kanji.line2stringOptionalMaximum length: 5000
address_kanji.postal_codestringOptionalMaximum length: 5000
address_kanji.statestringOptionalMaximum length: 5000
address_kanji.townstringOptionalMaximum length: 5000
administrative_addressobjectOptional
administrative_address.citystringOptionalMaximum length: 100
administrative_address.countrystringOptionalMaximum length: 5000
administrative_address.line1stringOptionalMaximum length: 200
administrative_address.line2stringOptionalMaximum length: 200
administrative_address.postal_codestringOptionalMaximum length: 5000
administrative_address.statestringOptionalMaximum length: 5000
directors_providedbooleanOptional
directorship_declarationobjectOptional
directorship_declaration.dateintegerOptionalFormat: unix-time
directorship_declaration.ipstringOptional
directorship_declaration.user_agentstringOptionalMaximum length: 5000
executives_providedbooleanOptional
export_license_idstringOptionalMaximum length: 5000
export_purpose_codestringOptionalMaximum length: 5000
namestringOptionalMaximum length: 200
name_kanastringOptionalMaximum length: 200
name_kanjistringOptionalMaximum length: 200
owners_providedbooleanOptional
ownership_declarationobjectOptional
ownership_declaration.dateintegerOptionalFormat: unix-time
ownership_declaration.ipstringOptional
ownership_declaration.user_agentstringOptionalMaximum length: 5000
ownership_exemption_reasonstringOptionalOne of: , qualified_entity_exceeds_ownership_threshold, qualifies_as_financial_institution
phonestringOptionalMaximum length: 5000
principal_place_of_businessobjectOptional
principal_place_of_business.citystringOptionalMaximum length: 100
principal_place_of_business.countrystringOptionalMaximum length: 5000
principal_place_of_business.line1stringOptionalMaximum length: 200
principal_place_of_business.line2stringOptionalMaximum length: 200
principal_place_of_business.postal_codestringOptionalMaximum length: 5000
principal_place_of_business.statestringOptionalMaximum length: 5000
registration_dateJSONOptional
registration_date (anyOf 1)objectAlternative
registration_date (anyOf 1).dayintegerRequired within parent
registration_date (anyOf 1).monthintegerRequired within parent
registration_date (anyOf 1).yearintegerRequired within parent
registration_date (anyOf 2)stringAlternativeOne of:
registration_numberstringOptionalMaximum length: 5000
representative_declarationobjectOptional
representative_declaration.dateintegerOptionalFormat: unix-time
representative_declaration.ipstringOptional
representative_declaration.user_agentstringOptionalMaximum length: 5000
structurestringOptionalOne of: , free_zone_establishment, free_zone_llc, government_instrumentality, governmental_unit, incorporated_non_profit, incorporated_partnership, limited_liability_partnership, llc, multi_member_llc, private_company, private_corporation, private_partnership, public_company, public_corporation, public_partnership, registered_charity, single_member_llc, sole_establishment, sole_proprietorship, tax_exempt_government_instrumentality, unincorporated_association, unincorporated_non_profit, unincorporated_partnership
tax_idstringOptionalMaximum length: 5000
tax_id_registrarstringOptionalMaximum length: 5000
vat_idstringOptionalMaximum length: 5000
verificationobjectOptional
verification.documentobjectOptional
verification.document.backstringOptionalMaximum length: 500
verification.document.frontstringOptionalMaximum length: 500

Create an account — request body — body individual

FieldTypePresenceDescription and constraints
$objectRootInformation about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
addressobjectOptional
address.citystringOptionalMaximum length: 100
address.countrystringOptionalMaximum length: 5000
address.line1stringOptionalMaximum length: 200
address.line2stringOptionalMaximum length: 200
address.postal_codestringOptionalMaximum length: 5000
address.statestringOptionalMaximum length: 5000
address_kanaobjectOptional
address_kana.citystringOptionalMaximum length: 5000
address_kana.countrystringOptionalMaximum length: 5000
address_kana.line1stringOptionalMaximum length: 5000
address_kana.line2stringOptionalMaximum length: 5000
address_kana.postal_codestringOptionalMaximum length: 5000
address_kana.statestringOptionalMaximum length: 5000
address_kana.townstringOptionalMaximum length: 5000
address_kanjiobjectOptional
address_kanji.citystringOptionalMaximum length: 5000
address_kanji.countrystringOptionalMaximum length: 5000
address_kanji.line1stringOptionalMaximum length: 5000
address_kanji.line2stringOptionalMaximum length: 5000
address_kanji.postal_codestringOptionalMaximum length: 5000
address_kanji.statestringOptionalMaximum length: 5000
address_kanji.townstringOptionalMaximum length: 5000
dobJSONOptional
dob (anyOf 1)objectAlternative
dob (anyOf 1).dayintegerRequired within parent
dob (anyOf 1).monthintegerRequired within parent
dob (anyOf 1).yearintegerRequired within parent
dob (anyOf 2)stringAlternativeOne of:
emailstringOptional
first_namestringOptionalMaximum length: 100
first_name_kanastringOptionalMaximum length: 5000
first_name_kanjistringOptionalMaximum length: 5000
full_name_aliasesJSONOptional
full_name_aliases (anyOf 1)arrayAlternative
full_name_aliases (anyOf 1)[]stringEach itemMaximum length: 300
full_name_aliases (anyOf 2)stringAlternativeOne of:
genderstringOptional
id_numberstringOptionalMaximum length: 5000
id_number_secondarystringOptionalMaximum length: 5000
last_namestringOptionalMaximum length: 100
last_name_kanastringOptionalMaximum length: 5000
last_name_kanjistringOptionalMaximum length: 5000
maiden_namestringOptionalMaximum length: 5000
metadataJSONOptional
metadata (anyOf 1)objectAlternativeAdditional keys: see wildcard field
metadata (anyOf 1).*stringAdditional keys
metadata (anyOf 2)stringAlternativeOne of:
phonestringOptional
political_exposurestringOptionalOne of: existing, none
registered_addressobjectOptional
registered_address.citystringOptionalMaximum length: 100
registered_address.countrystringOptionalMaximum length: 5000
registered_address.line1stringOptionalMaximum length: 200
registered_address.line2stringOptionalMaximum length: 200
registered_address.postal_codestringOptionalMaximum length: 5000
registered_address.statestringOptionalMaximum length: 5000
relationshipobjectOptional
relationship.directorbooleanOptional
relationship.executivebooleanOptional
relationship.ownerbooleanOptional
relationship.percent_ownershipJSONOptional
relationship.percent_ownership (anyOf 1)numberAlternative
relationship.percent_ownership (anyOf 2)stringAlternativeOne of:
relationship.titlestringOptionalMaximum length: 5000
ssn_last_4stringOptionalMaximum length: 5000
verificationobjectOptional
verification.additional_documentobjectOptional
verification.additional_document.backstringOptionalMaximum length: 500
verification.additional_document.frontstringOptionalMaximum length: 500
verification.documentobjectOptional
verification.document.backstringOptionalMaximum length: 500
verification.document.frontstringOptionalMaximum length: 500

Create an account — request body — body settings payouts

FieldTypePresenceDescription and constraints
$objectRoot
debit_negative_balancesbooleanOptional
scheduleModelOptionalExpand Create an account — request body — body settings payouts schedule
statement_descriptorstringOptionalMaximum length: 22

Referenced models: Create an account — request body — body settings payouts schedule

Create an account — request body — body settings payouts schedule

FieldTypePresenceDescription and constraints
$objectRoot
delay_daysJSONOptional
delay_days (anyOf 1)stringAlternativeOne of: minimum
Maximum length: 5000
delay_days (anyOf 2)integerAlternative
intervalstringOptionalOne of: daily, manual, monthly, weekly
Maximum length: 5000
monthly_anchorintegerOptional
monthly_payout_daysarrayOptional
monthly_payout_days[]integerEach item
weekly_anchorstringOptionalOne of: friday, monday, saturday, sunday, thursday, tuesday, wednesday
Maximum length: 5000
weekly_payout_daysarrayOptional
weekly_payout_days[]stringEach itemOne of: friday, monday, thursday, tuesday, wednesday

Create an account — request body — body settings paypay payments

FieldTypePresenceDescription and constraints
$objectRoot
additional_filesarrayOptional
additional_files[]stringEach itemMaximum length: 5000
goods_typestringOptionalOne of: digital_content, other
siteobjectOptional
site.accessibleobjectOptional
site.in_developmentobjectOptional
site.in_development.passwordstringRequired within parentMaximum length: 5000
site.in_development.usernamestringOptionalMaximum length: 5000
site.restrictedobjectOptional
site.restricted.payment_flow_filestringOptionalMaximum length: 5000
site.typestringOptionalOne of: accessible, in_development, restricted

Create an account — request body — body tos acceptance

FieldTypePresenceDescription and constraints
$objectRootDetails on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.
dateintegerOptionalFormat: unix-time
ipstringOptional
service_agreementstringOptionalMaximum length: 5000
user_agentstringOptionalMaximum length: 5000

Create an account — response body

FieldTypePresenceDescription and constraints
$objectRootFor new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user.

This is an object representing a Stripe account. You can retrieve it to see
properties on the account like its current requirements or if the account is
enabled to make live charges or receive payouts.

For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)
is `application`, which includes Custom accounts, the properties below are always
returned.

For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)
is `stripe`, which includes Standard and Express accounts, some properties are only returned
until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions)
to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts).
business_profileJSONOptional
business_profile (anyOf 1)JSONAlternativeBusiness information about the account.
business_profile (anyOf 1) (anyOf 1)ModelAlternativeExpand Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url
business_profile (anyOf 2)nullAlternative
business_typeJSONOptional
business_type (anyOf 1)stringAlternativeThe business type.
Known values: company, government_entity, individual, non_profit
business_type (anyOf 2)nullAlternative
capabilitiesModelOptionalExpand Create an account — response body — capabilities
charges_enabledbooleanOptionalWhether the account can process charges.
companyModelOptionalExpand Create an account — response body — company
controllerModelOptionalExpand Create an account — response body — controller
countrystringOptionalThe account's country.
Maximum length: 5000
createdJSONOptional
created (anyOf 1)integerAlternativeTime at which the account was connected. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
default_currencystringOptionalThree-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).
Maximum length: 5000
details_submittedbooleanOptionalWhether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.
emailJSONOptional
email (anyOf 1)stringAlternativeAn email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.
Maximum length: 5000
email (anyOf 2)nullAlternative
external_accountsobjectOptionalExternal accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.
external_accounts.dataarrayRequired within parentThe list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
external_accounts.data[]JSONEach item
external_accounts.data[] (anyOf 1)ModelAlternativeExpand Retrieve a bank account — response body
external_accounts.data[] (anyOf 2)ModelAlternativeExpand Retrieve a card — customers get Customers Customer Cards Id — response body
external_accounts.has_morebooleanRequired within parentTrue if this list has another page of items after this one that can be fetched.
external_accounts.objectstringRequired within parentString representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Known values: list
external_accounts.urlstringRequired within parentThe URL where this list can be accessed.
Maximum length: 5000
future_requirementsModelOptionalExpand Create an account — response body — future requirements
groupsJSONOptional
groups (anyOf 1)JSONAlternativeThe groups associated with the account.
groups (anyOf 1) (anyOf 1)ModelAlternativeExpand Create an account — response body — groups The groups associated with the account payments pricing
groups (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
individualModelOptionalExpand Create a person — accounts post Accounts Account People — response body
metadataobjectOptionalSet 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.
Additional keys: see wildcard field
metadata.*stringAdditional keysMaximum length: 500
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: account
payouts_enabledbooleanOptionalWhether the funds in this account can be paid out.
requirementsModelOptionalExpand Create an account — response body — requirements
settingsJSONOptional
settings (anyOf 1)JSONAlternativeOptions for customizing how the account functions within Stripe.
settings (anyOf 1) (anyOf 1)ModelAlternativeExpand 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
settings (anyOf 2)nullAlternative
tos_acceptanceModelOptionalExpand Create an account — response body — tos acceptance
typestringOptionalThe Stripe account type. Can be `standard`, `express`, `custom`, or `none`.
Known values: custom, express, none, standard

Referenced models: Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url, Create an account — response body — capabilities, Create an account — response body — future requirements, Create an account — response body — groups The groups associated with the account payments pricing, Create an account — response body — requirements, 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, Create an account — response body — tos acceptance, Create an account — response body — controller, Retrieve a bank account — response body, Retrieve a card — customers get Customers Customer Cards Id — response body, Create an account — response body — company, Create a person — accounts post Accounts Account People — response body

Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url

FieldTypePresenceDescription and constraints
$objectRoot
annual_revenueJSONOptional
annual_revenue (anyOf 1)JSONAlternativeThe applicant's gross annual revenue for its preceding fiscal year.
annual_revenue (anyOf 1) (anyOf 1)ModelAlternativeExpand Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url annual revenue value amount, currency, fiscal year end
annual_revenue (anyOf 2)nullAlternative
estimated_worker_countJSONOptional
estimated_worker_count (anyOf 1)JSONAlternative
estimated_worker_count (anyOf 1) (anyOf 1)integerAlternativeAn estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
estimated_worker_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimated_worker_count (anyOf 2)nullAlternative
mccJSONOptional
mcc (anyOf 1)stringAlternative[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
Maximum length: 5000
mcc (anyOf 2)nullAlternative
minority_owned_business_designationJSONOptional
minority_owned_business_designation (anyOf 1)arrayAlternativeWhether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
minority_owned_business_designation (anyOf 1)[]stringEach itemKnown values: lgbtqi_owned_business, minority_owned_business, none_of_these_apply, prefer_not_to_answer, women_owned_business
minority_owned_business_designation (anyOf 2)nullAlternative
monthly_estimated_revenueModelOptionalExpand Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url monthly estimated revenue
nameJSONOptional
name (anyOf 1)stringAlternativeThe customer-facing business name.
Maximum length: 5000
name (anyOf 2)nullAlternative
product_descriptionJSONOptional
product_description (anyOf 1)stringAlternativeInternal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.
Maximum length: 40000
product_description (anyOf 2)nullAlternative
specified_commercial_transactions_act_urlJSONOptional
specified_commercial_transactions_act_url (anyOf 1)stringAlternativeA link to the business's publicly available terms related to the Specified Commercial Transaction Act. Only used for accounts in Japan.
Maximum length: 5000
specified_commercial_transactions_act_url (anyOf 2)nullAlternative
support_addressJSONOptional
support_address (anyOf 1)JSONAlternativeA publicly available mailing address for sending support issues to.
support_address (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Location — response body — address
support_address (anyOf 2)nullAlternative
support_emailJSONOptional
support_email (anyOf 1)stringAlternativeA publicly available email address for sending support issues to.
Maximum length: 5000
support_email (anyOf 2)nullAlternative
support_phoneJSONOptional
support_phone (anyOf 1)stringAlternativeA publicly available phone number to call with support issues.
Maximum length: 5000
support_phone (anyOf 2)nullAlternative
support_urlJSONOptional
support_url (anyOf 1)stringAlternativeA publicly available website for handling support issues.
Maximum length: 5000
support_url (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternativeThe business's publicly available website.
Maximum length: 5000
url (anyOf 2)nullAlternative

Referenced models: Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url annual revenue value amount, currency, fiscal year end, Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url monthly estimated revenue, Create a Location — response body — address

Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url annual revenue value amount, currency, fiscal year end

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONOptional
amount (anyOf 1)JSONAlternative
amount (anyOf 1) (anyOf 1)integerAlternativeA non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).
amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)nullAlternative
currencyJSONOptional
currency (anyOf 1)stringAlternativeThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
Format: currency
currency (anyOf 2)nullAlternative
fiscal_year_endJSONOptional
fiscal_year_end (anyOf 1)stringAlternativeThe close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
Maximum length: 5000
fiscal_year_end (anyOf 2)nullAlternative

Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url monthly estimated revenue

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeA non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
Format: currency

Create an account — response body — capabilities

FieldTypePresenceDescription and constraints
$objectRoot
acss_debit_paymentsstringOptionalThe status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.
Known values: active, inactive, pending
affirm_paymentsstringOptionalThe status of the Affirm capability of the account, or whether the account can directly process Affirm charges.
Known values: active, inactive, pending
afterpay_clearpay_paymentsstringOptionalThe status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.
Known values: active, inactive, pending
alma_paymentsstringOptionalThe status of the Alma capability of the account, or whether the account can directly process Alma payments.
Known values: active, inactive, pending
amazon_pay_paymentsstringOptionalThe status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.
Known values: active, inactive, pending
app_distributionstringOptionalThe status of the `app_distribution` capability of the account, or whether the platform can distribute apps to other accounts.
Known values: active, inactive, pending
au_becs_debit_paymentsstringOptionalThe status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.
Known values: active, inactive, pending
bacs_debit_paymentsstringOptionalThe status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.
Known values: active, inactive, pending
bancontact_paymentsstringOptionalThe status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.
Known values: active, inactive, pending
bank_transfer_paymentsstringOptionalThe status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.
Known values: active, inactive, pending
billie_paymentsstringOptionalThe status of the Billie capability of the account, or whether the account can directly process Billie payments.
Known values: active, inactive, pending
bizum_paymentsstringOptionalThe status of the Bizum capability of the account, or whether the account can directly process Bizum payments.
Known values: active, inactive, pending
blik_paymentsstringOptionalThe status of the blik payments capability of the account, or whether the account can directly process blik charges.
Known values: active, inactive, pending
blik_recurring_paymentsstringOptionalThe status of the BLIK recurring payments capability of the account, or whether the account can accept recurring and subscription BLIK payments.
Known values: active, inactive, pending
boleto_paymentsstringOptionalThe status of the boleto payments capability of the account, or whether the account can directly process boleto charges.
Known values: active, inactive, pending
card_issuingstringOptionalThe status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards
Known values: active, inactive, pending
card_paymentsstringOptionalThe status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.
Known values: active, inactive, pending
cartes_bancaires_paymentsstringOptionalThe status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.
Known values: active, inactive, pending
cashapp_paymentsstringOptionalThe status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.
Known values: active, inactive, pending
crypto_paymentsstringOptionalThe status of the Crypto capability of the account, or whether the account can directly process Crypto payments.
Known values: active, inactive, pending
eps_paymentsstringOptionalThe status of the EPS payments capability of the account, or whether the account can directly process EPS charges.
Known values: active, inactive, pending
fpx_paymentsstringOptionalThe status of the FPX payments capability of the account, or whether the account can directly process FPX charges.
Known values: active, inactive, pending
gb_bank_transfer_paymentsstringOptionalThe status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.
Known values: active, inactive, pending
giropay_paymentsstringOptionalThe status of the giropay payments capability of the account, or whether the account can directly process giropay charges.
Known values: active, inactive, pending
grabpay_paymentsstringOptionalThe status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.
Known values: active, inactive, pending
ideal_paymentsstringOptionalThe status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.
Known values: active, inactive, pending
india_international_paymentsstringOptionalThe status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.
Known values: active, inactive, pending
jcb_paymentsstringOptionalThe status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.
Known values: active, inactive, pending
jp_bank_transfer_paymentsstringOptionalThe status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.
Known values: active, inactive, pending
kakao_pay_paymentsstringOptionalThe status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.
Known values: active, inactive, pending
klarna_paymentsstringOptionalThe status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.
Known values: active, inactive, pending
konbini_paymentsstringOptionalThe status of the konbini payments capability of the account, or whether the account can directly process konbini charges.
Known values: active, inactive, pending
kr_card_paymentsstringOptionalThe status of the KrCard capability of the account, or whether the account can directly process KrCard payments.
Known values: active, inactive, pending
legacy_paymentsstringOptionalThe status of the legacy payments capability of the account.
Known values: active, inactive, pending
link_paymentsstringOptionalThe status of the link_payments capability of the account, or whether the account can directly process Link charges.
Known values: active, inactive, pending
mb_way_paymentsstringOptionalThe status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges.
Known values: active, inactive, pending
mobilepay_paymentsstringOptionalThe status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.
Known values: active, inactive, pending
multibanco_paymentsstringOptionalThe status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.
Known values: active, inactive, pending
mx_bank_transfer_paymentsstringOptionalThe status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.
Known values: active, inactive, pending
naver_pay_paymentsstringOptionalThe status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.
Known values: active, inactive, pending
nz_bank_account_becs_debit_paymentsstringOptionalThe status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges.
Known values: active, inactive, pending
oxxo_paymentsstringOptionalThe status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.
Known values: active, inactive, pending
p24_paymentsstringOptionalThe status of the P24 payments capability of the account, or whether the account can directly process P24 charges.
Known values: active, inactive, pending
pay_by_bank_paymentsstringOptionalThe status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.
Known values: active, inactive, pending
payco_paymentsstringOptionalThe status of the Payco capability of the account, or whether the account can directly process Payco payments.
Known values: active, inactive, pending
paynow_paymentsstringOptionalThe status of the paynow payments capability of the account, or whether the account can directly process paynow charges.
Known values: active, inactive, pending
paypay_paymentsstringOptionalThe status of the Paypay capability of the account, or whether the account can directly process Paypay payments.
Known values: active, inactive, pending
payto_paymentsstringOptionalThe status of the PayTo capability of the account, or whether the account can directly process PayTo charges.
Known values: active, inactive, pending
pix_paymentsstringOptionalThe status of the pix payments capability of the account, or whether the account can directly process pix charges.
Known values: active, inactive, pending
promptpay_paymentsstringOptionalThe status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.
Known values: active, inactive, pending
revolut_pay_paymentsstringOptionalThe status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.
Known values: active, inactive, pending
samsung_pay_paymentsstringOptionalThe status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.
Known values: active, inactive, pending
satispay_paymentsstringOptionalThe status of the Satispay capability of the account, or whether the account can directly process Satispay payments.
Known values: active, inactive, pending
scalapay_paymentsstringOptionalThe status of the Scalapay capability of the account, or whether the account can directly process Scalapay payments.
Known values: active, inactive, pending
sepa_bank_transfer_paymentsstringOptionalThe status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.
Known values: active, inactive, pending
sepa_debit_paymentsstringOptionalThe status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.
Known values: active, inactive, pending
sequra_paymentsstringOptionalThe status of the SeQura capability of the account, or whether the account can directly process SeQura payments.
Known values: active, inactive, pending
sofort_paymentsstringOptionalThe status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.
Known values: active, inactive, pending
sunbit_paymentsstringOptionalThe status of the Sunbit capability of the account, or whether the account can directly process Sunbit payments.
Known values: active, inactive, pending
swish_paymentsstringOptionalThe status of the Swish capability of the account, or whether the account can directly process Swish payments.
Known values: active, inactive, pending
tax_reporting_us_1099_kstringOptionalThe status of the tax reporting 1099-K (US) capability of the account.
Known values: active, inactive, pending
tax_reporting_us_1099_miscstringOptionalThe status of the tax reporting 1099-MISC (US) capability of the account.
Known values: active, inactive, pending
transfersstringOptionalThe status of the transfers capability of the account, or whether your platform can transfer funds to the account.
Known values: active, inactive, pending
treasurystringOptionalThe status of the banking capability, or whether the account can have bank accounts.
Known values: active, inactive, pending
twint_paymentsstringOptionalThe status of the TWINT capability of the account, or whether the account can directly process TWINT charges.
Known values: active, inactive, pending
upi_paymentsstringOptionalThe status of the upi payments capability of the account, or whether the account can directly process upi charges.
Known values: active, inactive, pending
us_bank_account_ach_paymentsstringOptionalThe status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.
Known values: active, inactive, pending
us_bank_transfer_paymentsstringOptionalThe status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.
Known values: active, inactive, pending
zip_paymentsstringOptionalThe status of the Zip capability of the account, or whether the account can directly process Zip charges.
Known values: active, inactive, pending

Create an account — response body — company

FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Create a Location — response body — address
address_kanaJSONOptional
address_kana (anyOf 1)JSONAlternativeThe Kana variation of the company's primary address (Japan only).
address_kana (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Location — response body — address kana
address_kana (anyOf 2)nullAlternative
address_kanjiJSONOptional
address_kanji (anyOf 1)JSONAlternativeThe Kanji variation of the company's primary address (Japan only).
address_kanji (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Location — response body — address kana
address_kanji (anyOf 2)nullAlternative
administrative_addressModelOptionalExpand Create a Location — response body — address
directors_providedbooleanOptionalWhether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided).
directorship_declarationJSONOptional
directorship_declaration (anyOf 1)JSONAlternativeThis hash is used to attest that the director information provided to Stripe is both current and correct.
directorship_declaration (anyOf 1) (anyOf 1)ModelAlternativeExpand Create an account — response body — company directorship declaration value date, ip, user agent
directorship_declaration (anyOf 2)nullAlternative
executives_providedbooleanOptionalWhether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided.
export_license_idstringOptionalThe export license ID number of the company, also referred as Import Export Code (India only).
Maximum length: 5000
export_purpose_codestringOptionalThe purpose code to use for export transactions (India only).
Maximum length: 5000
nameJSONOptional
name (anyOf 1)stringAlternativeThe company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
name (anyOf 2)nullAlternative
name_kanaJSONOptional
name_kana (anyOf 1)stringAlternativeThe Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
name_kana (anyOf 2)nullAlternative
name_kanjiJSONOptional
name_kanji (anyOf 1)stringAlternativeThe Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
Maximum length: 5000
name_kanji (anyOf 2)nullAlternative
owners_providedbooleanOptionalWhether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).
ownership_declarationJSONOptional
ownership_declaration (anyOf 1)JSONAlternativeThis hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
ownership_declaration (anyOf 1) (anyOf 1)ModelAlternativeExpand Create an account — response body — company ownership declaration value date, ip, user agent
ownership_declaration (anyOf 2)nullAlternative
ownership_exemption_reasonstringOptionalThis value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
Known values: qualified_entity_exceeds_ownership_threshold, qualifies_as_financial_institution
phoneJSONOptional
phone (anyOf 1)stringAlternativeThe company's phone number (used for verification).
Maximum length: 5000
phone (anyOf 2)nullAlternative
principal_place_of_businessModelOptionalExpand Create a Location — response body — address
registration_dateModelOptionalExpand Create an account — response body — company registration date
representative_declarationJSONOptional
representative_declaration (anyOf 1)JSONAlternativeThis hash is used to attest that the representative is authorized to act as the representative of their legal entity.
representative_declaration (anyOf 1) (anyOf 1)ModelAlternativeExpand Create an account — response body — company representative declaration value date, ip, user agent
representative_declaration (anyOf 2)nullAlternative
structurestringOptionalThe category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details.
Known values: free_zone_establishment, free_zone_llc, government_instrumentality, governmental_unit, incorporated_non_profit, incorporated_partnership, limited_liability_partnership, llc, multi_member_llc, private_company, private_corporation, private_partnership, public_company, public_corporation, public_partnership, registered_charity, single_member_llc, sole_establishment, sole_proprietorship, tax_exempt_government_instrumentality, unincorporated_association, unincorporated_non_profit, unincorporated_partnership
tax_id_providedbooleanOptionalWhether the company's business ID number was provided.
tax_id_registrarstringOptionalThe jurisdiction in which the `tax_id` is registered (Germany-based companies only).
Maximum length: 5000
vat_id_providedbooleanOptionalWhether the company's business VAT number was provided.
verificationJSONOptional
verification (anyOf 1)JSONAlternativeInformation on the verification state of the company.
verification (anyOf 1) (anyOf 1)ModelAlternativeExpand Create an account — response body — company verification value document
verification (anyOf 2)nullAlternative

Referenced models: Create a Location — response body — address, Create an account — response body — company verification value document, Create an account — response body — company directorship declaration value date, ip, user agent, Create a Location — response body — address kana, Create an account — response body — company registration date, Create an account — response body — company representative declaration value date, ip, user agent, Create an account — response body — company ownership declaration value date, ip, user agent

Create an account — response body — company directorship declaration value date, ip, user agent

FieldTypePresenceDescription and constraints
$objectRoot
dateJSONOptional
date (anyOf 1)JSONAlternative
date (anyOf 1) (anyOf 1)integerAlternativeThe Unix timestamp marking when the directorship declaration attestation was made.
Format: unix-time
date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
date (anyOf 2)nullAlternative
ipJSONOptional
ip (anyOf 1)stringAlternativeThe IP address from which the directorship declaration attestation was made.
Maximum length: 5000
ip (anyOf 2)nullAlternative
user_agentJSONOptional
user_agent (anyOf 1)stringAlternativeThe user-agent string from the browser where the directorship declaration attestation was made.
Maximum length: 5000
user_agent (anyOf 2)nullAlternative

Create an account — response body — company ownership declaration value date, ip, user agent

FieldTypePresenceDescription and constraints
$objectRoot
dateJSONOptional
date (anyOf 1)JSONAlternative
date (anyOf 1) (anyOf 1)integerAlternativeThe Unix timestamp marking when the beneficial owner attestation was made.
Format: unix-time
date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
date (anyOf 2)nullAlternative
ipJSONOptional
ip (anyOf 1)stringAlternativeThe IP address from which the beneficial owner attestation was made.
Maximum length: 5000
ip (anyOf 2)nullAlternative
user_agentJSONOptional
user_agent (anyOf 1)stringAlternativeThe user-agent string from the browser where the beneficial owner attestation was made.
Maximum length: 5000
user_agent (anyOf 2)nullAlternative

Create an account — response body — company registration date

FieldTypePresenceDescription and constraints
$objectRoot
dayJSONOptional
day (anyOf 1)JSONAlternative
day (anyOf 1) (anyOf 1)integerAlternativeThe day of registration, between 1 and 31.
day (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
day (anyOf 2)nullAlternative
monthJSONOptional
month (anyOf 1)JSONAlternative
month (anyOf 1) (anyOf 1)integerAlternativeThe month of registration, between 1 and 12.
month (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month (anyOf 2)nullAlternative
yearJSONOptional
year (anyOf 1)JSONAlternative
year (anyOf 1) (anyOf 1)integerAlternativeThe four-digit year of registration.
year (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
year (anyOf 2)nullAlternative

Create an account — response body — company representative declaration value date, ip, user agent

FieldTypePresenceDescription and constraints
$objectRoot
dateJSONOptional
date (anyOf 1)JSONAlternative
date (anyOf 1) (anyOf 1)integerAlternativeThe Unix timestamp marking when the representative declaration attestation was made.
Format: unix-time
date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
date (anyOf 2)nullAlternative
ipJSONOptional
ip (anyOf 1)stringAlternativeThe IP address from which the representative declaration attestation was made.
Maximum length: 5000
ip (anyOf 2)nullAlternative
user_agentJSONOptional
user_agent (anyOf 1)stringAlternativeThe user-agent string from the browser where the representative declaration attestation was made.
Maximum length: 5000
user_agent (anyOf 2)nullAlternative

Create an account — response body — company verification value document

FieldTypePresenceDescription and constraints
$objectRoot
documentModelRequired within parentExpand Create an account — response body — company verification value document document

Referenced models: Create an account — response body — company verification value document document

Create an account — response body — company verification value document document

FieldTypePresenceDescription and constraints
$objectRoot
backJSONOptional
back (anyOf 1)JSONAlternativeThe back of a document returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).
back (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
back (anyOf 1) (anyOf 2)ModelAlternativeExpand Create a file — response body
back (anyOf 2)nullAlternative
detailsJSONOptional
details (anyOf 1)stringAlternativeA user-displayable string describing the verification state of this document.
Maximum length: 5000
details (anyOf 2)nullAlternative
details_codeJSONOptional
details_code (anyOf 1)stringAlternativeOne of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document.
Maximum length: 5000
details_code (anyOf 2)nullAlternative
frontJSONOptional
front (anyOf 1)JSONAlternativeThe front of a document returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).
front (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
front (anyOf 1) (anyOf 2)ModelAlternativeExpand Create a file — response body
front (anyOf 2)nullAlternative

Referenced models: Create a file — response body

Create an account — response body — controller

FieldTypePresenceDescription and constraints
$objectRoot
feesModelOptionalExpand Create an account — response body — controller fees
is_controllerbooleanOptional`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://docs.stripe.com/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.
lossesModelOptionalExpand Create an account — response body — controller losses
requirement_collectionstringOptionalA value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.
Known values: application, stripe
stripe_dashboardModelOptionalExpand Create an account — response body — controller stripe dashboard
typestringRequired within parentThe controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.
Known values: account, application

Referenced models: Create an account — response body — controller fees, Create an account — response body — controller losses, Create an account — response body — controller stripe dashboard

Create an account — response body — controller fees

FieldTypePresenceDescription and constraints
$objectRoot
payerstringRequired within parentA value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
Known values: account, application, application_custom, application_express

Create an account — response body — controller losses

FieldTypePresenceDescription and constraints
$objectRoot
paymentsstringRequired within parentA value indicating who is liable when this account can't pay back negative balances from payments.
Known values: application, stripe

Create an account — response body — controller stripe dashboard

FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentA value indicating the Stripe dashboard this account has access to independent of the Connect application.
Known values: express, full, none

Create an account — response body — future requirements

FieldTypePresenceDescription and constraints
$objectRoot
alternativesJSONOptional
alternatives (anyOf 1)arrayAlternativeFields 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)[]ModelEach itemExpand Create an account — response body — requirements alternatives array item
alternatives (anyOf 2)nullAlternative
current_deadlineJSONOptional
current_deadline (anyOf 1)JSONAlternative
current_deadline (anyOf 1) (anyOf 1)integerAlternativeDate 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 its enablement state prior to transitioning.
Format: unix-time
current_deadline (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_deadline (anyOf 2)nullAlternative
currently_dueJSONOptional
currently_due (anyOf 1)arrayAlternativeFields that need to be resolved to keep the account enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
currently_due (anyOf 1)[]stringEach itemMaximum length: 5000
currently_due (anyOf 2)nullAlternative
disabled_reasonJSONOptional
disabled_reason (anyOf 1)stringAlternativeThis is typed as an enum for consistency with `requirements.disabled_reason`.
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)nullAlternative
errorsJSONOptional
errors (anyOf 1)arrayAlternativeFields that are `currently_due` and need to be collected again because validation or verification failed.
errors (anyOf 1)[]ModelEach itemExpand Update an Account Capability — response body — requirements errors item
errors (anyOf 2)nullAlternative
eventually_dueJSONOptional
eventually_due (anyOf 1)arrayAlternativeFields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
eventually_due (anyOf 1)[]stringEach itemMaximum length: 5000
eventually_due (anyOf 2)nullAlternative
past_dueJSONOptional
past_due (anyOf 1)arrayAlternativeFields 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 (anyOf 1)[]stringEach itemMaximum length: 5000
past_due (anyOf 2)nullAlternative
pending_verificationJSONOptional
pending_verification (anyOf 1)arrayAlternativeFields 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)[]stringEach itemMaximum length: 5000
pending_verification (anyOf 2)nullAlternative

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 — groups The groups associated with the account payments pricing

FieldTypePresenceDescription and constraints
$objectRoot
payments_pricingJSONOptional
payments_pricing (anyOf 1)stringAlternativeThe group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details.
Maximum length: 5000
payments_pricing (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.