Update an account

Connect

Accounts

Update an account

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

For accounts where controller.requirement_collection is application, which includes Custom accounts, you can update any information on the account.

For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, you can update all information until you create an Account Link or Account Session to start Connect onboarding, after which some properties can no longer be updated.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

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 values
company
government_entity
US only
individual
non_profit

capabilitieshash
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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_issuinghash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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.naver_pay_paymentshash
  The naver_pay_payments capability.
  capabilities.naver_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.nz_bank_account_becs_debit_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_khash
  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_mischash
  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.transfershash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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_paymentshash
  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.

companyhash
Information about the company or business. This field is available for any 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.
- company.addresshash
  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_kanahash
  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_kanjihash
  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 a relationship.director requirement. This value is not automatically set to true after creating directors, so it needs to be updated to indicate all directors have been provided.
- company.directorship_declarationhash
  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 a relationship.executive requirement.
- 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 a relationship.owner requirement.
- company.ownership_declarationhash
  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_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_id is registered (Germany-based companies only).
- company.vat_idstring
  The VAT number of the company.
- company.verificationhash
  Information on the verification state of the company.
  company.verification.documenthash
  A document verifying the business.
  company.verification.document.backstring
  The back of a document returned by a file upload with a purpose value of additional_verification. 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.
  company.verification.document.frontstring
  The front of a document returned by a file upload with a purpose value of additional_verification. 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.

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.

individualhash
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 or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.
- individual.addresshash
  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_kanahash
  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_kanjihash
  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.dobhash
  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.metadatahash
  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 values
  existing
  The person has disclosed that they do have political exposure
  none
  The person has disclosed that they have no political exposure
- individual.registered_addresshash
  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.relationshiphash
  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.verificationhash
  The individual’s verification document information.
  individual.verification.additional_documenthash
  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 of identity_document. 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.
  individual.verification.additional_document.frontstring
  The front of an ID returned by a file upload with a purpose value of identity_document. 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.
  individual.verification.documenthash
  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 of identity_document. 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.
  individual.verification.document.frontstring
  The front of an ID returned by a file upload with a purpose value of identity_document. 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.

metadatahash
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_acceptancehash
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 a full 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.

More parameters

account_tokenstring
An account token, used to securely provide details to the account.

business_profilehash

Business information about the account.

business_profile.annual_revenuehash
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 values

lgbtqi_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_revenuehash
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_addresshash
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.

documentshash
Documents that may be submitted to satisfy various informational requests.
- documents.bank_account_ownership_verificationhash
  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 of account_requirement.
- documents.company_licensehash
  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 of account_requirement.
- documents.company_memorandum_of_associationhash
  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 of account_requirement.
