The Account object

Connect

Accounts

The Account object

Attributes

idstring
Unique identifier for the object.

business_typenullable enum
The business type.
Possible enum values
company
government_entity
US only
individual
non_profit

capabilitiesnullable object
A hash containing the set of capabilities that was requested for this account and their associated states. Keys are names of capabilities. You can see the full list here. Values may be active, inactive, or pending.
- capabilities.acss_debit_paymentsnullable enum
  The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.affirm_paymentsnullable enum
  The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.afterpay_clearpay_paymentsnullable enum
  The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.alma_paymentsnullable enum
  The status of the Alma capability of the account, or whether the account can directly process Alma payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.amazon_pay_paymentsnullable enum
  The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.au_becs_debit_paymentsnullable enum
  The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.bacs_debit_paymentsnullable enum
  The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.bancontact_paymentsnullable enum
  The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.bank_transfer_paymentsnullable enum
  The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.billie_paymentsnullable enum
  The status of the Billie capability of the account, or whether the account can directly process Billie payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.blik_paymentsnullable enum
  The status of the blik payments capability of the account, or whether the account can directly process blik charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.boleto_paymentsnullable enum
  The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.card_issuingnullable enum
  The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards
  Possible enum values
  active
  inactive
  pending
- capabilities.card_paymentsnullable enum
  The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.cartes_bancaires_paymentsnullable enum
  The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.
  Possible enum values
  active
  inactive
  pending
- capabilities.cashapp_paymentsnullable enum
  The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.eps_paymentsnullable enum
  The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.fpx_paymentsnullable enum
  The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.gb_bank_transfer_paymentsnullable enum
  The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.giropay_paymentsnullable enum
  The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.grabpay_paymentsnullable enum
  The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.ideal_paymentsnullable enum
  The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.india_international_paymentsnullable enum
  The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.
  Possible enum values
  active
  inactive
  pending
- capabilities.jcb_paymentsnullable enum
  The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.
  Possible enum values
  active
  inactive
  pending
- capabilities.jp_bank_transfer_paymentsnullable enum
  The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.kakao_pay_paymentsnullable enum
  The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.klarna_paymentsnullable enum
  The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.konbini_paymentsnullable enum
  The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.kr_card_paymentsnullable enum
  The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.legacy_paymentsnullable enum
  The status of the legacy payments capability of the account.
  Possible enum values
  active
  inactive
  pending
- capabilities.link_paymentsnullable enum
  The status of the link_payments capability of the account, or whether the account can directly process Link charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.mobilepay_paymentsnullable enum
  The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.multibanco_paymentsnullable enum
  The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.mx_bank_transfer_paymentsnullable enum
  The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.naver_pay_paymentsnullable enum
  The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.nz_bank_account_becs_debit_paymentsnullable enum
  The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.oxxo_paymentsnullable enum
  The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.p24_paymentsnullable enum
  The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.pay_by_bank_paymentsnullable enum
  The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.payco_paymentsnullable enum
  The status of the Payco capability of the account, or whether the account can directly process Payco payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.paynow_paymentsnullable enum
  The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.promptpay_paymentsnullable enum
  The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.revolut_pay_paymentsnullable enum
  The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.samsung_pay_paymentsnullable enum
  The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.satispay_paymentsnullable enum
  The status of the Satispay capability of the account, or whether the account can directly process Satispay payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.sepa_bank_transfer_paymentsnullable enum
  The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.sepa_debit_paymentsnullable enum
  The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.sofort_paymentsnullable enum
  The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.swish_paymentsnullable enum
  The status of the Swish capability of the account, or whether the account can directly process Swish payments.
  Possible enum values
  active
  inactive
  pending
- capabilities.tax_reporting_us_1099_knullable enum
  The status of the tax reporting 1099-K (US) capability of the account.
  Possible enum values
  active
  inactive
  pending
- capabilities.tax_reporting_us_1099_miscnullable enum
  The status of the tax reporting 1099-MISC (US) capability of the account.
  Possible enum values
  active
  inactive
  pending
- capabilities.transfersnullable enum
  The status of the transfers capability of the account, or whether your platform can transfer funds to the account.
  Possible enum values
  active
  inactive
  pending
- capabilities.twint_paymentsnullable enum
  The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.us_bank_account_ach_paymentsnullable enum
  The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.us_bank_transfer_paymentsnullable enum
  The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.
  Possible enum values
  active
  inactive
  pending
- capabilities.zip_paymentsnullable enum
  The status of the Zip capability of the account, or whether the account can directly process Zip charges.
  Possible enum values
  active
  inactive
  pending

companynullable object
Information about the company or business. This property is available for any business_type. After you create an Account Link or Account Session, only a subset of this property is returned for accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts.
- company.addressnullable object
  The company’s primary address.
  company.address.citynullable string
  City, district, suburb, town, or village.
  company.address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  company.address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  company.address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  company.address.postal_codenullable string
  ZIP or postal code.
  company.address.statenullable string
  State, county, province, or region.
