With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.
If you’ve already collected information for your connected accounts, you can prefill that information when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.
Parameters
- business_
typeenum The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is
application
, which includes Custom accounts.Possible enum valuescompany
government_
entity US only
individual
non_
profit - capabilitiesobjectRequired conditionally
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 is
none
, which includes Custom accounts.- capabilities.
acss_ debit_ paymentsobject The acss_debit_payments capability.
- capabilities.
acss_debit_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
affirm_ paymentsobject The affirm_payments capability.
- capabilities.
affirm_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
afterpay_ clearpay_ paymentsobject The afterpay_clearpay_payments capability.
- capabilities.
afterpay_clearpay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
alma_ paymentsobject The alma_payments capability.
- capabilities.
alma_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
amazon_ pay_ paymentsobject The amazon_pay_payments capability.
- capabilities.
amazon_pay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
au_ becs_ debit_ paymentsobject The au_becs_debit_payments capability.
- capabilities.
au_becs_debit_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
bacs_ debit_ paymentsobject The bacs_debit_payments capability.
- capabilities.
bacs_debit_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
bancontact_ paymentsobject The bancontact_payments capability.
- capabilities.
bancontact_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
bank_ transfer_ paymentsobject The bank_transfer_payments capability.
- capabilities.
bank_transfer_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
billie_ paymentsobject The billie_payments capability.
- capabilities.
billie_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
blik_ paymentsobject The blik_payments capability.
- capabilities.
blik_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
boleto_ paymentsobject The boleto_payments capability.
- capabilities.
boleto_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
card_ issuingobject The card_issuing capability.
- capabilities.
card_issuing. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
card_ paymentsobject The card_payments capability.
- capabilities.
card_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
cartes_ bancaires_ paymentsobject The cartes_bancaires_payments capability.
- capabilities.
cartes_bancaires_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
cashapp_ paymentsobject The cashapp_payments capability.
- capabilities.
cashapp_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
crypto_ paymentsobject The crypto_payments capability.
- capabilities.
crypto_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
eps_ paymentsobject The eps_payments capability.
- capabilities.
eps_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
fpx_ paymentsobject The fpx_payments capability.
- capabilities.
fpx_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
gb_ bank_ transfer_ paymentsobject The gb_bank_transfer_payments capability.
- capabilities.
gb_bank_transfer_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
giropay_ paymentsobject The giropay_payments capability.
- capabilities.
giropay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
grabpay_ paymentsobject The grabpay_payments capability.
- capabilities.
grabpay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
ideal_ paymentsobject The ideal_payments capability.
- capabilities.
ideal_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
india_ international_ paymentsobject The india_international_payments capability.
- capabilities.
india_international_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
jcb_ paymentsobject The jcb_payments capability.
- capabilities.
jcb_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
jp_ bank_ transfer_ paymentsobject The jp_bank_transfer_payments capability.
- capabilities.
jp_bank_transfer_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
kakao_ pay_ paymentsobject The kakao_pay_payments capability.
- capabilities.
kakao_pay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
klarna_ paymentsobject The klarna_payments capability.
- capabilities.
klarna_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
konbini_ paymentsobject The konbini_payments capability.
- capabilities.
konbini_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
kr_ card_ paymentsobject The kr_card_payments capability.
- capabilities.
kr_card_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
legacy_ paymentsobject The legacy_payments capability.
- capabilities.
legacy_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
link_ paymentsobject The link_payments capability.
- capabilities.
link_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
mobilepay_ paymentsobject The mobilepay_payments capability.
- capabilities.
mobilepay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
multibanco_ paymentsobject The multibanco_payments capability.
- capabilities.
multibanco_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
mx_ bank_ transfer_ paymentsobject The mx_bank_transfer_payments capability.
- capabilities.
mx_bank_transfer_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
object The naver_pay_payments capability.
- capabilities.
naver_pay_payments. boolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
nz_ bank_ account_ becs_ debit_ paymentsobject The nz_bank_account_becs_debit_payments capability.
- capabilities.
nz_bank_account_becs_debit_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
oxxo_ paymentsobject The oxxo_payments capability.
- capabilities.
oxxo_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
p24_ paymentsobject The p24_payments capability.
- capabilities.
p24_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
pay_ by_ bank_ paymentsobject The pay_by_bank_payments capability.
- capabilities.
pay_by_bank_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
payco_ paymentsobject The payco_payments capability.
- capabilities.
payco_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
paynow_ paymentsobject The paynow_payments capability.
- capabilities.
paynow_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
pix_ paymentsobject The pix_payments capability.
- capabilities.
pix_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
promptpay_ paymentsobject The promptpay_payments capability.
- capabilities.
promptpay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
revolut_ pay_ paymentsobject The revolut_pay_payments capability.
- capabilities.
revolut_pay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
samsung_ pay_ paymentsobject The samsung_pay_payments capability.
- capabilities.
samsung_pay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
satispay_ paymentsobject The satispay_payments capability.
- capabilities.
satispay_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
sepa_ bank_ transfer_ paymentsobject The sepa_bank_transfer_payments capability.
- capabilities.
sepa_bank_transfer_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
sepa_ debit_ paymentsobject The sepa_debit_payments capability.
- capabilities.
sepa_debit_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
sofort_ paymentsobject The sofort_payments capability.
- capabilities.
sofort_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
swish_ paymentsobject The swish_payments capability.
- capabilities.
swish_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
tax_ reporting_ us_ 1099_ kobject The tax_reporting_us_1099_k capability.
- capabilities.
tax_reporting_us_1099_k. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
tax_ reporting_ us_ 1099_ miscobject The tax_reporting_us_1099_misc capability.
- capabilities.
tax_reporting_us_1099_misc. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
transfersobject The transfers capability.
- capabilities.
transfers. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
twint_ paymentsobject The twint_payments capability.
- capabilities.
twint_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
us_ bank_ account_ ach_ paymentsobject The us_bank_account_ach_payments capability.
- capabilities.
us_bank_account_ach_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
us_ bank_ transfer_ paymentsobject The us_bank_transfer_payments capability.
- capabilities.
us_bank_transfer_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- capabilities.
zip_ paymentsobject The zip_payments capability.
- capabilities.
zip_payments. requestedboolean Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the
requirements
arrays.
- companyobject
Information about the company or business. This field is available for any
business_
. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection istype application
, which includes Custom accounts.- company.
addressobject The company’s primary address.
- company.
address. citystring City, district, suburb, town, or village.
- company.
address. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- company.
address. line1string Address line 1 (e.g., street, PO Box, or company name).
- company.
address. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- company.
address. postal_ codestring ZIP or postal code.
- company.
address. statestring State, county, province, or region.
- company.
address_ kanaobject The Kana variation of the company’s primary address (Japan only).
- company.
address_kana. citystring City or ward.
- company.
address_kana. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- company.
address_kana. line1string Block or building number.
- company.
address_kana. line2string Building details.
- company.
address_kana. postal_ codestring Postal code.
- company.
address_kana. statestring Prefecture.
- company.
address_kana. townstring Town or cho-me.
- company.
address_ kanjiobject The Kanji variation of the company’s primary address (Japan only).
- company.
address_kanji. citystring City or ward.
- company.
address_kanji. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- company.
address_kanji. line1string Block or building number.
- company.
address_kanji. line2string Building details.
- company.
address_kanji. postal_ codestring Postal code.
- company.
address_kanji. statestring Prefecture.
- company.
address_kanji. townstring Town or cho-me.
- company.
directors_ providedboolean Whether the company’s directors have been provided. Set this Boolean to
true
after creating all the company’s directors with the Persons API for accounts with arelationship.
requirement. This value is not automatically set todirector true
after creating directors, so it needs to be updated to indicate all directors have been provided. - company.
directorship_ declarationobject This hash is used to attest that the directors information provided to Stripe is both current and correct.
- company.
directorship_declaration. datetimestamp The Unix timestamp marking when the directorship declaration attestation was made.
- company.
directorship_declaration. ipstring The IP address from which the directorship declaration attestation was made.
- company.
directorship_declaration. user_ agentstring The user agent of the browser from which the directorship declaration attestation was made.
- company.
executives_ providedboolean Whether the company’s executives have been provided. Set this Boolean to
true
after creating all the company’s executives with the Persons API for accounts with arelationship.
requirement.executive - company.
export_ license_ idstring The export license ID number of the company, also referred as Import Export Code (India only).
- company.
export_ purpose_ codestring The purpose code to use for export transactions (India only).
- company.
namestring The company’s legal name.
- company.
name_ kanastring The Kana variation of the company’s legal name (Japan only).
- company.
name_ kanjistring The Kanji variation of the company’s legal name (Japan only).
- company.
owners_ providedboolean Whether the company’s owners have been provided. Set this Boolean to
true
after creating all the company’s owners with the Persons API for accounts with arelationship.
requirement.owner - company.
ownership_ declarationobject This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
- company.
ownership_declaration. datetimestamp The Unix timestamp marking when the beneficial owner attestation was made.
- company.
ownership_declaration. ipstring The IP address from which the beneficial owner attestation was made.
- company.
ownership_declaration. user_ agentstring The user agent of the browser from which the beneficial owner attestation was made.
- company.
ownership_ exemption_ reasonenum This value is used to determine if a business is exempt from providing ultimate beneficial owners. See this support article and changelog for more details.
- company.
phonestring The company’s phone number (used for verification).
- company.
registration_ dateobject When the business was incorporated or registered.
- company.
registration_date. dayintegerRequired The day of registration, between 1 and 31.
- company.
registration_date. monthintegerRequired The month of registration, between 1 and 12.
- company.
registration_date. yearintegerRequired The four-digit year of registration.
- company.
registration_ numberstring The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
- company.
structureenum The category identifying the legal structure of the company or legal entity. See Business structure for more details. Pass an empty string to unset this value.
- company.
tax_ idstring The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
- company.
tax_ id_ registrarstring The jurisdiction in which the
tax_
is registered (Germany-based companies only).id - company.
vat_ idstring The VAT number of the company.
- company.
verificationobject Information on the verification state of the company.
- company.
verification. documentobject A document verifying the business.
- company.
verification. document. backstring The back of a document returned by a file upload with a
purpose
value ofadditional_
. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.verification - company.
verification. document. frontstring The front of a document returned by a file upload with a
purpose
value ofadditional_
. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.verification
- controllerobject
A hash of configuration describing the account controller’s attributes.
- controller.
feesobject A hash of configuration for who pays Stripe fees for product usage on this account.
- controller.
fees. payerenum A value indicating the responsible payer of Stripe fees on this account. Defaults to
account
. Learn more about fee behavior on connected accounts.Possible enum valuesaccount
The account is responsible for paying Stripe fees.
application
The Connect application is responsible for paying Stripe fees on pricing-control eligible products.
- controller.
lossesobject A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.
- controller.
losses. paymentsenum A value indicating who is liable when this account can’t pay back negative balances resulting from payments. Defaults to
stripe
.Possible enum valuesapplication
The Connect application is liable when this account can’t pay back negative balances resulting from payments.
stripe
Stripe is liable when this account can’t pay back negative balances resulting from payments.
- controller.
requirement_ collectionenum A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to
stripe
.Possible enum valuesapplication
The Connect application is responsible for collecting outstanding and updated requirements on the account. The Connect application can fully access the KYC properties on the account, as well as attest that the account has seen and accepted the Stripe service agreement via the API.
stripe
Stripe is responsible for collecting outstanding and updated requirements on the account.
- controller.
stripe_ dashboardobject A hash of configuration for Stripe-hosted dashboards.
- controller.
stripe_dashboard. typeenum Whether this account should have access to the full Stripe Dashboard (
full
), to the Express Dashboard (express
), or to no Stripe-hosted dashboard (none
). Defaults tofull
.Possible enum valuesexpress
The account has access to the Express Dashboard.
full
The account has access to the full Stripe Dashboard.
none
The account does not have access to a Stripe-hosted dashboard. The Connect application is responsible for providing UIs to the account.
- countrystringdefault is your own country
The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you’re creating an account is legally represented in Canada, you would use
CA
as the country for the account being created. Available countries include Stripe’s global markets as well as countries where cross-border payouts are supported. - emailstring
The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is
application
, which includes Custom accounts, Stripe doesn’t email the account without your consent. - individualobject
Information about the person represented by the account. This field is null unless
business_
is set totype individual
. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection isapplication
, which includes Custom accounts.- individual.
addressobject The individual’s primary address.
- individual.
address. citystring City, district, suburb, town, or village.
- individual.
address. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- individual.
address. line1string Address line 1 (e.g., street, PO Box, or company name).
- individual.
address. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- individual.
address. postal_ codestring ZIP or postal code.
- individual.
address. statestring State, county, province, or region.
- individual.
address_ kanaobject The Kana variation of the individual’s primary address (Japan only).
- individual.
address_kana. citystring City or ward.
- individual.
address_kana. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- individual.
address_kana. line1string Block or building number.
- individual.
address_kana. line2string Building details.
- individual.
address_kana. postal_ codestring Postal code.
- individual.
address_kana. statestring Prefecture.
- individual.
address_kana. townstring Town or cho-me.
- individual.
address_ kanjiobject The Kanji variation of the individual’s primary address (Japan only).
- individual.
address_kanji. citystring City or ward.
- individual.
address_kanji. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- individual.
address_kanji. line1string Block or building number.
- individual.
address_kanji. line2string Building details.
- individual.
address_kanji. postal_ codestring Postal code.
- individual.
address_kanji. statestring Prefecture.
- individual.
address_kanji. townstring Town or cho-me.
- individual.
dobobject The individual’s date of birth.
- individual.
dob. dayintegerRequired The day of birth, between 1 and 31.
- individual.
dob. monthintegerRequired The month of birth, between 1 and 12.
- individual.
dob. yearintegerRequired The four-digit year of birth.
- individual.
emailstring The individual’s email address.
- individual.
first_ namestring The individual’s first name.
- individual.
first_ name_ kanastring The Kana variation of the individual’s first name (Japan only).
- individual.
first_ name_ kanjistring The Kanji variation of the individual’s first name (Japan only).
- individual.
full_ name_ aliasesarray of strings A list of alternate names or aliases that the individual is known by.
- individual.
genderenum The individual’s gender
- individual.
id_ numberstring The government-issued ID number of the individual, as appropriate for the representative’s country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a PII token created with Stripe.js.
- individual.
id_ number_ secondarystring The government-issued secondary ID number of the individual, as appropriate for the representative’s 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 created with Stripe.js.
- individual.
last_ namestring The individual’s last name.
- individual.
last_ name_ kanastring The Kana variation of the individual’s last name (Japan only).
- individual.
last_ name_ kanjistring The Kanji variation of the individual’s last name (Japan only).
- individual.
maiden_ namestring The individual’s maiden name.
- individual.
metadataobject Set of key-value pairs 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
. - individual.
phonestring The individual’s phone number.
- individual.
political_ exposureenum 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.
Possible enum valuesexisting
The person has disclosed that they do have political exposure
none
The person has disclosed that they have no political exposure
- individual.
registered_ addressobject The individual’s registered address.
- individual.
registered_address. citystring City, district, suburb, town, or village.
- individual.
registered_address. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- individual.
registered_address. line1string Address line 1 (e.g., street, PO Box, or company name).
- individual.
registered_address. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- individual.
registered_address. postal_ codestring ZIP or postal code.
- individual.
registered_address. statestring State, county, province, or region.
- individual.
relationshipobject Describes the person’s relationship to the account.
- individual.
relationship. directorboolean 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.
- individual.
relationship. executiveboolean Whether the person has significant responsibility to control, manage, or direct the organization.
- individual.
relationship. ownerboolean Whether the person is an owner of the account’s legal entity.
- individual.
relationship. percent_ ownershipfloat The percent owned by the person of the account’s legal entity.
- individual.
relationship. titlestring The person’s title (e.g., CEO, Support Engineer).
- individual.
ssn_ last_ 4string The last four digits of the individual’s Social Security Number (U.S. only).
- individual.
verificationobject The individual’s verification document information.
- individual.
verification. additional_ documentobject A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
- individual.
verification. additional_document. backstring The back of an ID returned by a file upload with a
purpose
value ofidentity_
. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.document - individual.
verification. additional_document. frontstring The front of an ID returned by a file upload with a
purpose
value ofidentity_
. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.document
- individual.
verification. documentobject An identifying document, either a passport or local ID card.
- individual.
verification. document. backstring The back of an ID returned by a file upload with a
purpose
value ofidentity_
. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.document - individual.
verification. document. frontstring The front of an ID returned by a file upload with a
purpose
value ofidentity_
. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.document
- metadataobject
Set of key-value pairs 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
. - tos_
acceptanceobject Details on the account’s acceptance of the Stripe Services Agreement. This property can only be updated for accounts where controller.requirement_collection is
application
, which includes Custom accounts. This property defaults to afull
service agreement when empty.- tos_acceptance.
datetimestampRequired if ip or user_agent is provided The Unix timestamp marking when the account representative accepted their service agreement.
- tos_acceptance.
ipstringRequired if date or user_agent is provided The IP address from which the account representative accepted their service agreement.
- tos_acceptance.
service_ agreementstring The user’s service agreement type.
- tos_acceptance.
user_ agentstring The user agent of the browser from which the account representative accepted their service agreement.
- typeenum
The type of Stripe account to create. May be one of
custom
,express
orstandard
.Possible enum valuescustom
express
standard
More parameters
- account_
tokenstring An account token, used to securely provide details to the account.
- business_
profileobject Business information about the account.
- business_profile.
annual_ revenueobject The applicant’s gross annual revenue for its preceding fiscal year.
- business_profile.
annual_revenue. amountintegerRequired A non-negative integer representing the amount in the smallest currency unit.
- business_profile.
annual_revenue. currencyenumRequired Three-letter ISO currency code, in lowercase. Must be a supported currency.
- business_profile.
annual_revenue. fiscal_ year_ endstringRequired The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
- business_profile.
estimated_ worker_ countinteger An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
- business_profile.
mccstring The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.
- business_profile.
minority_ owned_ business_ designationarray of enums Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
Possible enum valueslgbtqi_
owned_ business This business is owned by LGBTQI+ individual(s).
minority_
owned_ business This is a minority owned business. Minority means Hispanic or Latino, American Indian or Alaska Native, Asian, Black or African American, or Native Hawaiian or Other Pacific Islander. A multi-racial or multi-ethnic individual is a minority for this purpose.
none_
of_ these_ apply None of these apply.
prefer_
not_ to_ answer Prefer not to answer.
women_
owned_ business This business is owned by women.
- business_profile.
monthly_ estimated_ revenueobject An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.
- business_profile.
monthly_estimated_revenue. amountintegerRequired A non-negative integer representing how much to charge in the smallest currency unit.
- business_profile.
monthly_estimated_revenue. currencyenumRequired Three-letter ISO currency code, in lowercase. Must be a supported currency.
- business_profile.
namestring The customer-facing business name.
- business_profile.
product_ descriptionstring Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.
- business_profile.
support_ addressobject A publicly available mailing address for sending support issues to.
- business_profile.
support_address. citystring City, district, suburb, town, or village.
- business_profile.
support_address. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- business_profile.
support_address. line1string Address line 1 (e.g., street, PO Box, or company name).
- business_profile.
support_address. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- business_profile.
support_address. postal_ codestring ZIP or postal code.
- business_profile.
support_address. statestring State, county, province, or region.
- business_profile.
support_ emailstring A publicly available email address for sending support issues to.
- business_profile.
support_ phonestring A publicly available phone number to call with support issues.
- business_profile.
support_ urlstring A publicly available website for handling support issues.
- business_profile.
urlstring The business’s publicly available website.
- default_
currencyenum 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.
- documentsobject
Documents that may be submitted to satisfy various informational requests.
- documents.
bank_ account_ ownership_ verificationobject One or more documents that support the Bank account ownership verification requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
- documents.
bank_account_ownership_verification. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
- documents.
company_ licenseobject One or more documents that demonstrate proof of a company’s license to operate.
- documents.
company_license. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
- documents.
company_ memorandum_ of_ associationobject One or more documents showing the company’s Memorandum of Association.
- documents.
company_memorandum_of_association. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
- documents.
company_ ministerial_ decreeobject (Certain countries only) One or more documents showing the ministerial decree legalizing the company’s establishment.
- documents.
company_ministerial_decree. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
- documents.
company_ registration_ verificationobject One or more documents that demonstrate proof of a company’s registration with the appropriate local authorities.
- documents.
company_registration_verification. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
- documents.
company_ tax_ id_ verificationobject One or more documents that demonstrate proof of a company’s tax ID.
- documents.
company_tax_id_verification. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
- documents.
proof_ of_ addressobject One or more documents that demonstrate proof of address.
- documents.
proof_of_address. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
- documents.
proof_ of_ registrationobject One or more documents showing the company’s proof of registration with the national business registry.
- documents.
proof_of_registration. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
- documents.
proof_ of_ ultimate_ beneficial_ ownershipobject One or more documents that demonstrate proof of ultimate beneficial ownership.
- documents.
proof_of_ultimate_beneficial_ownership. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
- external_
accountstring A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the
external_
parameter for bank account creation. By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection isaccount application
, which includes Custom accounts. - groupsobjectPreview feature
A hash of account group type to tokens. These are account groups this account should be added to.
- groups.
payments_ pricingstring 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 for details.
- settingsobject
Options for customizing how the account functions within Stripe.
- settings.
bacs_ debit_ paymentsobject Settings specific to Bacs Direct Debit.
- settings.
bacs_debit_payments. display_ namestring The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don’t set the display name before requesting Bacs capability, it’s automatically set as “Stripe” and the account is onboarded to Stripe branding, which is free.
- settings.
brandingobject Settings used to apply the account’s branding to email receipts, invoices, Checkout, and other products.
- settings.
branding. iconstring (ID of a file upload) An icon for the account. Must be square and at least 128px x 128px.
- settings.
branding. logostring (ID of a file upload) A logo for the account that will be used in Checkout instead of the icon and without the account’s name next to it if provided. Must be at least 128px x 128px.
- settings.
branding. primary_ colorstring A CSS hex color value representing the primary branding color for this account.
- settings.
branding. secondary_ colorstring A CSS hex color value representing the secondary branding color for this account.
- settings.
card_ issuingobject Settings specific to the account’s use of the Card Issuing product.
- settings.
card_issuing. tos_ acceptanceobject Details on the account’s acceptance of the Stripe Issuing Terms and Disclosures.
- settings.
card_issuing. tos_acceptance. datetimestampRequired if ip or user_agent is provided The Unix timestamp marking when the account representative accepted the service agreement.
- settings.
card_issuing. tos_acceptance. ipstringRequired if date or user_agent is provided The IP address from which the account representative accepted the service agreement.
- settings.
card_issuing. tos_acceptance. user_ agentstring The user agent of the browser from which the account representative accepted the service agreement.
- settings.
card_ paymentsobject Settings specific to card charging on the account.
- settings.
card_payments. decline_ onobject Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
- settings.
card_payments. decline_on. avs_ failureboolean Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
- settings.
card_payments. decline_on. cvc_ failureboolean Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
- settings.
invoicesobject Settings specific to the account’s use of Invoices.
- settings.
invoices. hosted_ payment_ method_ saveenum Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.
Possible enum valuesalways
The payment method, if reusable, will be saved for one-time invoice payments.
never
The payment method will not be saved for one-time invoice payments.
offer
The payment method, if reusable, will be saved for one-time invoice payments if the customer chooses to save it.
- settings.
paymentsobject Settings that apply across payment methods for charging on the account.
- settings.
payments. statement_ descriptorstring The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don’t set a
statement_
, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate thedescriptor_ prefix statement_
text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the account settings documentation.descriptor - settings.
payments. statement_ descriptor_ kanastring The Kana variation of
statement_
used for charges in Japan. Japanese statement descriptors have special requirements.descriptor - settings.
payments. statement_ descriptor_ kanjistring The Kanji variation of
statement_
used for charges in Japan. Japanese statement descriptors have special requirements.descriptor - settings.
payments. statement_ descriptor_ prefixstring Default text that appears on statements for card charges outside of Japan, prefixing any dynamic
statement_
specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don’t specify this value,descriptor_ suffix statement_
is used as the prefix. For more information about statement descriptors and their requirements, see the account settings documentation.descriptor - settings.
payments. statement_ descriptor_ prefix_ kanastring The Kana variation of
statement_
used for card charges in Japan. Japanese statement descriptors have special requirements.descriptor_ prefix - settings.
payments. statement_ descriptor_ prefix_ kanjistring The Kanji variation of
statement_
used for card charges in Japan. Japanese statement descriptors have special requirements.descriptor_ prefix
- settings.
payoutsobject Settings specific to the account’s payouts.
- settings.
payouts. debit_ negative_ balancesboolean A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see Understanding Connect Account Balances.
- settings.
payouts. scheduleobject Details on when funds from charges are available, and when they are paid out to an external account. For details, see our Setting Bank and Debit Card Payouts documentation.
- settings.
payouts. schedule. delay_ daysstring | integer The number of days charge funds are held before being paid out. May also be set to
minimum
, representing the lowest available value for the account country. Default isminimum
. Thedelay_
parameter remains at the last configured value ifdays interval
ismanual
. Learn more about controlling payout delay days. - settings.
payouts. schedule. intervalstring How frequently available funds are paid out. One of:
daily
,manual
,weekly
, ormonthly
. Default isdaily
. - settings.
payouts. schedule. monthly_ anchorinteger The day of the month when available funds are paid out, specified as a number between 1–31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if
interval
ismonthly
. - settings.
payouts. schedule. monthly_ payout_ daysarray of integers The days of the month when available funds are paid out, specified as an array of numbers between 1–31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if
interval
ismonthly
andmonthly_
is not set.anchor - settings.
payouts. schedule. weekly_ anchorstring The day of the week when available funds are paid out, specified as
monday
,tuesday
, etc. (required and applicable only ifinterval
isweekly
.) - settings.
payouts. schedule. weekly_ payout_ daysarray of enums The days of the week when available funds are paid out, specified as an array, e.g., [
monday
,tuesday
]. (required and applicable only ifinterval
isweekly
andweekly_
is not set.)anchor Possible enum valuesfriday
Select Friday as one of the weekly payout day
monday
Select Monday as one of the weekly payout day
saturday
Select Saturday as one of the weekly payout day
sunday
Select Sunday as one of the weekly payout day
thursday
Select Thursday as one of the weekly payout day
tuesday
Select Tuesday as one of the weekly payout day
wednesday
Select Wednesday as one of the weekly payout day
- settings.
payouts. statement_ descriptorstring The text that appears on the bank account statement for payouts. If not set, this defaults to the platform’s bank descriptor as set in the Dashboard.
Returns
Returns an Account
object if the call succeeds.
{ "id": "acct_1Nv0FGQ9RKHgCVdK", "object": "account", "business_profile": { "annual_revenue": null, "estimated_worker_count": null, "mcc": null, "name": null, "product_description": null, "support_address": null, "support_email": null, "support_phone": null, "support_url": null, "url": null }, "business_type": null, "capabilities": {}, "charges_enabled": false, "controller": { "fees": { "payer": "application" }, "is_controller": true, "losses": { "payments": "application" }, "requirement_collection": "stripe", "stripe_dashboard": { "type": "express" }, "type": "application" }, "country": "US", "created": 1695830751, "default_currency": "usd", "details_submitted": false, "email": "jenny.rosen@example.com", "external_accounts": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/accounts/acct_1Nv0FGQ9RKHgCVdK/external_accounts" }, "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "login_links": { "object": "list", "total_count": 0, "has_more": false, "url": "/v1/accounts/acct_1Nv0FGQ9RKHgCVdK/login_links", "data": [] }, "metadata": {}, "payouts_enabled": false, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [ "business_profile.mcc", "business_profile.url", "business_type", "external_account", "representative.first_name", "representative.last_name", "tos_acceptance.date", "tos_acceptance.ip" ], "disabled_reason": "requirements.past_due", "errors": [], "eventually_due": [ "business_profile.mcc", "business_profile.url", "business_type", "external_account", "representative.first_name", "representative.last_name", "tos_acceptance.date", "tos_acceptance.ip" ], "past_due": [ "business_profile.mcc", "business_profile.url", "business_type", "external_account", "representative.first_name", "representative.last_name", "tos_acceptance.date", "tos_acceptance.ip" ], "pending_verification": [] }, "settings": { "bacs_debit_payments": { "display_name": null, "service_user_number": null }, "branding": { "icon": null, "logo": null, "primary_color": null, "secondary_color": null }, "card_issuing": { "tos_acceptance": { "date": null, "ip": null } }, "card_payments": { "decline_on": { "avs_failure": false, "cvc_failure": false }, "statement_descriptor_prefix": null, "statement_descriptor_prefix_kanji": null, "statement_descriptor_prefix_kana": null }, "dashboard": { "display_name": null, "timezone": "Etc/UTC" }, "invoices": { "default_account_tax_ids": null }, "payments": { "statement_descriptor": null, "statement_descriptor_kana": null, "statement_descriptor_kanji": null }, "payouts": { "debit_negative_balances": true, "schedule": { "delay_days": 2, "interval": "daily" }, "statement_descriptor": null }, "sepa_debit_payments": {} }, "tos_acceptance": { "date": null, "ip": null, "user_agent": null }, "type": "none"}