- documents.company_ministerial_decreehash
  (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 of account_requirement.
- documents.company_registration_verificationhash
  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 of account_requirement.
- documents.company_tax_id_verificationhash
  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 of account_requirement.
- documents.proof_of_addresshash
  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 of account_requirement.
- documents.proof_of_registrationhash
  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 of account_requirement.
- documents.proof_of_ultimate_beneficial_ownershiphash
  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 of account_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_account 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 is application, which includes Custom accounts.

groupshashPreview 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.

settingshash

Options for customizing how the account functions within Stripe.

settings.bacs_debit_paymentshash
Settings specific to Bacs Direct Debit payments.
- 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.brandinghash
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_issuinghash
Settings specific to the account’s use of the Card Issuing product.
- settings.card_issuing.tos_acceptancehash
  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_paymentshash
Settings specific to card charging on the account.
- settings.card_payments.decline_onhash
  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.invoiceshash

Settings specific to the account’s use of Invoices.

settings.invoices.default_account_tax_idsarray of strings
The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.

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 values

always

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.paymentshash
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_descriptor_prefix, 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 the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the account settings documentation.
- settings.payments.statement_descriptor_kanastring
  The Kana variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have special requirements.
- settings.payments.statement_descriptor_kanjistring
  The Kanji variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have special requirements.
- settings.payments.statement_descriptor_prefixstring
  Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix 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, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the account settings documentation.
- settings.payments.statement_descriptor_prefix_kanastring
  The Kana variation of statement_descriptor_prefix used for card charges in Japan. Japanese statement descriptors have special requirements.
- settings.payments.statement_descriptor_prefix_kanjistring
  The Kanji variation of statement_descriptor_prefix used for card charges in Japan. Japanese statement descriptors have special requirements.

settings.payoutshash

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.schedulehash

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 is minimum. The delay_days parameter remains at the last configured value if interval is manual. Learn more about controlling payout delay days.

settings.payouts.schedule.intervalstring
How frequently available funds are paid out. One of: daily, manual, weekly, or monthly. Default is daily.

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 is monthly.

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 is monthly and monthly_anchor is not set.

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 if interval is weekly.

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 if interval is weekly.

Possible enum values

friday

Select Friday as one of the weekly payout day

monday

Select Monday 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. If the account ID does not exist or another issue occurs, this call raises an error. Some validations will not raise an error but will instead populate the requirements.errors array.

POST /v1/accounts/:id

Server-side language

Stripe.api_key = 'sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2'
account = Stripe::Account.update(
  'acct_1Nv0FGQ9RKHgCVdK',
  {metadata: {order_id: '6735'}},
)

Response

{
  "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": {
    "order_id": "6735"
  },
  "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"
}

Update an account

Parameters

business_typeenum

capabilitieshash

capabilities.acss_debit_paymentshash

capabilities.acss_debit_payments.requestedboolean

capabilities.affirm_paymentshash

capabilities.affirm_payments.requestedboolean

capabilities.afterpay_clearpay_paymentshash

capabilities.afterpay_clearpay_payments.requestedboolean

capabilities.alma_paymentshash

capabilities.alma_payments.requestedboolean

capabilities.amazon_pay_paymentshash

capabilities.amazon_pay_payments.requestedboolean

capabilities.au_becs_debit_paymentshash

capabilities.au_becs_debit_payments.requestedboolean

capabilities.bacs_debit_paymentshash

capabilities.bacs_debit_payments.requestedboolean

capabilities.bancontact_paymentshash

capabilities.bancontact_payments.requestedboolean

capabilities.bank_transfer_paymentshash

capabilities.bank_transfer_payments.requestedboolean

capabilities.billie_paymentshash

capabilities.billie_payments.requestedboolean

capabilities.blik_paymentshash

capabilities.blik_payments.requestedboolean

capabilities.boleto_paymentshash

capabilities.boleto_payments.requestedboolean

capabilities.card_issuinghash

capabilities.card_issuing.requestedboolean

capabilities.card_paymentshash

capabilities.card_payments.requestedboolean

capabilities.cartes_bancaires_paymentshash

capabilities.cartes_bancaires_payments.requestedboolean

capabilities.cashapp_paymentshash

capabilities.cashapp_payments.requestedboolean

capabilities.crypto_paymentshash

capabilities.crypto_payments.requestedboolean

capabilities.eps_paymentshash

capabilities.eps_payments.requestedboolean

capabilities.fpx_paymentshash

capabilities.fpx_payments.requestedboolean

capabilities.gb_bank_transfer_paymentshash

capabilities.gb_bank_transfer_payments.requestedboolean

capabilities.giropay_paymentshash

capabilities.giropay_payments.requestedboolean

capabilities.grabpay_paymentshash

capabilities.grabpay_payments.requestedboolean

capabilities.ideal_paymentshash

capabilities.ideal_payments.requestedboolean

capabilities.india_international_paymentshash

capabilities.india_international_payments.requestedboolean

capabilities.jcb_paymentshash

capabilities.jcb_payments.requestedboolean

capabilities.jp_bank_transfer_paymentshash

capabilities.jp_bank_transfer_payments.requestedboolean

capabilities.kakao_pay_paymentshash

capabilities.kakao_pay_payments.requestedboolean

capabilities.klarna_paymentshash

capabilities.klarna_payments.requestedboolean

capabilities.konbini_paymentshash

capabilities.konbini_payments.requestedboolean

capabilities.kr_card_paymentshash

capabilities.kr_card_payments.requestedboolean

capabilities.legacy_paymentshash

capabilities.legacy_payments.requestedboolean

capabilities.link_paymentshash

capabilities.link_payments.requestedboolean

capabilities.mobilepay_paymentshash

capabilities.mobilepay_payments.requestedboolean

capabilities.multibanco_paymentshash

capabilities.multibanco_payments.requestedboolean

capabilities.mx_bank_transfer_paymentshash

capabilities.mx_bank_transfer_payments.requestedboolean

capabilities.naver_pay_paymentshash

capabilities.naver_pay_payments.requestedboolean

capabilities.nz_bank_account_becs_debit_paymentshash

capabilities.nz_bank_account_becs_debit_payments.requestedboolean

capabilities.oxxo_paymentshash

capabilities.oxxo_payments.requestedboolean