- company.address_kananullable object
  The Kana variation of the company’s primary address (Japan only).
  company.address_kana.citynullable string
  City/Ward.
  company.address_kana.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  company.address_kana.line1nullable string
  Block/Building number.
  company.address_kana.line2nullable string
  Building details.
  company.address_kana.postal_codenullable string
  ZIP or postal code.
  company.address_kana.statenullable string
  Prefecture.
  company.address_kana.townnullable string
  Town/cho-me.
- company.address_kanjinullable object
  The Kanji variation of the company’s primary address (Japan only).
  company.address_kanji.citynullable string
  City/Ward.
  company.address_kanji.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  company.address_kanji.line1nullable string
  Block/Building number.
  company.address_kanji.line2nullable string
  Building details.
  company.address_kanji.postal_codenullable string
  ZIP or postal code.
  company.address_kanji.statenullable string
  Prefecture.
  company.address_kanji.townnullable string
  Town/cho-me.
- company.directors_providedboolean
  Whether the company’s directors have been provided. This Boolean will be true if you’ve manually indicated that all directors are provided via the directors_provided parameter.
- company.directorship_declarationnullable object
  This hash is used to attest that the director information provided to Stripe is both current and correct.
  company.directorship_declaration.datenullable timestamp
  The Unix timestamp marking when the directorship declaration attestation was made.
  company.directorship_declaration.ipnullable string
  The IP address from which the directorship declaration attestation was made.
  company.directorship_declaration.user_agentnullable string
  The user-agent string from the browser where the directorship declaration attestation was made.
- company.executives_providedboolean
  Whether the company’s executives have been provided. This Boolean will be true if you’ve manually indicated that all executives are provided via the executives_provided parameter, or if Stripe determined that sufficient executives were provided.
- company.export_license_idnullable string
  The export license ID number of the company, also referred as Import Export Code (India only).
- company.export_purpose_codenullable string
  The purpose code to use for export transactions (India only).
- company.namenullable string
  The company’s legal name. Also available for accounts where controller.requirement_collection is stripe.
- company.name_kananullable string
  The Kana variation of the company’s legal name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
- company.name_kanjinullable string
  The Kanji variation of the company’s legal name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
- company.owners_providedboolean
  Whether the company’s owners have been provided. This Boolean will be true if you’ve manually indicated that all owners are provided via the owners_provided parameter, or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the percent_ownership of each owner together).
- company.ownership_declarationnullable object
  This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
  company.ownership_declaration.datenullable timestamp
  The Unix timestamp marking when the beneficial owner attestation was made.
  company.ownership_declaration.ipnullable string
  The IP address from which the beneficial owner attestation was made.
  company.ownership_declaration.user_agentnullable string
  The user-agent string from the browser where the beneficial owner attestation was made.
- company.ownership_exemption_reasonnullable enum
  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.phonenullable string
  The company’s phone number (used for verification).
- company.structurenullable enum
  The category identifying the legal structure of the company or legal entity. Also available for accounts where controller.requirement_collection is stripe. See Business structure for more details.
- company.tax_id_providedboolean
  Whether the company’s business ID number was provided.
- company.tax_id_registrarnullable string
  The jurisdiction in which the tax_id is registered (Germany-based companies only).
- company.vat_id_providednullable boolean
  Whether the company’s business VAT number was provided.
- company.verificationnullable object
  Information on the verification state of the company.
  company.verification.documentobject
  A document for the company.
  company.verification.document.backnullable stringExpandable
  The back of a document returned by a file upload with a purpose value of additional_verification.
  company.verification.document.detailsnullable string
  A user-displayable string describing the verification state of this document.
  company.verification.document.details_codenullable string
  One of document_corrupt, document_expired, document_failed_copy, document_failed_greyscale, document_failed_other, document_failed_test_mode, document_fraudulent, document_incomplete, document_invalid, document_manipulated, document_not_readable, document_not_uploaded, document_type_not_supported, or document_too_large. A machine-readable code specifying the verification state for this document.
  company.verification.document.frontnullable stringExpandable
  The front of a document returned by a file upload with a purpose value of additional_verification.

countrystring
The account’s country.

emailnullable string
An email address associated with the account. It’s not used for authentication and Stripe doesn’t market to this field without explicit approval from the platform.

individualnullable object

Information about the person represented by the account. This property is null unless business_type is set to individual. After you create an Account Link or Account Session, only a subset of this property is returned for accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts.

individual.idstring
Unique identifier for the object.

individual.objectstring
String representing the object’s type. Objects of the same type share the same value.

individual.accountstring
The account the individual is associated with.

individual.addressnullable object
The individual’s primary address.
- individual.address.citynullable string
  City, district, suburb, town, or village.
- individual.address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
- individual.address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
- individual.address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
- individual.address.postal_codenullable string
  ZIP or postal code.
- individual.address.statenullable string
  State, county, province, or region.

individual.address_kananullable object
The Kana variation of the individual’s primary address (Japan only).
- individual.address_kana.citynullable string
  City/Ward.
- individual.address_kana.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
- individual.address_kana.line1nullable string
  Block/Building number.
