Stripe: Accounts schemas (part 1)
44 Stripe schemas with complete fields and constraints.
← Accounts operations · All schemas
Create a login link — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Login 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) |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: login_link |
url | string | Required within parent | The URL for the login link. Maximum length: 5000 |
Create a person — accounts post Accounts Account People — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
additional_tos_acceptances | object | Optional | Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements. |
additional_tos_acceptances.account | object | Optional | |
additional_tos_acceptances.account.date | integer | Optional | Format: unix-time |
additional_tos_acceptances.account.ip | string | Optional | |
additional_tos_acceptances.account.user_agent | JSON | Optional | |
additional_tos_acceptances.account.user_agent (anyOf 1) | string | Alternative | Maximum length: 5000 |
additional_tos_acceptances.account.user_agent (anyOf 2) | string | Alternative | One of: |
address | object | Optional | The person's address. |
address.city | string | Optional | Maximum length: 100 |
address.country | string | Optional | Maximum length: 5000 |
address.line1 | string | Optional | Maximum length: 200 |
address.line2 | string | Optional | Maximum length: 200 |
address.postal_code | string | Optional | Maximum length: 5000 |
address.state | string | Optional | Maximum length: 5000 |
address_kana | object | Optional | The Kana variation of the person's address (Japan only). |
address_kana.city | string | Optional | Maximum length: 5000 |
address_kana.country | string | Optional | Maximum length: 5000 |
address_kana.line1 | string | Optional | Maximum length: 5000 |
address_kana.line2 | string | Optional | Maximum length: 5000 |
address_kana.postal_code | string | Optional | Maximum length: 5000 |
address_kana.state | string | Optional | Maximum length: 5000 |
address_kana.town | string | Optional | Maximum length: 5000 |
address_kanji | object | Optional | The Kanji variation of the person's address (Japan only). |
address_kanji.city | string | Optional | Maximum length: 5000 |
address_kanji.country | string | Optional | Maximum length: 5000 |
address_kanji.line1 | string | Optional | Maximum length: 5000 |
address_kanji.line2 | string | Optional | Maximum length: 5000 |
address_kanji.postal_code | string | Optional | Maximum length: 5000 |
address_kanji.state | string | Optional | Maximum length: 5000 |
address_kanji.town | string | Optional | Maximum length: 5000 |
dob | JSON | Optional | The person's date of birth. |
dob (anyOf 1) | object | Alternative | |
dob (anyOf 1).day | integer | Required within parent | |
dob (anyOf 1).month | integer | Required within parent | |
dob (anyOf 1).year | integer | Required within parent | |
dob (anyOf 2) | string | Alternative | One of: |
documents | Model | Optional | Expand Create a person — accounts post Accounts Account People — request body — body documents |
email | string | Optional | The person's email address. |
expand | array | Optional | Specifies which fields in the response should be expanded. |
expand[] | string | Each item | Maximum length: 5000 |
first_name | string | Optional | The person's first name. Maximum length: 5000 |
first_name_kana | string | Optional | The Kana variation of the person's first name (Japan only). Maximum length: 5000 |
first_name_kanji | string | Optional | The Kanji variation of the person's first name (Japan only). Maximum length: 5000 |
full_name_aliases | JSON | Optional | A list of alternate names or aliases that the person is known by. |
full_name_aliases (anyOf 1) | array | Alternative | |
full_name_aliases (anyOf 1)[] | string | Each item | Maximum length: 5000 |
full_name_aliases (anyOf 2) | string | Alternative | One of: |
gender | string | Optional | The person's gender (International regulations require either "male" or "female"). |
id_number | string | Optional | The 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_secondary | string | Optional | The 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_name | string | Optional | The person's last name. Maximum length: 5000 |
last_name_kana | string | Optional | The Kana variation of the person's last name (Japan only). Maximum length: 5000 |
last_name_kanji | string | Optional | The Kanji variation of the person's last name (Japan only). Maximum length: 5000 |
maiden_name | string | Optional | The person's maiden name. Maximum length: 5000 |
metadata | JSON | Optional | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. |
metadata (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | |
metadata (anyOf 2) | string | Alternative | One of: |
nationality | string | Optional | The 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_token | string | Optional | A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. Maximum length: 5000 |
phone | string | Optional | The person's phone number. |
political_exposure | string | Optional | Indicates 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_address | object | Optional | The person's registered address. |
registered_address.city | string | Optional | Maximum length: 100 |
registered_address.country | string | Optional | Maximum length: 5000 |
registered_address.line1 | string | Optional | Maximum length: 200 |
registered_address.line2 | string | Optional | Maximum length: 200 |
registered_address.postal_code | string | Optional | Maximum length: 5000 |
registered_address.state | string | Optional | Maximum length: 5000 |
relationship | object | Optional | The relationship that this person has with the account's legal entity. |
relationship.authorizer | boolean | Optional | |
relationship.director | boolean | Optional | |
relationship.executive | boolean | Optional | |
relationship.legal_guardian | boolean | Optional | |
relationship.owner | boolean | Optional | |
relationship.percent_ownership | JSON | Optional | |
relationship.percent_ownership (anyOf 1) | number | Alternative | |
relationship.percent_ownership (anyOf 2) | string | Alternative | One of: |
relationship.representative | boolean | Optional | |
relationship.title | string | Optional | Maximum length: 5000 |
ssn_last_4 | string | Optional | The 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_data | Model | Optional | Expand Create a person — accounts post Accounts Account People — request body — body us cfpb data |
verification | object | Optional | The person's verification status. |
verification.additional_document | object | Optional | |
verification.additional_document.back | string | Optional | Maximum length: 500 |
verification.additional_document.front | string | Optional | Maximum length: 500 |
verification.document | object | Optional | |
verification.document.back | string | Optional | Maximum length: 500 |
verification.document.front | string | Optional | Maximum 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Documents that may be submitted to satisfy various informational requests. |
company_authorization | object | Optional | |
company_authorization.files | array | Optional | |
company_authorization.files[] | JSON | Each item | |
company_authorization.files[] (anyOf 1) | string | Alternative | Maximum length: 500 |
company_authorization.files[] (anyOf 2) | string | Alternative | One of: |
passport | object | Optional | |
passport.files | array | Optional | |
passport.files[] | JSON | Each item | |
passport.files[] (anyOf 1) | string | Alternative | Maximum length: 500 |
passport.files[] (anyOf 2) | string | Alternative | One of: |
visa | object | Optional | |
visa.files | array | Optional | |
visa.files[] | JSON | Each item | |
visa.files[] (anyOf 1) | string | Alternative | Maximum length: 500 |
visa.files[] (anyOf 2) | string | Alternative | One of: |
Create a person — accounts post Accounts Account People — request body — body us cfpb data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Demographic data related to the person. |
ethnicity_details | object | Optional | |
ethnicity_details.ethnicity | array | Optional | |
ethnicity_details.ethnicity[] | string | Each item | One of: cuban, hispanic_or_latino, mexican, not_hispanic_or_latino, other_hispanic_or_latino, prefer_not_to_answer, puerto_rican |
ethnicity_details.ethnicity_other | string | Optional | Maximum length: 5000 |
race_details | Model | Optional | Expand Create a person — accounts post Accounts Account People — request body — body us cfpb data race details |
self_identified_gender | string | Optional | Maximum 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
race | array | Optional | |
race[] | string | Each item | One 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_other | string | Optional | Maximum length: 5000 |
Create a person — accounts post Accounts Account People — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This 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). |
account | string | Required within parent | The account the person is associated with. Maximum length: 5000 |
additional_tos_acceptances | Model | Optional | Expand Create a person — accounts post Accounts Account People — response body — additional tos acceptances |
address | Model | Optional | Expand Create a Location — response body — address |
address_kana | JSON | Optional | |
address_kana (anyOf 1) | JSON | Alternative | |
address_kana (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address kana |
address_kana (anyOf 2) | null | Alternative | |
address_kanji | JSON | Optional | |
address_kanji (anyOf 1) | JSON | Alternative | |
address_kanji (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address kana |
address_kanji (anyOf 2) | null | Alternative | |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
dob | Model | Optional | Expand Create a person — accounts post Accounts Account People — response body — dob |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
first_name_kana | JSON | Optional | |
first_name_kana (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
first_name_kanji | JSON | Optional | |
first_name_kanji (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
full_name_aliases | array | Optional | A 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[] | string | Each item | Maximum length: 5000 |
future_requirements | JSON | Optional | |
future_requirements (anyOf 1) | JSON | Alternative | |
future_requirements (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
gender | JSON | Optional | |
gender (anyOf 1) | string | Alternative | The person's gender. |
gender (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
id_number_provided | boolean | Optional | Whether 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_provided | boolean | Optional | Whether the person's `id_number_secondary` was provided. |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
last_name_kana | JSON | Optional | |
last_name_kana (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
last_name_kanji | JSON | Optional | |
last_name_kanji (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
maiden_name | JSON | Optional | |
maiden_name (anyOf 1) | string | Alternative | The person's maiden name. Maximum length: 5000 |
maiden_name (anyOf 2) | null | Alternative | |
metadata | object | Optional | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
nationality | JSON | Optional | |
nationality (anyOf 1) | string | Alternative | The country where the person is a national. Maximum length: 5000 |
nationality (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: person |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | The person's phone number. Maximum length: 5000 |
phone (anyOf 2) | null | Alternative | |
political_exposure | string | Optional | Indicates 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_address | Model | Optional | Expand Create a Location — response body — address |
relationship | Model | Optional | Expand Create a person — accounts post Accounts Account People — response body — relationship |
requirements | JSON | Optional | |
requirements (anyOf 1) | JSON | Alternative | |
requirements (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
ssn_last_4_provided | boolean | Optional | Whether the last four digits of the person's Social Security number have been provided (U.S. only). |
us_cfpb_data | JSON | Optional | |
us_cfpb_data (anyOf 1) | JSON | Alternative | Demographic data related to the person. |
us_cfpb_data (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
verification | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account | JSON | Optional | |
account (anyOf 1) | JSON | Alternative | Details on the legal guardian's acceptance of the main Stripe service agreement. |
account (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a person — accounts post Accounts Account People — response body — additional tos acceptances account value date, ip, user agent |
account (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | JSON | Optional | |
date (anyOf 1) | JSON | Alternative | |
date (anyOf 1) (anyOf 1) | integer | Alternative | The Unix timestamp marking when the legal guardian accepted the service agreement. Format: unix-time |
date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
date (anyOf 2) | null | Alternative | |
ip | JSON | Optional | |
ip (anyOf 1) | string | Alternative | The IP address from which the legal guardian accepted the service agreement. Maximum length: 5000 |
ip (anyOf 2) | null | Alternative | |
user_agent | JSON | Optional | |
user_agent (anyOf 1) | string | Alternative | The user agent of the browser from which the legal guardian accepted the service agreement. Maximum length: 5000 |
user_agent (anyOf 2) | null | Alternative |
Create a person — accounts post Accounts Account People — response body — dob
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | JSON | Optional | |
day (anyOf 1) | JSON | Alternative | |
day (anyOf 1) (anyOf 1) | integer | Alternative | The day of birth, between 1 and 31. |
day (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
day (anyOf 2) | null | Alternative | |
month | JSON | Optional | |
month (anyOf 1) | JSON | Alternative | |
month (anyOf 1) (anyOf 1) | integer | Alternative | The month of birth, between 1 and 12. |
month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month (anyOf 2) | null | Alternative | |
year | JSON | Optional | |
year (anyOf 1) | JSON | Alternative | |
year (anyOf 1) (anyOf 1) | integer | Alternative | The four-digit year of birth. |
year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
year (anyOf 2) | null | Alternative |
Create a person — accounts post Accounts Account People — response body — future requirements value alternatives, currently due, errors, eventually due, past due, pending verification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
alternatives | JSON | Optional | |
alternatives (anyOf 1) | array | Alternative | Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. |
alternatives (anyOf 1)[] | Model | Each item | Expand Create an account — response body — requirements alternatives array item |
alternatives (anyOf 2) | null | Alternative | |
currently_due | array | Required within parent | Fields 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[] | string | Each item | Maximum length: 5000 |
errors | array | Required within parent | Fields that are `currently_due` and need to be collected again because validation or verification failed. |
errors[] | Model | Each item | Expand Update an Account Capability — response body — requirements errors item |
eventually_due | array | Required within parent | Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. |
eventually_due[] | string | Each item | Maximum length: 5000 |
past_due | array | Required within parent | Fields that haven't been resolved by 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[] | string | Each item | Maximum length: 5000 |
pending_verification | array | Required within parent | Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. |
pending_verification[] | string | Each item | Maximum length: 5000 |
Referenced models: Create an account — response body — requirements alternatives array item, Update an Account Capability — response body — requirements errors item
Create a person — accounts post Accounts Account People — response body — relationship
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authorizer | JSON | Optional | |
authorizer (anyOf 1) | boolean | Alternative | Whether the person is the authorizer of the account's representative. |
authorizer (anyOf 2) | null | Alternative | |
director | JSON | Optional | |
director (anyOf 1) | boolean | Alternative | Whether 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) | null | Alternative | |
executive | JSON | Optional | |
executive (anyOf 1) | boolean | Alternative | Whether the person has significant responsibility to control, manage, or direct the organization. |
executive (anyOf 2) | null | Alternative | |
legal_guardian | JSON | Optional | |
legal_guardian (anyOf 1) | boolean | Alternative | Whether the person is the legal guardian of the account's representative. |
legal_guardian (anyOf 2) | null | Alternative | |
owner | JSON | Optional | |
owner (anyOf 1) | boolean | Alternative | Whether the person is an owner of the account’s legal entity. |
owner (anyOf 2) | null | Alternative | |
percent_ownership | JSON | Optional | |
percent_ownership (anyOf 1) | JSON | Alternative | |
percent_ownership (anyOf 1) (anyOf 1) | number | Alternative | The percent owned by the person of the account's legal entity. |
percent_ownership (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
percent_ownership (anyOf 2) | null | Alternative | |
representative | JSON | Optional | |
representative (anyOf 1) | boolean | Alternative | Whether 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) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | The person's title (e.g., CEO, Support Engineer). Maximum length: 5000 |
title (anyOf 2) | null | Alternative |
Create a person — accounts post Accounts Account People — response body — requirements value alternatives, currently due, errors, eventually due, past due, pending verification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
alternatives | JSON | Optional | |
alternatives (anyOf 1) | array | Alternative | Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. |
alternatives (anyOf 1)[] | Model | Each item | Expand Create an account — response body — requirements alternatives array item |
alternatives (anyOf 2) | null | Alternative | |
currently_due | array | Required within parent | Fields 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[] | string | Each item | Maximum length: 5000 |
errors | array | Required within parent | Fields that are `currently_due` and need to be collected again because validation or verification failed. |
errors[] | Model | Each item | Expand Update an Account Capability — response body — requirements errors item |
eventually_due | array | Required within parent | Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. |
eventually_due[] | string | Each item | Maximum length: 5000 |
past_due | array | Required within parent | Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the person's account. |
past_due[] | string | Each item | Maximum length: 5000 |
pending_verification | array | Required within parent | Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. |
pending_verification[] | string | Each item | Maximum length: 5000 |
Referenced models: Create an account — response body — requirements alternatives array item, Update an Account Capability — response body — requirements errors item
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ethnicity_details | JSON | Optional | |
ethnicity_details (anyOf 1) | JSON | Alternative | The persons ethnicity details |
ethnicity_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
race_details | JSON | Optional | |
race_details (anyOf 1) | JSON | Alternative | The persons race details |
race_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
self_identified_gender | JSON | Optional | |
self_identified_gender (anyOf 1) | string | Alternative | The persons self-identified gender Maximum length: 5000 |
self_identified_gender (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ethnicity | JSON | Optional | |
ethnicity (anyOf 1) | array | Alternative | The persons ethnicity |
ethnicity (anyOf 1)[] | string | Each item | Known values: cuban, hispanic_or_latino, mexican, not_hispanic_or_latino, other_hispanic_or_latino, prefer_not_to_answer, puerto_rican |
ethnicity (anyOf 2) | null | Alternative | |
ethnicity_other | JSON | Optional | |
ethnicity_other (anyOf 1) | string | Alternative | Please specify your origin, when other is selected. Maximum length: 5000 |
ethnicity_other (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
race | JSON | Optional | |
race (anyOf 1) | array | Alternative | The persons race. |
race (anyOf 1)[] | string | Each item | Known 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) | null | Alternative | |
race_other | JSON | Optional | |
race_other (anyOf 1) | string | Alternative | Please specify your race, when other is selected. Maximum length: 5000 |
race_other (anyOf 2) | null | Alternative |
Create a person — accounts post Accounts Account People — response body — verification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_document | JSON | Optional | |
additional_document (anyOf 1) | JSON | Alternative | A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. |
additional_document (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a person — accounts post Accounts Account People — response body — verification document |
additional_document (anyOf 2) | null | Alternative | |
details | JSON | Optional | |
details (anyOf 1) | string | Alternative | A 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) | null | Alternative | |
details_code | JSON | Optional | |
details_code (anyOf 1) | string | Alternative | One 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) | null | Alternative | |
document | Model | Optional | Expand Create a person — accounts post Accounts Account People — response body — verification document |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
back | JSON | Optional | |
back (anyOf 1) | JSON | Alternative | The 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) | string | Alternative | Maximum length: 5000 |
back (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
back (anyOf 2) | null | Alternative | |
details | JSON | Optional | |
details (anyOf 1) | string | Alternative | A 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) | null | Alternative | |
details_code | JSON | Optional | |
details_code (anyOf 1) | string | Alternative | One 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) | null | Alternative | |
front | JSON | Optional | |
front (anyOf 1) | JSON | Alternative | The 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) | string | Alternative | Maximum length: 5000 |
front (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
front (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_holder_name | string | Optional | Maximum length: 5000 |
account_holder_type | string | Optional | One of: company, individual Maximum length: 5000 |
account_number | string | Required within parent | Maximum length: 5000 |
account_type | string | Optional | One of: checking, futsu, savings, toza Maximum length: 5000 |
country | string | Required within parent | Maximum length: 5000 |
currency | string | Optional | Format: currency |
documents | object | Optional | |
documents.bank_account_ownership_verification | object | Optional | |
documents.bank_account_ownership_verification.files | array | Optional | |
documents.bank_account_ownership_verification.files[] | string | Each item | Maximum length: 500 |
object | string | Optional | One of: bank_account Maximum length: 5000 |
routing_number | string | Optional | Maximum length: 5000 |
Create an account — request body — body business profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Business information about the account. |
annual_revenue | object | Optional | |
annual_revenue.amount | integer | Required within parent | |
annual_revenue.currency | string | Required within parent | Format: currency |
annual_revenue.fiscal_year_end | string | Required within parent | Maximum length: 5000 |
estimated_worker_count | integer | Optional | |
mcc | string | Optional | Maximum length: 4 |
minority_owned_business_designation | array | Optional | |
minority_owned_business_designation[] | string | Each item | One of: lgbtqi_owned_business, minority_owned_business, none_of_these_apply, prefer_not_to_answer, women_owned_business |
monthly_estimated_revenue | object | Optional | |
monthly_estimated_revenue.amount | integer | Required within parent | |
monthly_estimated_revenue.currency | string | Required within parent | Format: currency |
name | string | Optional | Maximum length: 5000 |
product_description | string | Optional | Maximum length: 40000 |
specified_commercial_transactions_act_url | JSON | Optional | |
specified_commercial_transactions_act_url (anyOf 1) | string | Alternative | |
specified_commercial_transactions_act_url (anyOf 2) | string | Alternative | One of: |
support_address | object | Optional | |
support_address.city | string | Optional | Maximum length: 100 |
support_address.country | string | Optional | Maximum length: 5000 |
support_address.line1 | string | Optional | Maximum length: 200 |
support_address.line2 | string | Optional | Maximum length: 200 |
support_address.postal_code | string | Optional | Maximum length: 5000 |
support_address.state | string | Optional | Maximum length: 5000 |
support_email | string | Optional | |
support_phone | string | Optional | Maximum length: 5000 |
support_url | JSON | Optional | |
support_url (anyOf 1) | string | Alternative | |
support_url (anyOf 2) | string | Alternative | One of: |
url | string | Optional |
Create an account — request body — body capabilities
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Each 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_payments | object | Optional | |
acss_debit_payments.requested | boolean | Optional | |
affirm_payments | object | Optional | |
affirm_payments.requested | boolean | Optional | |
afterpay_clearpay_payments | object | Optional | |
afterpay_clearpay_payments.requested | boolean | Optional | |
alma_payments | object | Optional | |
alma_payments.requested | boolean | Optional | |
amazon_pay_payments | object | Optional | |
amazon_pay_payments.requested | boolean | Optional | |
app_distribution | object | Optional | |
app_distribution.requested | boolean | Optional | |
au_becs_debit_payments | object | Optional | |
au_becs_debit_payments.requested | boolean | Optional | |
bacs_debit_payments | object | Optional | |
bacs_debit_payments.requested | boolean | Optional | |
bancontact_payments | object | Optional | |
bancontact_payments.requested | boolean | Optional | |
bank_transfer_payments | object | Optional | |
bank_transfer_payments.requested | boolean | Optional | |
billie_payments | object | Optional | |
billie_payments.requested | boolean | Optional | |
bizum_payments | object | Optional | |
bizum_payments.requested | boolean | Optional | |
blik_payments | object | Optional | |
blik_payments.requested | boolean | Optional | |
blik_recurring_payments | object | Optional | |
blik_recurring_payments.requested | boolean | Optional | |
boleto_payments | object | Optional | |
boleto_payments.requested | boolean | Optional | |
card_issuing | object | Optional | |
card_issuing.requested | boolean | Optional | |
card_payments | object | Optional | |
card_payments.requested | boolean | Optional | |
cartes_bancaires_payments | object | Optional | |
cartes_bancaires_payments.requested | boolean | Optional | |
cashapp_payments | object | Optional | |
cashapp_payments.requested | boolean | Optional | |
crypto_payments | object | Optional | |
crypto_payments.requested | boolean | Optional | |
eps_payments | object | Optional | |
eps_payments.requested | boolean | Optional | |
fpx_payments | object | Optional | |
fpx_payments.requested | boolean | Optional | |
gb_bank_transfer_payments | object | Optional | |
gb_bank_transfer_payments.requested | boolean | Optional | |
giropay_payments | object | Optional | |
giropay_payments.requested | boolean | Optional | |
grabpay_payments | object | Optional | |
grabpay_payments.requested | boolean | Optional | |
ideal_payments | object | Optional | |
ideal_payments.requested | boolean | Optional | |
india_international_payments | object | Optional | |
india_international_payments.requested | boolean | Optional | |
jcb_payments | object | Optional | |
jcb_payments.requested | boolean | Optional | |
jp_bank_transfer_payments | object | Optional | |
jp_bank_transfer_payments.requested | boolean | Optional | |
kakao_pay_payments | object | Optional | |
kakao_pay_payments.requested | boolean | Optional | |
klarna_payments | object | Optional | |
klarna_payments.requested | boolean | Optional | |
konbini_payments | object | Optional | |
konbini_payments.requested | boolean | Optional | |
kr_card_payments | object | Optional | |
kr_card_payments.requested | boolean | Optional | |
legacy_payments | object | Optional | |
legacy_payments.requested | boolean | Optional | |
link_payments | object | Optional | |
link_payments.requested | boolean | Optional | |
mb_way_payments | object | Optional | |
mb_way_payments.requested | boolean | Optional | |
mobilepay_payments | object | Optional | |
mobilepay_payments.requested | boolean | Optional | |
multibanco_payments | object | Optional | |
multibanco_payments.requested | boolean | Optional | |
mx_bank_transfer_payments | object | Optional | |
mx_bank_transfer_payments.requested | boolean | Optional | |
naver_pay_payments | object | Optional | |
naver_pay_payments.requested | boolean | Optional | |
nz_bank_account_becs_debit_payments | object | Optional | |
nz_bank_account_becs_debit_payments.requested | boolean | Optional | |
oxxo_payments | object | Optional | |
oxxo_payments.requested | boolean | Optional | |
p24_payments | object | Optional | |
p24_payments.requested | boolean | Optional | |
pay_by_bank_payments | object | Optional | |
pay_by_bank_payments.requested | boolean | Optional | |
payco_payments | object | Optional | |
payco_payments.requested | boolean | Optional | |
paynow_payments | object | Optional | |
paynow_payments.requested | boolean | Optional | |
paypay_payments | object | Optional | |
paypay_payments.requested | boolean | Optional | |
payto_payments | object | Optional | |
payto_payments.requested | boolean | Optional | |
pix_payments | object | Optional | |
pix_payments.requested | boolean | Optional | |
promptpay_payments | object | Optional | |
promptpay_payments.requested | boolean | Optional | |
revolut_pay_payments | object | Optional | |
revolut_pay_payments.requested | boolean | Optional | |
samsung_pay_payments | object | Optional | |
samsung_pay_payments.requested | boolean | Optional | |
satispay_payments | object | Optional | |
satispay_payments.requested | boolean | Optional | |
scalapay_payments | object | Optional | |
scalapay_payments.requested | boolean | Optional | |
sepa_bank_transfer_payments | object | Optional | |
sepa_bank_transfer_payments.requested | boolean | Optional | |
sepa_debit_payments | object | Optional | |
sepa_debit_payments.requested | boolean | Optional | |
sequra_payments | object | Optional | |
sequra_payments.requested | boolean | Optional | |
sofort_payments | object | Optional | |
sofort_payments.requested | boolean | Optional | |
sunbit_payments | object | Optional | |
sunbit_payments.requested | boolean | Optional | |
swish_payments | object | Optional | |
swish_payments.requested | boolean | Optional | |
tax_reporting_us_1099_k | object | Optional | |
tax_reporting_us_1099_k.requested | boolean | Optional | |
tax_reporting_us_1099_misc | object | Optional | |
tax_reporting_us_1099_misc.requested | boolean | Optional | |
transfers | object | Optional | |
transfers.requested | boolean | Optional | |
treasury | object | Optional | |
treasury.requested | boolean | Optional | |
twint_payments | object | Optional | |
twint_payments.requested | boolean | Optional | |
upi_payments | object | Optional | |
upi_payments.requested | boolean | Optional | |
us_bank_account_ach_payments | object | Optional | |
us_bank_account_ach_payments.requested | boolean | Optional | |
us_bank_transfer_payments | object | Optional | |
us_bank_transfer_payments.requested | boolean | Optional | |
zip_payments | object | Optional | |
zip_payments.requested | boolean | Optional |
Create an account — request body — body company
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information 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. |
address | object | Optional | |
address.city | string | Optional | Maximum length: 100 |
address.country | string | Optional | Maximum length: 5000 |
address.line1 | string | Optional | Maximum length: 200 |
address.line2 | string | Optional | Maximum length: 200 |
address.postal_code | string | Optional | Maximum length: 5000 |
address.state | string | Optional | Maximum length: 5000 |
address_kana | object | Optional | |
address_kana.city | string | Optional | Maximum length: 5000 |
address_kana.country | string | Optional | Maximum length: 5000 |
address_kana.line1 | string | Optional | Maximum length: 5000 |
address_kana.line2 | string | Optional | Maximum length: 5000 |
address_kana.postal_code | string | Optional | Maximum length: 5000 |
address_kana.state | string | Optional | Maximum length: 5000 |
address_kana.town | string | Optional | Maximum length: 5000 |
address_kanji | object | Optional | |
address_kanji.city | string | Optional | Maximum length: 5000 |
address_kanji.country | string | Optional | Maximum length: 5000 |
address_kanji.line1 | string | Optional | Maximum length: 5000 |
address_kanji.line2 | string | Optional | Maximum length: 5000 |
address_kanji.postal_code | string | Optional | Maximum length: 5000 |
address_kanji.state | string | Optional | Maximum length: 5000 |
address_kanji.town | string | Optional | Maximum length: 5000 |
administrative_address | object | Optional | |
administrative_address.city | string | Optional | Maximum length: 100 |
administrative_address.country | string | Optional | Maximum length: 5000 |
administrative_address.line1 | string | Optional | Maximum length: 200 |
administrative_address.line2 | string | Optional | Maximum length: 200 |
administrative_address.postal_code | string | Optional | Maximum length: 5000 |
administrative_address.state | string | Optional | Maximum length: 5000 |
directors_provided | boolean | Optional | |
directorship_declaration | object | Optional | |
directorship_declaration.date | integer | Optional | Format: unix-time |
directorship_declaration.ip | string | Optional | |
directorship_declaration.user_agent | string | Optional | Maximum length: 5000 |
executives_provided | boolean | Optional | |
export_license_id | string | Optional | Maximum length: 5000 |
export_purpose_code | string | Optional | Maximum length: 5000 |
name | string | Optional | Maximum length: 200 |
name_kana | string | Optional | Maximum length: 200 |
name_kanji | string | Optional | Maximum length: 200 |
owners_provided | boolean | Optional | |
ownership_declaration | object | Optional | |
ownership_declaration.date | integer | Optional | Format: unix-time |
ownership_declaration.ip | string | Optional | |
ownership_declaration.user_agent | string | Optional | Maximum length: 5000 |
ownership_exemption_reason | string | Optional | One of: , qualified_entity_exceeds_ownership_threshold, qualifies_as_financial_institution |
phone | string | Optional | Maximum length: 5000 |
principal_place_of_business | object | Optional | |
principal_place_of_business.city | string | Optional | Maximum length: 100 |
principal_place_of_business.country | string | Optional | Maximum length: 5000 |
principal_place_of_business.line1 | string | Optional | Maximum length: 200 |
principal_place_of_business.line2 | string | Optional | Maximum length: 200 |
principal_place_of_business.postal_code | string | Optional | Maximum length: 5000 |
principal_place_of_business.state | string | Optional | Maximum length: 5000 |
registration_date | JSON | Optional | |
registration_date (anyOf 1) | object | Alternative | |
registration_date (anyOf 1).day | integer | Required within parent | |
registration_date (anyOf 1).month | integer | Required within parent | |
registration_date (anyOf 1).year | integer | Required within parent | |
registration_date (anyOf 2) | string | Alternative | One of: |
registration_number | string | Optional | Maximum length: 5000 |
representative_declaration | object | Optional | |
representative_declaration.date | integer | Optional | Format: unix-time |
representative_declaration.ip | string | Optional | |
representative_declaration.user_agent | string | Optional | Maximum length: 5000 |
structure | string | Optional | One 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_id | string | Optional | Maximum length: 5000 |
tax_id_registrar | string | Optional | Maximum length: 5000 |
vat_id | string | Optional | Maximum length: 5000 |
verification | object | Optional | |
verification.document | object | Optional | |
verification.document.back | string | Optional | Maximum length: 500 |
verification.document.front | string | Optional | Maximum length: 500 |
Create an account — request body — body individual
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information 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. |
address | object | Optional | |
address.city | string | Optional | Maximum length: 100 |
address.country | string | Optional | Maximum length: 5000 |
address.line1 | string | Optional | Maximum length: 200 |
address.line2 | string | Optional | Maximum length: 200 |
address.postal_code | string | Optional | Maximum length: 5000 |
address.state | string | Optional | Maximum length: 5000 |
address_kana | object | Optional | |
address_kana.city | string | Optional | Maximum length: 5000 |
address_kana.country | string | Optional | Maximum length: 5000 |
address_kana.line1 | string | Optional | Maximum length: 5000 |
address_kana.line2 | string | Optional | Maximum length: 5000 |
address_kana.postal_code | string | Optional | Maximum length: 5000 |
address_kana.state | string | Optional | Maximum length: 5000 |
address_kana.town | string | Optional | Maximum length: 5000 |
address_kanji | object | Optional | |
address_kanji.city | string | Optional | Maximum length: 5000 |
address_kanji.country | string | Optional | Maximum length: 5000 |
address_kanji.line1 | string | Optional | Maximum length: 5000 |
address_kanji.line2 | string | Optional | Maximum length: 5000 |
address_kanji.postal_code | string | Optional | Maximum length: 5000 |
address_kanji.state | string | Optional | Maximum length: 5000 |
address_kanji.town | string | Optional | Maximum length: 5000 |
dob | JSON | Optional | |
dob (anyOf 1) | object | Alternative | |
dob (anyOf 1).day | integer | Required within parent | |
dob (anyOf 1).month | integer | Required within parent | |
dob (anyOf 1).year | integer | Required within parent | |
dob (anyOf 2) | string | Alternative | One of: |
email | string | Optional | |
first_name | string | Optional | Maximum length: 100 |
first_name_kana | string | Optional | Maximum length: 5000 |
first_name_kanji | string | Optional | Maximum length: 5000 |
full_name_aliases | JSON | Optional | |
full_name_aliases (anyOf 1) | array | Alternative | |
full_name_aliases (anyOf 1)[] | string | Each item | Maximum length: 300 |
full_name_aliases (anyOf 2) | string | Alternative | One of: |
gender | string | Optional | |
id_number | string | Optional | Maximum length: 5000 |
id_number_secondary | string | Optional | Maximum length: 5000 |
last_name | string | Optional | Maximum length: 100 |
last_name_kana | string | Optional | Maximum length: 5000 |
last_name_kanji | string | Optional | Maximum length: 5000 |
maiden_name | string | Optional | Maximum length: 5000 |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | |
metadata (anyOf 2) | string | Alternative | One of: |
phone | string | Optional | |
political_exposure | string | Optional | One of: existing, none |
registered_address | object | Optional | |
registered_address.city | string | Optional | Maximum length: 100 |
registered_address.country | string | Optional | Maximum length: 5000 |
registered_address.line1 | string | Optional | Maximum length: 200 |
registered_address.line2 | string | Optional | Maximum length: 200 |
registered_address.postal_code | string | Optional | Maximum length: 5000 |
registered_address.state | string | Optional | Maximum length: 5000 |
relationship | object | Optional | |
relationship.director | boolean | Optional | |
relationship.executive | boolean | Optional | |
relationship.owner | boolean | Optional | |
relationship.percent_ownership | JSON | Optional | |
relationship.percent_ownership (anyOf 1) | number | Alternative | |
relationship.percent_ownership (anyOf 2) | string | Alternative | One of: |
relationship.title | string | Optional | Maximum length: 5000 |
ssn_last_4 | string | Optional | Maximum length: 5000 |
verification | object | Optional | |
verification.additional_document | object | Optional | |
verification.additional_document.back | string | Optional | Maximum length: 500 |
verification.additional_document.front | string | Optional | Maximum length: 500 |
verification.document | object | Optional | |
verification.document.back | string | Optional | Maximum length: 500 |
verification.document.front | string | Optional | Maximum length: 500 |
Create an account — request body — body settings payouts
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
debit_negative_balances | boolean | Optional | |
schedule | Model | Optional | Expand Create an account — request body — body settings payouts schedule |
statement_descriptor | string | Optional | Maximum length: 22 |
Referenced models: Create an account — request body — body settings payouts schedule
Create an account — request body — body settings payouts schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
delay_days | JSON | Optional | |
delay_days (anyOf 1) | string | Alternative | One of: minimum Maximum length: 5000 |
delay_days (anyOf 2) | integer | Alternative | |
interval | string | Optional | One of: daily, manual, monthly, weekly Maximum length: 5000 |
monthly_anchor | integer | Optional | |
monthly_payout_days | array | Optional | |
monthly_payout_days[] | integer | Each item | |
weekly_anchor | string | Optional | One of: friday, monday, saturday, sunday, thursday, tuesday, wednesday Maximum length: 5000 |
weekly_payout_days | array | Optional | |
weekly_payout_days[] | string | Each item | One of: friday, monday, thursday, tuesday, wednesday |
Create an account — request body — body settings paypay payments
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_files | array | Optional | |
additional_files[] | string | Each item | Maximum length: 5000 |
goods_type | string | Optional | One of: digital_content, other |
site | object | Optional | |
site.accessible | object | Optional | |
site.in_development | object | Optional | |
site.in_development.password | string | Required within parent | Maximum length: 5000 |
site.in_development.username | string | Optional | Maximum length: 5000 |
site.restricted | object | Optional | |
site.restricted.payment_flow_file | string | Optional | Maximum length: 5000 |
site.type | string | Optional | One of: accessible, in_development, restricted |
Create an account — request body — body tos acceptance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details 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. |
date | integer | Optional | Format: unix-time |
ip | string | Optional | |
service_agreement | string | Optional | Maximum length: 5000 |
user_agent | string | Optional | Maximum length: 5000 |
Create an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | For 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_profile | JSON | Optional | |
business_profile (anyOf 1) | JSON | Alternative | Business information about the account. |
business_profile (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
business_type | JSON | Optional | |
business_type (anyOf 1) | string | Alternative | The business type. Known values: company, government_entity, individual, non_profit |
business_type (anyOf 2) | null | Alternative | |
capabilities | Model | Optional | Expand Create an account — response body — capabilities |
charges_enabled | boolean | Optional | Whether the account can process charges. |
company | Model | Optional | Expand Create an account — response body — company |
controller | Model | Optional | Expand Create an account — response body — controller |
country | string | Optional | The account's country. Maximum length: 5000 |
created | JSON | Optional | |
created (anyOf 1) | integer | Alternative | Time at which the account was connected. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
default_currency | string | Optional | Three-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_submitted | boolean | Optional | Whether 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. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | An 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) | null | Alternative | |
external_accounts | object | Optional | External 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.data | array | Required within parent | The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. |
external_accounts.data[] | JSON | Each item | |
external_accounts.data[] (anyOf 1) | Model | Alternative | Expand Retrieve a bank account — response body |
external_accounts.data[] (anyOf 2) | Model | Alternative | Expand Retrieve a card — customers get Customers Customer Cards Id — response body |
external_accounts.has_more | boolean | Required within parent | True if this list has another page of items after this one that can be fetched. |
external_accounts.object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list |
external_accounts.url | string | Required within parent | The URL where this list can be accessed. Maximum length: 5000 |
future_requirements | Model | Optional | Expand Create an account — response body — future requirements |
groups | JSON | Optional | |
groups (anyOf 1) | JSON | Alternative | The groups associated with the account. |
groups (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create an account — response body — groups The groups associated with the account payments pricing |
groups (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
individual | Model | Optional | Expand Create a person — accounts post Accounts Account People — response body |
metadata | object | Optional | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: account |
payouts_enabled | boolean | Optional | Whether the funds in this account can be paid out. |
requirements | Model | Optional | Expand Create an account — response body — requirements |
settings | JSON | Optional | |
settings (anyOf 1) | JSON | Alternative | Options for customizing how the account functions within Stripe. |
settings (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury |
settings (anyOf 2) | null | Alternative | |
tos_acceptance | Model | Optional | Expand Create an account — response body — tos acceptance |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
annual_revenue | JSON | Optional | |
annual_revenue (anyOf 1) | JSON | Alternative | The applicant's gross annual revenue for its preceding fiscal year. |
annual_revenue (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
estimated_worker_count | JSON | Optional | |
estimated_worker_count (anyOf 1) | JSON | Alternative | |
estimated_worker_count (anyOf 1) (anyOf 1) | integer | Alternative | An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. |
estimated_worker_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
estimated_worker_count (anyOf 2) | null | Alternative | |
mcc | JSON | Optional | |
mcc (anyOf 1) | string | Alternative | [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) | null | Alternative | |
minority_owned_business_designation | JSON | Optional | |
minority_owned_business_designation (anyOf 1) | array | Alternative | Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business. |
minority_owned_business_designation (anyOf 1)[] | string | Each item | Known values: lgbtqi_owned_business, minority_owned_business, none_of_these_apply, prefer_not_to_answer, women_owned_business |
minority_owned_business_designation (anyOf 2) | null | Alternative | |
monthly_estimated_revenue | Model | Optional | Expand 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 |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The customer-facing business name. Maximum length: 5000 |
name (anyOf 2) | null | Alternative | |
product_description | JSON | Optional | |
product_description (anyOf 1) | string | Alternative | Internal-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) | null | Alternative | |
specified_commercial_transactions_act_url | JSON | Optional | |
specified_commercial_transactions_act_url (anyOf 1) | string | Alternative | A 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) | null | Alternative | |
support_address | JSON | Optional | |
support_address (anyOf 1) | JSON | Alternative | A publicly available mailing address for sending support issues to. |
support_address (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address |
support_address (anyOf 2) | null | Alternative | |
support_email | JSON | Optional | |
support_email (anyOf 1) | string | Alternative | A publicly available email address for sending support issues to. Maximum length: 5000 |
support_email (anyOf 2) | null | Alternative | |
support_phone | JSON | Optional | |
support_phone (anyOf 1) | string | Alternative | A publicly available phone number to call with support issues. Maximum length: 5000 |
support_phone (anyOf 2) | null | Alternative | |
support_url | JSON | Optional | |
support_url (anyOf 1) | string | Alternative | A publicly available website for handling support issues. Maximum length: 5000 |
support_url (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The business's publicly available website. Maximum length: 5000 |
url (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | integer | Alternative | A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | Three-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) | null | Alternative | |
fiscal_year_end | JSON | Optional | |
fiscal_year_end (anyOf 1) | string | Alternative | The 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
acss_debit_payments | string | Optional | The 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_payments | string | Optional | The status of the Affirm capability of the account, or whether the account can directly process Affirm charges. Known values: active, inactive, pending |
afterpay_clearpay_payments | string | Optional | The 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_payments | string | Optional | The status of the Alma capability of the account, or whether the account can directly process Alma payments. Known values: active, inactive, pending |
amazon_pay_payments | string | Optional | The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. Known values: active, inactive, pending |
app_distribution | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The status of the Billie capability of the account, or whether the account can directly process Billie payments. Known values: active, inactive, pending |
bizum_payments | string | Optional | The status of the Bizum capability of the account, or whether the account can directly process Bizum payments. Known values: active, inactive, pending |
blik_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. Known values: active, inactive, pending |
card_issuing | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The status of the Crypto capability of the account, or whether the account can directly process Crypto payments. Known values: active, inactive, pending |
eps_payments | string | Optional | The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. Known values: active, inactive, pending |
fpx_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. Known values: active, inactive, pending |
grabpay_payments | string | Optional | The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. Known values: active, inactive, pending |
ideal_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments. Known values: active, inactive, pending |
klarna_payments | string | Optional | The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. Known values: active, inactive, pending |
konbini_payments | string | Optional | The 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_payments | string | Optional | The status of the KrCard capability of the account, or whether the account can directly process KrCard payments. Known values: active, inactive, pending |
legacy_payments | string | Optional | The status of the legacy payments capability of the account. Known values: active, inactive, pending |
link_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges. Known values: active, inactive, pending |
multibanco_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. Known values: active, inactive, pending |
p24_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The status of the Payco capability of the account, or whether the account can directly process Payco payments. Known values: active, inactive, pending |
paynow_payments | string | Optional | The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. Known values: active, inactive, pending |
paypay_payments | string | Optional | The status of the Paypay capability of the account, or whether the account can directly process Paypay payments. Known values: active, inactive, pending |
payto_payments | string | Optional | The status of the PayTo capability of the account, or whether the account can directly process PayTo charges. Known values: active, inactive, pending |
pix_payments | string | Optional | The status of the pix payments capability of the account, or whether the account can directly process pix charges. Known values: active, inactive, pending |
promptpay_payments | string | Optional | The 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_payments | string | Optional | The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. Known values: active, inactive, pending |
samsung_pay_payments | string | Optional | The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments. Known values: active, inactive, pending |
satispay_payments | string | Optional | The status of the Satispay capability of the account, or whether the account can directly process Satispay payments. Known values: active, inactive, pending |
scalapay_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The status of the SeQura capability of the account, or whether the account can directly process SeQura payments. Known values: active, inactive, pending |
sofort_payments | string | Optional | The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. Known values: active, inactive, pending |
sunbit_payments | string | Optional | The status of the Sunbit capability of the account, or whether the account can directly process Sunbit payments. Known values: active, inactive, pending |
swish_payments | string | Optional | The 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_k | string | Optional | The status of the tax reporting 1099-K (US) capability of the account. Known values: active, inactive, pending |
tax_reporting_us_1099_misc | string | Optional | The status of the tax reporting 1099-MISC (US) capability of the account. Known values: active, inactive, pending |
transfers | string | Optional | The status of the transfers capability of the account, or whether your platform can transfer funds to the account. Known values: active, inactive, pending |
treasury | string | Optional | The status of the banking capability, or whether the account can have bank accounts. Known values: active, inactive, pending |
twint_payments | string | Optional | The status of the TWINT capability of the account, or whether the account can directly process TWINT charges. Known values: active, inactive, pending |
upi_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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_payments | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Create a Location — response body — address |
address_kana | JSON | Optional | |
address_kana (anyOf 1) | JSON | Alternative | The Kana variation of the company's primary address (Japan only). |
address_kana (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address kana |
address_kana (anyOf 2) | null | Alternative | |
address_kanji | JSON | Optional | |
address_kanji (anyOf 1) | JSON | Alternative | The Kanji variation of the company's primary address (Japan only). |
address_kanji (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address kana |
address_kanji (anyOf 2) | null | Alternative | |
administrative_address | Model | Optional | Expand Create a Location — response body — address |
directors_provided | boolean | Optional | Whether 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_declaration | JSON | Optional | |
directorship_declaration (anyOf 1) | JSON | Alternative | This hash is used to attest that the director information provided to Stripe is both current and correct. |
directorship_declaration (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create an account — response body — company directorship declaration value date, ip, user agent |
directorship_declaration (anyOf 2) | null | Alternative | |
executives_provided | boolean | Optional | Whether 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_id | string | Optional | The export license ID number of the company, also referred as Import Export Code (India only). Maximum length: 5000 |
export_purpose_code | string | Optional | The purpose code to use for export transactions (India only). Maximum length: 5000 |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
name_kana | JSON | Optional | |
name_kana (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
name_kanji | JSON | Optional | |
name_kanji (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
owners_provided | boolean | Optional | Whether 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_declaration | JSON | Optional | |
ownership_declaration (anyOf 1) | JSON | Alternative | This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. |
ownership_declaration (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create an account — response body — company ownership declaration value date, ip, user agent |
ownership_declaration (anyOf 2) | null | Alternative | |
ownership_exemption_reason | string | Optional | This 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 |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | The company's phone number (used for verification). Maximum length: 5000 |
phone (anyOf 2) | null | Alternative | |
principal_place_of_business | Model | Optional | Expand Create a Location — response body — address |
registration_date | Model | Optional | Expand Create an account — response body — company registration date |
representative_declaration | JSON | Optional | |
representative_declaration (anyOf 1) | JSON | Alternative | This 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) | Model | Alternative | Expand Create an account — response body — company representative declaration value date, ip, user agent |
representative_declaration (anyOf 2) | null | Alternative | |
structure | string | Optional | The 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_provided | boolean | Optional | Whether the company's business ID number was provided. |
tax_id_registrar | string | Optional | The jurisdiction in which the `tax_id` is registered (Germany-based companies only). Maximum length: 5000 |
vat_id_provided | boolean | Optional | Whether the company's business VAT number was provided. |
verification | JSON | Optional | |
verification (anyOf 1) | JSON | Alternative | Information on the verification state of the company. |
verification (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create an account — response body — company verification value document |
verification (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | JSON | Optional | |
date (anyOf 1) | JSON | Alternative | |
date (anyOf 1) (anyOf 1) | integer | Alternative | The Unix timestamp marking when the directorship declaration attestation was made. Format: unix-time |
date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
date (anyOf 2) | null | Alternative | |
ip | JSON | Optional | |
ip (anyOf 1) | string | Alternative | The IP address from which the directorship declaration attestation was made. Maximum length: 5000 |
ip (anyOf 2) | null | Alternative | |
user_agent | JSON | Optional | |
user_agent (anyOf 1) | string | Alternative | The user-agent string from the browser where the directorship declaration attestation was made. Maximum length: 5000 |
user_agent (anyOf 2) | null | Alternative |
Create an account — response body — company ownership declaration value date, ip, user agent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | JSON | Optional | |
date (anyOf 1) | JSON | Alternative | |
date (anyOf 1) (anyOf 1) | integer | Alternative | The Unix timestamp marking when the beneficial owner attestation was made. Format: unix-time |
date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
date (anyOf 2) | null | Alternative | |
ip | JSON | Optional | |
ip (anyOf 1) | string | Alternative | The IP address from which the beneficial owner attestation was made. Maximum length: 5000 |
ip (anyOf 2) | null | Alternative | |
user_agent | JSON | Optional | |
user_agent (anyOf 1) | string | Alternative | The user-agent string from the browser where the beneficial owner attestation was made. Maximum length: 5000 |
user_agent (anyOf 2) | null | Alternative |
Create an account — response body — company registration date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | JSON | Optional | |
day (anyOf 1) | JSON | Alternative | |
day (anyOf 1) (anyOf 1) | integer | Alternative | The day of registration, between 1 and 31. |
day (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
day (anyOf 2) | null | Alternative | |
month | JSON | Optional | |
month (anyOf 1) | JSON | Alternative | |
month (anyOf 1) (anyOf 1) | integer | Alternative | The month of registration, between 1 and 12. |
month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month (anyOf 2) | null | Alternative | |
year | JSON | Optional | |
year (anyOf 1) | JSON | Alternative | |
year (anyOf 1) (anyOf 1) | integer | Alternative | The four-digit year of registration. |
year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
year (anyOf 2) | null | Alternative |
Create an account — response body — company representative declaration value date, ip, user agent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | JSON | Optional | |
date (anyOf 1) | JSON | Alternative | |
date (anyOf 1) (anyOf 1) | integer | Alternative | The Unix timestamp marking when the representative declaration attestation was made. Format: unix-time |
date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
date (anyOf 2) | null | Alternative | |
ip | JSON | Optional | |
ip (anyOf 1) | string | Alternative | The IP address from which the representative declaration attestation was made. Maximum length: 5000 |
ip (anyOf 2) | null | Alternative | |
user_agent | JSON | Optional | |
user_agent (anyOf 1) | string | Alternative | The user-agent string from the browser where the representative declaration attestation was made. Maximum length: 5000 |
user_agent (anyOf 2) | null | Alternative |
Create an account — response body — company verification value document
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
document | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
back | JSON | Optional | |
back (anyOf 1) | JSON | Alternative | The 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) | string | Alternative | Maximum length: 5000 |
back (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
back (anyOf 2) | null | Alternative | |
details | JSON | Optional | |
details (anyOf 1) | string | Alternative | A user-displayable string describing the verification state of this document. Maximum length: 5000 |
details (anyOf 2) | null | Alternative | |
details_code | JSON | Optional | |
details_code (anyOf 1) | string | Alternative | One 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) | null | Alternative | |
front | JSON | Optional | |
front (anyOf 1) | JSON | Alternative | The 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) | string | Alternative | Maximum length: 5000 |
front (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
front (anyOf 2) | null | Alternative |
Referenced models: Create a file — response body
Create an account — response body — controller
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fees | Model | Optional | Expand Create an account — response body — controller fees |
is_controller | boolean | Optional | `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. |
losses | Model | Optional | Expand Create an account — response body — controller losses |
requirement_collection | string | Optional | A 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_dashboard | Model | Optional | Expand Create an account — response body — controller stripe dashboard |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payer | string | Required within parent | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payments | string | Required within parent | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
alternatives | JSON | Optional | |
alternatives (anyOf 1) | array | Alternative | Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. |
alternatives (anyOf 1)[] | Model | Each item | Expand Create an account — response body — requirements alternatives array item |
alternatives (anyOf 2) | null | Alternative | |
current_deadline | JSON | Optional | |
current_deadline (anyOf 1) | JSON | Alternative | |
current_deadline (anyOf 1) (anyOf 1) | integer | Alternative | Date 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
current_deadline (anyOf 2) | null | Alternative | |
currently_due | JSON | Optional | |
currently_due (anyOf 1) | array | Alternative | Fields that need to be resolved to keep the account enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. |
currently_due (anyOf 1)[] | string | Each item | Maximum length: 5000 |
currently_due (anyOf 2) | null | Alternative | |
disabled_reason | JSON | Optional | |
disabled_reason (anyOf 1) | string | Alternative | This 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) | null | Alternative | |
errors | JSON | Optional | |
errors (anyOf 1) | array | Alternative | Fields that are `currently_due` and need to be collected again because validation or verification failed. |
errors (anyOf 1)[] | Model | Each item | Expand Update an Account Capability — response body — requirements errors item |
errors (anyOf 2) | null | Alternative | |
eventually_due | JSON | Optional | |
eventually_due (anyOf 1) | array | Alternative | Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. |
eventually_due (anyOf 1)[] | string | Each item | Maximum length: 5000 |
eventually_due (anyOf 2) | null | Alternative | |
past_due | JSON | Optional | |
past_due (anyOf 1) | array | Alternative | Fields that haven't been resolved by `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)[] | string | Each item | Maximum length: 5000 |
past_due (anyOf 2) | null | Alternative | |
pending_verification | JSON | Optional | |
pending_verification (anyOf 1) | array | Alternative | Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. |
pending_verification (anyOf 1)[] | string | Each item | Maximum length: 5000 |
pending_verification (anyOf 2) | null | Alternative |
Referenced models: Create an account — response body — requirements alternatives array item, Update an Account Capability — response body — requirements errors item
Create an account — response body — groups The groups associated with the account payments pricing
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payments_pricing | JSON | Optional | |
payments_pricing (anyOf 1) | string | Alternative | The 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) | null | Alternative |