- individual.address_kana.line2nullable string
  Building details.
- individual.address_kana.postal_codenullable string
  ZIP or postal code.
- individual.address_kana.statenullable string
  Prefecture.
- individual.address_kana.townnullable string
  Town/cho-me.

individual.address_kanjinullable object
The Kanji variation of the individual’s primary address (Japan only).
- individual.address_kanji.citynullable string
  City/Ward.
- individual.address_kanji.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
- individual.address_kanji.line1nullable string
  Block/Building number.
- individual.address_kanji.line2nullable string
  Building details.
- individual.address_kanji.postal_codenullable string
  ZIP or postal code.
- individual.address_kanji.statenullable string
  Prefecture.
- individual.address_kanji.townnullable string
  Town/cho-me.

individual.createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

individual.dobnullable object
The individual’s date of birth.
- individual.dob.daynullable integer
  The day of birth, between 1 and 31.
- individual.dob.monthnullable integer
  The month of birth, between 1 and 12.
- individual.dob.yearnullable integer
  The four-digit year of birth.

individual.emailnullable string
The individual’s email address. Also available for accounts where controller.requirement_collection is stripe.

individual.first_namenullable string
The individual’s first name. Also available for accounts where controller.requirement_collection is stripe.

individual.first_name_kananullable string
The Kana variation of the individual’s first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

individual.first_name_kanjinullable string
The Kanji variation of the individual’s first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

individual.full_name_aliasesnullable array of strings
A list of alternate names or aliases that the individual is known by. Also available for accounts where controller.requirement_collection is stripe.

individual.future_requirementsnullable object

Information about the upcoming new requirements for the individual, including what information needs to be collected, and by when.

individual.future_requirements.alternativesnullable array of objects
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- individual.future_requirements.alternatives.alternative_fields_duearray of strings
  Fields that can be provided to satisfy all fields in original_fields_due.
- individual.future_requirements.alternatives.original_fields_duearray of strings
  Fields that are due and can be satisfied by providing all fields in alternative_fields_due.

individual.future_requirements.currently_duearray of strings
Fields that need to be collected to keep the person’s account enabled. If not collected by the account’s future_requirements[current_deadline], these fields will transition to the main requirements hash, and may immediately become past_due, but the account may also be given a grace period depending on the account’s enablement state prior to transition.

individual.future_requirements.errorsarray of objects

Fields that are currently_due and need to be collected again because validation or verification failed.

individual.future_requirements.errors.codeenum

The code for the type of error.

Possible enum values

information_missing

The requirement associated with this error is missing critical information. The associated error reason provides more details.

invalid_address_city_state_postal_code

The combination of the city, state, and postal code in the provided address could not be validated.

invalid_address_highway_contract_box

Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.

invalid_address_private_mailbox

Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.

invalid_business_profile_name

Business profile names must consist of recognizable words.

invalid_business_profile_name_denylisted

Generic or well-known business names aren’t supported.

invalid_company_name_denylisted

Generic or well-known business names aren’t supported.

invalid_dob_age_over_maximum

Date of birth must be within the past 120 years.

invalid_dob_age_under_18

Underage. Age must be at least 18.

invalid_dob_age_under_minimum

Person must be at least 13 years old.

Show 84 more

individual.future_requirements.errors.reasonstring
An informative message that indicates the error type and provides additional details about the error.

individual.future_requirements.errors.requirementstring
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

individual.future_requirements.eventually_duearray of strings
Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account’s future_requirements[current_deadline] becomes set.

individual.future_requirements.past_duearray of strings
Fields that weren’t collected by the account’s requirements.current_deadline. These fields need to be collected to enable the person’s account. New fields will never appear here; future_requirements.past_due will always be a subset of requirements.past_due.

individual.future_requirements.pending_verificationarray of strings
Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to eventually_due or currently_due. Fields might appear in eventually_due or currently_due and in pending_verification if verification fails but another verification is still pending.

individual.gendernullable enum
The individual’s gender.

individual.id_number_providedboolean
Whether the individual’s personal ID number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual’s SSN for the US indicated by ssn_last_4_provided).

individual.id_number_secondary_providednullable boolean
Whether the individual’s personal secondary ID number was provided.

individual.last_namenullable string
The individual’s last name. Also available for accounts where controller.requirement_collection is stripe.

individual.last_name_kananullable string
The Kana varation of the individual’s last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

individual.last_name_kanjinullable string
The Kanji varation of the individual’s last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

individual.maiden_namenullable string
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.nationalitynullable string
The country where the person is a national.

individual.phonenullable string
The individual’s phone number.

individual.political_exposurenullable enum
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_addressnullable object
The individual’s registered address.
- individual.registered_address.citynullable string
  City, district, suburb, town, or village.
- individual.registered_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
- individual.registered_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
- individual.registered_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
- individual.registered_address.postal_codenullable string
  ZIP or postal code.
- individual.registered_address.statenullable string
  State, county, province, or region.

individual.relationshipobject
Describes the individual’s relationship to the account. Also available for accounts where controller.requirement_collection is stripe.
- individual.relationship.authorizernullable boolean
  Whether the person is the authorizer of the account’s representative.
- individual.relationship.directornullable boolean
  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.executivenullable boolean
  Whether the person has significant responsibility to control, manage, or direct the organization.
- individual.relationship.legal_guardiannullable boolean
  Whether the person is the legal guardian of the account’s representative.
- individual.relationship.ownernullable boolean
  Whether the person is an owner of the account’s legal entity.
- individual.relationship.percent_ownershipnullable float
  The percent owned by the person of the account’s legal entity.
- individual.relationship.representativenullable boolean
  Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
- individual.relationship.titlenullable string
  The person’s title (e.g., CEO, Support Engineer).

individual.requirementsnullable object

Information about the requirements for the individual, including what information needs to be collected, and by when.

individual.requirements.alternativesnullable array of objects
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- individual.requirements.alternatives.alternative_fields_duearray of strings
  Fields that can be provided to satisfy all fields in original_fields_due.
- individual.requirements.alternatives.original_fields_duearray of strings
  Fields that are due and can be satisfied by providing all fields in alternative_fields_due.

individual.requirements.currently_duearray of strings
Fields that need to be collected to keep the person’s account enabled. If not collected by the account’s current_deadline, these fields appear in past_due as well, and the account is disabled.

individual.requirements.errorsarray of objects

Fields that are currently_due and need to be collected again because validation or verification failed.

individual.requirements.errors.codeenum

The code for the type of error.

Possible enum values

information_missing

The requirement associated with this error is missing critical information. The associated error reason provides more details.

invalid_address_city_state_postal_code

The combination of the city, state, and postal code in the provided address could not be validated.

invalid_address_highway_contract_box

Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.

invalid_address_private_mailbox

Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.

invalid_business_profile_name

Business profile names must consist of recognizable words.

invalid_business_profile_name_denylisted

Generic or well-known business names aren’t supported.

invalid_company_name_denylisted

Generic or well-known business names aren’t supported.

invalid_dob_age_over_maximum

Date of birth must be within the past 120 years.

invalid_dob_age_under_18

Underage. Age must be at least 18.

invalid_dob_age_under_minimum

Person must be at least 13 years old.

Show 84 more

individual.requirements.errors.reasonstring
An informative message that indicates the error type and provides additional details about the error.

individual.requirements.errors.requirementstring
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

individual.requirements.eventually_duearray of strings
Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account’s current_deadline becomes set.

individual.requirements.past_duearray of strings
Fields that weren’t collected by the account’s current_deadline. These fields need to be collected to enable the person’s account.

individual.requirements.pending_verificationarray of strings
Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to eventually_due, currently_due, or past_due. Fields might appear in eventually_due, currently_due, or past_due and in pending_verification if verification fails but another verification is still pending.

individual.ssn_last_4_providedboolean
Whether the last four digits of the individual’s Social Security number have been provided (U.S. only).

individual.verificationobject
The individual’s verification status.
- individual.verification.additional_documentnullable object
  A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
  individual.verification.additional_document.backnullable stringExpandable
  The back of an ID returned by a file upload with a purpose value of identity_document.
  individual.verification.additional_document.detailsnullable string
  A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say “Identity document is too unclear to read”.
  individual.verification.additional_document.details_codenullable string
  One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
  individual.verification.additional_document.frontnullable stringExpandable
  The front of an ID returned by a file upload with a purpose value of identity_document.
- individual.verification.detailsnullable stringDeprecated
  A user-displayable string describing the verification state for the person. For example, this may say “Provided identity information could not be verified”.
- individual.verification.details_codenullable stringDeprecated
  One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.
- individual.verification.documentobject
  An identifying document for the person, either a passport or local ID card.
  individual.verification.document.backnullable stringExpandable
  The back of an ID returned by a file upload with a purpose value of identity_document.
  individual.verification.document.detailsnullable string
  A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say “Identity document is too unclear to read”.
  individual.verification.document.details_codenullable string
  One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
  individual.verification.document.frontnullable stringExpandable
  The front of an ID returned by a file upload with a purpose value of identity_document.
- individual.verification.statusstringDeprecated
  The state of verification for the person. Possible values are unverified, pending, or verified. Please refer guide to handle verification updates.

metadatanullable object
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.

requirementsnullable object

Information about the requirements for the account, including what information needs to be collected, and by when. You can resolve most requirements programmatically. For some, you must complete a form or challenge through a Stripe interface. Learn more about handling requirements.

requirements.alternativesnullable array of objects
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- requirements.alternatives.alternative_fields_duearray of strings
  Fields that can be provided to satisfy all fields in original_fields_due.
- requirements.alternatives.original_fields_duearray of strings
  Fields that are due and can be satisfied by providing all fields in alternative_fields_due.

requirements.current_deadlinenullable timestamp
Date by which the fields in currently_due must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.

requirements.currently_duenullable array of strings
Fields that need to be collected to keep the account enabled. If not collected by current_deadline, these fields appear in past_due as well, and the account is disabled.

requirements.disabled_reasonnullable enum

If the account is disabled, this enum describes why. Learn more about handling verification issues.

Possible enum values

action_required.requested_capabilities

The account has been disabled because its requested capabilities require action.

listed

The account has been listed.

other

The account has been disabled for another reason.

platform_paused

The account has been paused by the platform.

rejected.fraud

The account has been rejected for fraud.

rejected.incomplete_verification

The account has been rejected for incomplete verification.

rejected.listed

The account has been rejected because it is listed.

rejected.other

The account has been rejected for another reason.

rejected.platform_fraud

The account has been rejected by the platform for fraud.

rejected.platform_other

The account has been rejected by the platform.

Show 5 more

requirements.errorsnullable array of objects

Fields that are currently_due and need to be collected again because validation or verification failed.

requirements.errors.codeenum

The code for the type of error.

Possible enum values

information_missing

The requirement associated with this error is missing critical information. The associated error reason provides more details.

invalid_address_city_state_postal_code

The combination of the city, state, and postal code in the provided address could not be validated.

invalid_address_highway_contract_box

Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.

invalid_address_private_mailbox

Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.

invalid_business_profile_name

Business profile names must consist of recognizable words.

invalid_business_profile_name_denylisted

Generic or well-known business names aren’t supported.

invalid_company_name_denylisted

Generic or well-known business names aren’t supported.

invalid_dob_age_over_maximum

Date of birth must be within the past 120 years.

invalid_dob_age_under_18

Underage. Age must be at least 18.

invalid_dob_age_under_minimum

Person must be at least 13 years old.

Show 84 more

requirements.errors.reasonstring
An informative message that indicates the error type and provides additional details about the error.

requirements.errors.requirementstring
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

requirements.eventually_duenullable array of strings
Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and current_deadline becomes set.

requirements.past_duenullable array of strings
Fields that weren’t collected by current_deadline. These fields need to be collected to enable the account.

requirements.pending_verificationnullable array of strings
Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to eventually_due, currently_due, or past_due. Fields might appear in eventually_due, currently_due, or past_due and in pending_verification if verification fails but another verification is still pending.

tos_acceptanceobject
Details on the acceptance of the Stripe Services Agreement by the account representative.
- tos_acceptance.datenullable timestamp
  The Unix timestamp marking when the account representative accepted their service agreement
- tos_acceptance.ipnullable string
  The IP address from which the account representative accepted their service agreement
- tos_acceptance.service_agreementnullable string
  The user’s service agreement type
- tos_acceptance.user_agentnullable string
  The user agent of the browser from which the account representative accepted their service agreement

typeenum
The Stripe account type. Can be standard, express, custom, or none.
Possible enum values
custom
express
none
Indicates that the account was created with controller attributes that don’t map to a type of standard, express, or custom.
standard

More attributes

objectstring
String representing the object’s type. Objects of the same type share the same value.

business_profilenullable object

Business information about the account.

business_profile.annual_revenuenullable object
The applicant’s gross annual revenue for its preceding fiscal year.
- business_profile.annual_revenue.amountnullable integer
  A non-negative integer representing the amount in the smallest currency unit.
- business_profile.annual_revenue.currencynullable enum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
- business_profile.annual_revenue.fiscal_year_endnullable string
  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_countnullable integer
An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.

business_profile.mccnullable string
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_designationnullable array 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 LGBTGI+ 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_revenuenullable object
An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.
- business_profile.monthly_estimated_revenue.amountinteger
  A non-negative integer representing how much to charge in the smallest currency unit.
- business_profile.monthly_estimated_revenue.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.

business_profile.namenullable string
The customer-facing business name.

business_profile.product_descriptionnullable string
Internal-only description of the product sold or service provided by the business. It’s used by Stripe for risk and underwriting purposes.

business_profile.support_addressnullable object
A publicly available mailing address for sending support issues to.
- business_profile.support_address.citynullable string
  City, district, suburb, town, or village.
- business_profile.support_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
- business_profile.support_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
- business_profile.support_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
- business_profile.support_address.postal_codenullable string
  ZIP or postal code.
- business_profile.support_address.statenullable string
  State, county, province, or region.

business_profile.support_emailnullable string
A publicly available email address for sending support issues to.

business_profile.support_phonenullable string
A publicly available phone number to call with support issues.

business_profile.support_urlnullable string
A publicly available website for handling support issues.

business_profile.urlnullable string
The business’s publicly available website.

charges_enabledboolean
Whether the account can process charges.

controllernullable object

The controller of the account.

controller.feesnullable object

A hash of configuration related to fees for this account. Only returned when the Connect application retrieving the resource controls the account.

controller.fees.payerenum

A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about fee behavior on connected accounts.

Possible enum values

account

The account is responsible for paying Stripe fees.

application

The Connect application is responsible for Stripe fees on pricing-control eligible products.

application_custom

The Connect application is responsible for fees matching the behavior of Custom accounts.

application_express

The Connect application is responsible for fees matching the behavior of Express accounts.

controller.is_controllernullable boolean
true if the Connect application retrieving the resource controls the account and can therefore exercise platform controls. Otherwise, this field is null.

controller.lossesnullable object

The list of products that have a negative balance liability and whether Stripe or a Connect application is responsible. Only returned when the Connect application retrieving the resource controls the account.

controller.losses.paymentsenum

A value indicating who is liable when this account can’t pay back negative balances from payments.

Possible enum values

application

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_collectionnullable enum

A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.

Possible enum values

application

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_dashboardnullable object

A hash of configuration controlling Stripe provided dashboards. Only returned when the Connect application retrieving the resource controls the account.

controller.stripe_dashboard.typeenum

A value indicating the Stripe dashboard this account has access to independent of the Connect application.

Possible enum values

express

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.

controller.typeenum
The controller type. Can be application, if a Connect application controls the account, or account, if the account controls itself.
Possible enum values
account
application

createdtimestamp
Time at which the account was connected. Measured in seconds since the Unix epoch.

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

details_submittedboolean
Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details.

external_accountsobject

External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where controller[is_controller] is true.

external_accounts.objectstring
String representing the object’s type. Objects of the same type share the same value. Always has the value list.

external_accounts.dataarray of objects

The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.

external_accounts.data.idstring
Unique identifier for the object.

external_accounts.data.objectstring
String representing the object’s type. Objects of the same type share the same value.

external_accounts.data.accountnullable stringExpandableAvailable conditionally
The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where controller.is_controller is true.

external_accounts.data.address_citynullable string
City/District/Suburb/Town/Village.

external_accounts.data.address_countrynullable string
Billing address country, if provided when creating card.

external_accounts.data.address_line1nullable string
Address line 1 (Street address/PO Box/Company name).

external_accounts.data.address_line1_checknullable string
If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.

external_accounts.data.address_line2nullable string
Address line 2 (Apartment/Suite/Unit/Building).

external_accounts.data.address_statenullable string
State/County/Province/Region.

external_accounts.data.address_zipnullable string
ZIP or postal code.

external_accounts.data.address_zip_checknullable string
If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.

external_accounts.data.allow_redisplaynullable enum

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

Possible enum values

always

Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

limited

Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

unspecified

This is the default value for payment methods where allow_redisplay wasn’t set.

external_accounts.data.available_payout_methodsnullable array of enums
A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.
Possible enum values
instant
standard

external_accounts.data.brandstring
Card brand. Can be American Express, Diners Club, Discover, Eftpos Australia, Girocard, JCB, MasterCard, UnionPay, Visa, or Unknown.

external_accounts.data.countrynullable string
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

external_accounts.data.currencynullable enumAvailable conditionally
Three-letter ISO code for currency in lowercase. Must be a supported currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where controller.is_controller is true.

external_accounts.data.customernullable stringExpandable
The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.

external_accounts.data.cvc_checknullable string
If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked. A result of unchecked indicates that CVC was provided but hasn’t been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

external_accounts.data.default_for_currencynullable booleanAvailable conditionally
Whether this card is the default external account for its currency. This property is only available for accounts where controller.requirement_collection is application, which includes Custom accounts.

external_accounts.data.dynamic_last4nullable string
(For tokenized numbers only.) The last four digits of the device account number.

external_accounts.data.exp_monthinteger
Two-digit number representing the card’s expiration month.

external_accounts.data.exp_yearinteger
Four-digit number representing the card’s expiration year.

external_accounts.data.fingerprintnullable string
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

external_accounts.data.fundingstring
Card funding type. Can be credit, debit, prepaid, or unknown.

external_accounts.data.iinnullable string
Issuer identification number of the card.

external_accounts.data.last4string
The last four digits of the card.

external_accounts.data.metadatanullable object
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.

external_accounts.data.namenullable string
Cardholder name.

external_accounts.data.regulated_statusnullable enum
Status of a card based on the card issuer.
Possible enum values
regulated
The card falls under a regulated account range.
unregulated
The card does not fall under a regulated account range.

external_accounts.data.statusnullable string
For external accounts that are cards, possible values are new and errored. If a payout fails, the status is set to errored and scheduled payouts are stopped until account details are updated.

external_accounts.data.tokenization_methodnullable string
If the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null.

external_accounts.data.walletnullable objectPreview feature
If this Card is part of a card wallet, this contains the details of the card wallet.
- external_accounts.data.wallet.apple_paynullable object
  If this is a apple_pay card wallet, this hash contains details about the wallet.
- external_accounts.data.wallet.typeenum
  The type of the card wallet, one of apple_pay or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
  Possible enum values
  apple_pay
  link

external_accounts.has_moreboolean
True if this list has another page of items after this one that can be fetched.

external_accounts.urlstring
The URL where this list can be accessed.

future_requirementsnullable object

Information about the upcoming new requirements for the account, including what information needs to be collected, and by when.

future_requirements.alternativesnullable array of objects
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- future_requirements.alternatives.alternative_fields_duearray of strings
  Fields that can be provided to satisfy all fields in original_fields_due.
- future_requirements.alternatives.original_fields_duearray of strings
  Fields that are due and can be satisfied by providing all fields in alternative_fields_due.

future_requirements.current_deadlinenullable timestamp
Date on which future_requirements becomes the main requirements hash and future_requirements becomes empty. After the transition, currently_due requirements may immediately become past_due, but the account may also be given a grace period depending on its enablement state prior to transitioning.

future_requirements.currently_duenullable array of strings
Fields that need to be collected to keep the account enabled. If not collected by future_requirements[current_deadline], these fields will transition to the main requirements hash.

future_requirements.disabled_reasonnullable enum

This is typed as an enum for consistency with requirements.disabled_reason.

Possible enum values

action_required.requested_capabilities

The account has been disabled because its requested capabilities require action.

listed

The account has been listed.

other

The account has been disabled for another reason.

platform_paused

The account has been paused by the platform.

rejected.fraud

The account has been rejected for fraud.

rejected.incomplete_verification

The account has been rejected for incomplete verification.

rejected.listed

The account has been rejected because it is listed.

rejected.other

The account has been rejected for another reason.

rejected.platform_fraud

The account has been rejected by the platform for fraud.

rejected.platform_other

The account has been rejected by the platform.

Show 5 more

future_requirements.errorsnullable array of objects

Fields that are currently_due and need to be collected again because validation or verification failed.

future_requirements.errors.codeenum

The code for the type of error.

Possible enum values

information_missing

The requirement associated with this error is missing critical information. The associated error reason provides more details.

invalid_address_city_state_postal_code

The combination of the city, state, and postal code in the provided address could not be validated.

invalid_address_highway_contract_box

Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.

invalid_address_private_mailbox

Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.

invalid_business_profile_name

Business profile names must consist of recognizable words.

invalid_business_profile_name_denylisted

Generic or well-known business names aren’t supported.

invalid_company_name_denylisted

Generic or well-known business names aren’t supported.

invalid_dob_age_over_maximum

Date of birth must be within the past 120 years.

invalid_dob_age_under_18

Underage. Age must be at least 18.

invalid_dob_age_under_minimum

Person must be at least 13 years old.

Show 84 more

future_requirements.errors.reasonstring
An informative message that indicates the error type and provides additional details about the error.

future_requirements.errors.requirementstring
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

future_requirements.eventually_duenullable array of strings
Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well.

future_requirements.past_duenullable array of strings
Fields that weren’t collected by requirements.current_deadline. These fields need to be collected to enable the capability on the account. New fields will never appear here; future_requirements.past_due will always be a subset of requirements.past_due.

future_requirements.pending_verificationnullable array of strings
Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to eventually_due or currently_due. Fields might appear in eventually_due or currently_due and in pending_verification if verification fails but another verification is still pending.

groupsnullable objectPreview featureExpandable
The groups associated with the account.
- groups.payments_pricingnullable string
  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.

payouts_enabledboolean
Whether the funds in this account can be paid out.

settingsnullable object
Options for customizing how the account functions within Stripe.
- settings.bacs_debit_paymentsnullable object
  Settings specific to Bacs Direct Debit on the account.
  settings.bacs_debit_payments.display_namenullable string
  The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don’t set the display name before requesting Bacs capability, it’s automatically set as “Stripe” and the account is onboarded to Stripe branding, which is free.
  settings.bacs_debit_payments.service_user_numbernullable string
  The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.
- settings.brandingobject
  Settings used to apply the account’s branding to email receipts, invoices, Checkout, and other products.
  settings.branding.iconnullable stringExpandable
  (ID of a file upload) An icon for the account. Must be square and at least 128px x 128px.
  settings.branding.logonullable stringExpandable
  (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_colornullable string
  A CSS hex color value representing the primary branding color for this account
  settings.branding.secondary_colornullable string
  A CSS hex color value representing the secondary branding color for this account
- settings.card_issuingnullable object
  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.datenullable integer
  The Unix timestamp marking when the account representative accepted the service agreement.
  settings.card_issuing.tos_acceptance.ipnullable string
  The IP address from which the account representative accepted the service agreement.
  settings.card_issuing.tos_acceptance.user_agentnullable string
  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.card_payments.statement_descriptor_prefixnullable string
  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.card_payments.statement_descriptor_prefix_kananullable string
  The Kana variation of statement_descriptor_prefix used for card charges in Japan. Japanese statement descriptors have special requirements.
  settings.card_payments.statement_descriptor_prefix_kanjinullable string
  The Kanji variation of statement_descriptor_prefix used for card charges in Japan. Japanese statement descriptors have special requirements.
- settings.dashboardobject
  Settings used to configure the account within the Stripe dashboard.
  settings.dashboard.display_namenullable string
  The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.
  settings.dashboard.timezonenullable string
  The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the IANA Time Zone Database.
- settings.invoicesnullable object
  Settings specific to the account’s use of Invoices.
  settings.invoices.default_account_tax_idsnullable array of stringsExpandable
  The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.
- settings.paymentsobject
  Settings that apply across payment methods for charging on the account.
  settings.payments.statement_descriptornullable string
  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_kananullable string
  The Kana variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have special requirements.
  settings.payments.statement_descriptor_kanjinullable string
  The Kanji variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have special requirements.
- settings.payoutsobject
  Settings specific to the account’s payouts.
  settings.payouts.debit_negative_balancesboolean
  A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See Understanding Connect account balances for details. The default value is false when controller.requirement_collection is application, which includes Custom accounts, otherwise true.
  settings.payouts.scheduleobject
  Details on when funds from charges are available, and when they are paid out to an external account. See our Setting Bank and Debit Card Payouts documentation for details.
  settings.payouts.schedule.delay_daysinteger
  The number of days charges for the account will be held before being paid out.
  settings.payouts.schedule.intervalstring
  How frequently funds will be paid out. One of manual (payouts only created via API call), daily, weekly, or monthly.
  settings.payouts.schedule.monthly_anchornullable integer
  The day of the month funds will be paid out. Only shown if interval is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
  settings.payouts.schedule.weekly_anchornullable string
  The day of the week funds will be paid out, of the style ‘monday’, ‘tuesday’, etc. Only shown if interval is weekly.
  settings.payouts.statement_descriptornullable string
  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.
- settings.sepa_debit_paymentsnullable object
  Settings specific to SEPA Direct Debit on the account.
  settings.sepa_debit_payments.creditor_idnullable string
  SEPA creditor identifier that identifies the company making the payment.

The Account object

{
  "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"
}

The Account object

Attributes

idstring

business_typenullable enum

capabilitiesnullable object

capabilities.acss_debit_paymentsnullable enum

capabilities.affirm_paymentsnullable enum

capabilities.afterpay_clearpay_paymentsnullable enum

capabilities.alma_paymentsnullable enum

capabilities.amazon_pay_paymentsnullable enum

capabilities.au_becs_debit_paymentsnullable enum

capabilities.bacs_debit_paymentsnullable enum

capabilities.bancontact_paymentsnullable enum

capabilities.bank_transfer_paymentsnullable enum

capabilities.billie_paymentsnullable enum

capabilities.blik_paymentsnullable enum

capabilities.boleto_paymentsnullable enum

capabilities.card_issuingnullable enum

capabilities.card_paymentsnullable enum

capabilities.cartes_bancaires_paymentsnullable enum

capabilities.cashapp_paymentsnullable enum

capabilities.eps_paymentsnullable enum

capabilities.fpx_paymentsnullable enum

capabilities.gb_bank_transfer_paymentsnullable enum

capabilities.giropay_paymentsnullable enum

capabilities.grabpay_paymentsnullable enum

capabilities.ideal_paymentsnullable enum

capabilities.india_international_paymentsnullable enum

capabilities.jcb_paymentsnullable enum

capabilities.jp_bank_transfer_paymentsnullable enum

capabilities.kakao_pay_paymentsnullable enum

capabilities.klarna_paymentsnullable enum

capabilities.konbini_paymentsnullable enum

capabilities.kr_card_paymentsnullable enum

capabilities.legacy_paymentsnullable enum

capabilities.link_paymentsnullable enum

capabilities.mobilepay_paymentsnullable enum

capabilities.multibanco_paymentsnullable enum

capabilities.mx_bank_transfer_paymentsnullable enum

capabilities.naver_pay_paymentsnullable enum

capabilities.nz_bank_account_becs_debit_paymentsnullable enum

capabilities.oxxo_paymentsnullable enum

capabilities.p24_paymentsnullable enum

capabilities.pay_by_bank_paymentsnullable enum

capabilities.payco_paymentsnullable enum

capabilities.paynow_paymentsnullable enum

capabilities.promptpay_paymentsnullable enum

capabilities.revolut_pay_paymentsnullable enum

capabilities.samsung_pay_paymentsnullable enum

capabilities.satispay_paymentsnullable enum

capabilities.sepa_bank_transfer_paymentsnullable enum

capabilities.sepa_debit_paymentsnullable enum

capabilities.sofort_paymentsnullable enum

capabilities.swish_paymentsnullable enum

capabilities.tax_reporting_us_1099_knullable enum

capabilities.tax_reporting_us_1099_miscnullable enum

capabilities.transfersnullable enum

capabilities.twint_paymentsnullable enum

capabilities.us_bank_account_ach_paymentsnullable enum

capabilities.us_bank_transfer_paymentsnullable enum

capabilities.zip_paymentsnullable enum

companynullable object

company.addressnullable object

company.address.citynullable string

company.address.countrynullable string

company.address.line1nullable string

company.address.line2nullable string

company.address.postal_codenullable string

company.address.statenullable string

company.address_kananullable object

company.address_kana.citynullable string

company.address_kana.countrynullable string

company.address_kana.line1nullable string

company.address_kana.line2nullable string

company.address_kana.postal_codenullable string

company.address_kana.statenullable string

company.address_kana.townnullable string

company.address_kanjinullable object

company.address_kanji.citynullable string

company.address_kanji.countrynullable string