Update an Account v2

Updates the details of an Account.

Parameters

• idstringRequired

  The ID of the Account to update.

• configurationobject

  An Account Configuration which allows the Account to take on a key persona across Stripe products.

  Hide child parameters

  • configuration.customerobject

    The Customer Configuration allows the Account to be charged.

    Hide child parameters

    • configuration.customer.appliedboolean

      Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.

    • configuration.customer.automatic_indirect_taxobject

      Automatic indirect tax settings to be used when automatic tax calculation is enabled on the customer’s invoices, subscriptions, checkout sessions, or payment links. Surfaces if automatic tax calculation is possible given the current customer location information.

      Hide child parameters

      • configuration.customer.automatic_indirect_tax.exemptenum

        Describes the customer’s tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: “Reverse charge”.

        Possible enum values

        exempt Exempt.

        none None.

        reverse Reverse.

      • configuration.customer.automatic_indirect_tax.ip_addressstring

        A recent IP address of the customer used for tax reporting and tax location inference.

      • configuration.customer.automatic_indirect_tax.location_sourceenum

        The data source used to identify the customer’s tax location - defaults to ‘identity_address’. Will only be used for automatic tax calculation on the customer’s Invoices and Subscriptions.

        Possible enum values

        identity_address Identity address (identity.business_details.address or identity.individual.address).

        ip_address IP address.

        shipping_address Shipping address.

      • configuration.customer.automatic_indirect_tax.validate_locationenum

        A per-request flag that indicates when Stripe should validate the customer tax location - defaults to ‘auto’.

        Possible enum values

        auto Validate the v2 account customer’s tax location immediately if it has active automatic tax enabled subscriptions. Default.

        deferred Defer the validation of the v2 account customer’s tax location until needed, such as when Stripe Tax is calculating taxes on an Invoice.

        immediately Validate the v2 account customer’s tax location immediately. An error is returned and the v2 account is not updated if the tax location is invalid.

    • configuration.customer.billingobject

      Billing settings - default settings used for this customer in Billing flows such as Invoices and Subscriptions.

      Hide child parameters

      • configuration.customer.billing.default_payment_methodstring

        ID of a payment method that’s attached to the customer, to be used as the customer’s default payment method for invoices and subscriptions.

      • configuration.customer.billing.invoiceobject

        Default settings used on invoices for this customer.

        Hide child parameters

        • configuration.customer.billing.invoice.custom_fieldsarray of objects

          The list of up to 4 default custom fields to be displayed on invoices for this customer.

          Hide child parameters

          • configuration.customer.billing.invoice.custom_fields.namestringRequired

            The name of the custom field. This may be up to 40 characters.

          • configuration.customer.billing.invoice.custom_fields.valuestringRequired

            The value of the custom field. This may be up to 140 characters. When updating, pass an empty string to remove previously-defined values.

        • configuration.customer.billing.invoice.footerstring

          Default footer to be displayed on invoices for this customer.

        • configuration.customer.billing.invoice.next_sequenceinteger

          The sequence to be used on the customer’s next invoice. Defaults to 1.

        • configuration.customer.billing.invoice.prefixstring

          The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.

        • configuration.customer.billing.invoice.renderingobject

          Default options for invoice PDF rendering for this customer.

          Hide child parameters

          • configuration.customer.billing.invoice.rendering.amount_tax_displayenum

            How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.

            Possible enum values

            exclude_tax Exclude tax.

            include_inclusive_tax Include inclusive tax.

          • configuration.customer.billing.invoice.rendering.templatestring

            ID of the invoice rendering template to use for future invoices.

    • configuration.customer.capabilitiesobject

      Capabilities that have been requested on the Customer Configuration.

      Hide child parameters

      • configuration.customer.capabilities.automatic_indirect_taxobject

        Generates requirements for enabling automatic indirect tax calculation on this customer’s invoices or subscriptions. Recommended to request this capability if planning to enable automatic tax calculation on this customer’s invoices or subscriptions. Uses the location_source field.

        Hide child parameters

        • configuration.customer.capabilities.automatic_indirect_tax.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

    • configuration.customer.shippingobject

      The customer’s shipping information. Appears on invoices emailed to this customer.

      Hide child parameters

      • configuration.customer.shipping.addressobject

        Customer shipping address.

        Hide child parameters

        • configuration.customer.shipping.address.citystring

          City, district, suburb, town, or village.

        • configuration.customer.shipping.address.countryenum

          Two-letter country code (ISO 3166-1 alpha-2).

        • configuration.customer.shipping.address.line1string

          Address line 1 (e.g., street, PO Box, or company name).

        • configuration.customer.shipping.address.line2string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • configuration.customer.shipping.address.postal_codestring

          ZIP or postal code.

        • configuration.customer.shipping.address.statestring

          State, county, province, or region.

      • configuration.customer.shipping.namestring

        Customer name.

      • configuration.customer.shipping.phonestring

        Customer phone (including extension).

    • configuration.customer.test_clockstring

      ID of the test clock to attach to the customer. Can only be set on testmode Accounts, and when the Customer Configuration is first set on an Account.

  • configuration.merchantobject

    The Merchant configuration allows the Account to act as a connected account and collect payments facilitated by a Connect platform. You can add this configuration to your connected accounts only if you’ve completed onboarding as a Connect platform.

    Hide child parameters

    • configuration.merchant.appliedboolean

      Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.

    • configuration.merchant.bacs_debit_paymentsobject

      Settings used for Bacs debit payments.

      Hide child parameters

      • configuration.merchant.bacs_debit_payments.display_namestring

        Display name for Bacs debit payments.

    • configuration.merchant.brandingobject

      Settings used to apply the merchant’s branding to email receipts, invoices, Checkout, and other products.

      Hide child parameters

      • configuration.merchant.branding.iconstring

        ID of a file upload: An icon for the merchant. Must be square and at least 128px x 128px.

      • configuration.merchant.branding.logostring

        ID of a file upload: A logo for the merchant that will be used in Checkout instead of the icon and without the merchant’s name next to it if provided. Must be at least 128px x 128px.

      • configuration.merchant.branding.primary_colorstring

        A CSS hex color value representing the primary branding color for the merchant.

      • configuration.merchant.branding.secondary_colorstring

        A CSS hex color value representing the secondary branding color for the merchant.

    • configuration.merchant.capabilitiesobject

      Capabilities to request on the Merchant Configuration.

      Hide child parameters

      • configuration.merchant.capabilities.ach_debit_paymentsobject

        Allow the merchant to process ACH debit payments.

        Hide child parameters

        • configuration.merchant.capabilities.ach_debit_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.acss_debit_paymentsobject

        Allow the merchant to process ACSS debit payments.

        Hide child parameters

        • configuration.merchant.capabilities.acss_debit_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.affirm_paymentsobject

        Allow the merchant to process Affirm payments.

        Hide child parameters

        • configuration.merchant.capabilities.affirm_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.afterpay_clearpay_paymentsobject

        Allow the merchant to process Afterpay/Clearpay payments.

        Hide child parameters

        • configuration.merchant.capabilities.afterpay_clearpay_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.alma_paymentsobject

        Allow the merchant to process Alma payments.

        Hide child parameters

        • configuration.merchant.capabilities.alma_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.amazon_pay_paymentsobject

        Allow the merchant to process Amazon Pay payments.

        Hide child parameters

        • configuration.merchant.capabilities.amazon_pay_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.au_becs_debit_paymentsobject

        Allow the merchant to process Australian BECS Direct Debit payments.

        Hide child parameters

        • configuration.merchant.capabilities.au_becs_debit_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.bacs_debit_paymentsobject

        Allow the merchant to process BACS Direct Debit payments.

        Hide child parameters

        • configuration.merchant.capabilities.bacs_debit_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.bancontact_paymentsobject

        Allow the merchant to process Bancontact payments.

        Hide child parameters

        • configuration.merchant.capabilities.bancontact_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.blik_paymentsobject

        Allow the merchant to process BLIK payments.

        Hide child parameters

        • configuration.merchant.capabilities.blik_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.boleto_paymentsobject

        Allow the merchant to process Boleto payments.

        Hide child parameters

        • configuration.merchant.capabilities.boleto_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.card_paymentsobject

        Allow the merchant to collect card payments.

        Hide child parameters

        • configuration.merchant.capabilities.card_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.cartes_bancaires_paymentsobject

        Allow the merchant to process Cartes Bancaires payments.

        Hide child parameters

        • configuration.merchant.capabilities.cartes_bancaires_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.cashapp_paymentsobject

        Allow the merchant to process Cash App payments.

        Hide child parameters

        • configuration.merchant.capabilities.cashapp_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.eps_paymentsobject

        Allow the merchant to process EPS payments.

        Hide child parameters

        • configuration.merchant.capabilities.eps_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.fpx_paymentsobject

        Allow the merchant to process FPX payments.

        Hide child parameters

        • configuration.merchant.capabilities.fpx_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.gb_bank_transfer_paymentsobject

        Allow the merchant to process UK bank transfer payments.

        Hide child parameters

        • configuration.merchant.capabilities.gb_bank_transfer_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.grabpay_paymentsobject

        Allow the merchant to process GrabPay payments.

        Hide child parameters

        • configuration.merchant.capabilities.grabpay_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.ideal_paymentsobject

        Allow the merchant to process iDEAL payments.

        Hide child parameters

        • configuration.merchant.capabilities.ideal_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.jcb_paymentsobject

        Allow the merchant to process JCB card payments.

        Hide child parameters

        • configuration.merchant.capabilities.jcb_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.jp_bank_transfer_paymentsobject

        Allow the merchant to process Japanese bank transfer payments.

        Hide child parameters

        • configuration.merchant.capabilities.jp_bank_transfer_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.kakao_pay_paymentsobject

        Allow the merchant to process Kakao Pay payments.

        Hide child parameters

        • configuration.merchant.capabilities.kakao_pay_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.klarna_paymentsobject

        Allow the merchant to process Klarna payments.

        Hide child parameters

        • configuration.merchant.capabilities.klarna_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.konbini_paymentsobject

        Allow the merchant to process Konbini convenience store payments.

        Hide child parameters

        • configuration.merchant.capabilities.konbini_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.kr_card_paymentsobject

        Allow the merchant to process Korean card payments.

        Hide child parameters

        • configuration.merchant.capabilities.kr_card_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.link_paymentsobject

        Allow the merchant to process Link payments.

        Hide child parameters

        • configuration.merchant.capabilities.link_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.mobilepay_paymentsobject

        Allow the merchant to process MobilePay payments.

        Hide child parameters

        • configuration.merchant.capabilities.mobilepay_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.multibanco_paymentsobject

        Allow the merchant to process Multibanco payments.

        Hide child parameters

        • configuration.merchant.capabilities.multibanco_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.mx_bank_transfer_paymentsobject

        Allow the merchant to process Mexican bank transfer payments.

        Hide child parameters

        • configuration.merchant.capabilities.mx_bank_transfer_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.naver_pay_paymentsobject

        Allow the merchant to process Naver Pay payments.

        Hide child parameters

        • configuration.merchant.capabilities.naver_pay_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.oxxo_paymentsobject

        Allow the merchant to process OXXO payments.

        Hide child parameters

        • configuration.merchant.capabilities.oxxo_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.p24_paymentsobject

        Allow the merchant to process Przelewy24 (P24) payments.

        Hide child parameters

        • configuration.merchant.capabilities.p24_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.pay_by_bank_paymentsobject

        Allow the merchant to process Pay by Bank payments.

        Hide child parameters

        • configuration.merchant.capabilities.pay_by_bank_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.payco_paymentsobject

        Allow the merchant to process PAYCO payments.

        Hide child parameters

        • configuration.merchant.capabilities.payco_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.paynow_paymentsobject

        Allow the merchant to process PayNow payments.

        Hide child parameters

        • configuration.merchant.capabilities.paynow_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.promptpay_paymentsobject

        Allow the merchant to process PromptPay payments.

        Hide child parameters

        • configuration.merchant.capabilities.promptpay_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.revolut_pay_paymentsobject

        Allow the merchant to process Revolut Pay payments.

        Hide child parameters

        • configuration.merchant.capabilities.revolut_pay_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.samsung_pay_paymentsobject

        Allow the merchant to process Samsung Pay payments.

        Hide child parameters

        • configuration.merchant.capabilities.samsung_pay_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.sepa_bank_transfer_paymentsobject

        Allow the merchant to process SEPA bank transfer payments.

        Hide child parameters

        • configuration.merchant.capabilities.sepa_bank_transfer_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.sepa_debit_paymentsobject

        Allow the merchant to process SEPA Direct Debit payments.

        Hide child parameters

        • configuration.merchant.capabilities.sepa_debit_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.swish_paymentsobject

        Allow the merchant to process Swish payments.

        Hide child parameters

        • configuration.merchant.capabilities.swish_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.twint_paymentsobject

        Allow the merchant to process TWINT payments.

        Hide child parameters

        • configuration.merchant.capabilities.twint_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.us_bank_transfer_paymentsobject

        Allow the merchant to process US bank transfer payments.

        Hide child parameters

        • configuration.merchant.capabilities.us_bank_transfer_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.merchant.capabilities.zip_paymentsobject

        Allow the merchant to process Zip payments.

        Hide child parameters

        • configuration.merchant.capabilities.zip_payments.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

    • configuration.merchant.card_paymentsobject

      Card payments settings.

      Hide child parameters

      • configuration.merchant.card_payments.decline_onobject

        Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.

        Hide child parameters

        • configuration.merchant.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.

        • configuration.merchant.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.

    • configuration.merchant.mccstring

      The merchant category code for the merchant. MCCs are used to classify businesses based on the goods or services they provide.

    • configuration.merchant.statement_descriptorobject

      Statement descriptor.

      Hide child parameters

      • configuration.merchant.statement_descriptor.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 Merchant Configuration settings documentation.

      • configuration.merchant.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 Merchant Configuration settings documentation.

    • configuration.merchant.supportobject

      Publicly available contact information for sending support issues to.

      Hide child parameters

      • configuration.merchant.support.addressobject

        A publicly available mailing address for sending support issues to.

        Hide child parameters

        • configuration.merchant.support.address.citystring

          City, district, suburb, town, or village.

        • configuration.merchant.support.address.countryenum

          Two-letter country code (ISO 3166-1 alpha-2).

        • configuration.merchant.support.address.line1string

          Address line 1 (e.g., street, PO Box, or company name).

        • configuration.merchant.support.address.line2string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • configuration.merchant.support.address.postal_codestring

          ZIP or postal code.

        • configuration.merchant.support.address.statestring

          State, county, province, or region.

        • configuration.merchant.support.address.townstring

          Town or cho-me.

      • configuration.merchant.support.emailstring

        A publicly available email address for sending support issues to.

      • configuration.merchant.support.phonestring

        A publicly available phone number to call with support issues.

      • configuration.merchant.support.urlstring

        A publicly available website for handling support issues.

  • configuration.recipientobject

    The Recipient Configuration allows the Account to receive funds.

    Hide child parameters

    • configuration.recipient.appliedboolean

      Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.

    • configuration.recipient.capabilitiesobject

      Capabilities to request on the Recipient Configuration.

      Hide child parameters

      • configuration.recipient.capabilities.bank_accountsobject

        Capabilities that enable OutboundPayments to a bank account linked to this Account.

        Hide child parameters

        • configuration.recipient.capabilities.bank_accounts.localobject

          Enables this Account to receive OutboundPayments to linked bank accounts over local networks.

          Hide child parameters

          • configuration.recipient.capabilities.bank_accounts.local.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

        • configuration.recipient.capabilities.bank_accounts.wireobject

          Enables this Account to receive OutboundPayments to linked bank accounts over wire.

          Hide child parameters

          • configuration.recipient.capabilities.bank_accounts.wire.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.recipient.capabilities.cardsobject

        Capability that enable OutboundPayments to a debit card linked to this Account.

        Hide child parameters

        • configuration.recipient.capabilities.cards.requestedboolean

          To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.recipient.capabilities.stripe_balanceobject

        Capabilities that enable the recipient to manage their Stripe Balance (/v1/balance).

        Hide child parameters

        • configuration.recipient.capabilities.stripe_balance.stripe_transfersobject

          Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance).

          Hide child parameters

          • configuration.recipient.capabilities.stripe_balance.stripe_transfers.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

    • configuration.recipient.default_outbound_destinationstring

      The payout method id to be used as a default outbound destination. This will allow the PayoutMethod to be omitted on OutboundPayments made through API or sending payouts via dashboard. Can also be explicitly set to null to clear the existing default outbound destination.

  • configuration.storerobjectPreview feature

    The Storer Configuration allows the Account to store and move funds using stored-value FinancialAccounts.

    Hide child parameters

    • configuration.storer.appliedboolean

      Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.

    • configuration.storer.capabilitiesobject

      Capabilities to request on the Storer Configuration.

      Hide child parameters

      • configuration.storer.capabilities.financial_addressesobject

        Can provision a financial address to credit/debit a FinancialAccount.

        Hide child parameters

        • configuration.storer.capabilities.financial_addresses.bank_accountsobject

          Can provision a bank-account-like financial address (VBAN) to credit/debit a FinancialAccount.

          Hide child parameters

          • configuration.storer.capabilities.financial_addresses.bank_accounts.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.storer.capabilities.holds_currenciesobject

        Can hold storage-type funds on Stripe.

        Hide child parameters

        • configuration.storer.capabilities.holds_currencies.gbpobject

          Can hold storage-type funds on Stripe in GBP.

          Hide child parameters

          • configuration.storer.capabilities.holds_currencies.gbp.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.storer.capabilities.inbound_transfersobject

        Can pull funds from an external source, owned by yourself, to a FinancialAccount.

        Hide child parameters

        • configuration.storer.capabilities.inbound_transfers.bank_accountsobject

          Can pull funds from an external bank account owned by yourself to a FinancialAccount.

          Hide child parameters

          • configuration.storer.capabilities.inbound_transfers.bank_accounts.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.storer.capabilities.outbound_paymentsobject

        Can send funds from a FinancialAccount to a destination owned by someone else.

        Hide child parameters

        • configuration.storer.capabilities.outbound_payments.bank_accountsobject

          Can send funds from a FinancialAccount to a bank account owned by someone else.

          Hide child parameters

          • configuration.storer.capabilities.outbound_payments.bank_accounts.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

        • configuration.storer.capabilities.outbound_payments.cardsobject

          Can send funds from a FinancialAccount to a debit card owned by someone else.

          Hide child parameters

          • configuration.storer.capabilities.outbound_payments.cards.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

        • configuration.storer.capabilities.outbound_payments.financial_accountsobject

          Can send funds from a FinancialAccount to another FinancialAccount owned by someone else.

          Hide child parameters

          • configuration.storer.capabilities.outbound_payments.financial_accounts.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

      • configuration.storer.capabilities.outbound_transfersobject

        Can send funds from a FinancialAccount to a destination owned by yourself.

        Hide child parameters

        • configuration.storer.capabilities.outbound_transfers.bank_accountsobject

          Can send funds from a FinancialAccount to a bank account owned by yourself.

          Hide child parameters

          • configuration.storer.capabilities.outbound_transfers.bank_accounts.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

        • configuration.storer.capabilities.outbound_transfers.financial_accountsobject

          Can send funds from a FinancialAccount to another FinancialAccount owned by yourself.

          Hide child parameters

          • configuration.storer.capabilities.outbound_transfers.financial_accounts.requestedboolean

            To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.

• contact_emailstring

  The default contact email address for the Account. Required when configuring the account as a merchant or recipient.

• dashboardenum

  A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account.

  Possible enum values

  express The Account has access to the Express hosted dashboard.

  full The Account has access to the full Stripe hosted dashboard.

  none The Account does not have access to any Stripe hosted dashboard.

• defaultsobject

  Default values to be used on Account Configurations.

  Hide child parameters

  • defaults.currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • defaults.localesarray of enums

    The Account’s preferred locales (languages), ordered by preference.

    Possible enum values

    ar-SA IETF Locale.

    bg IETF Locale.

    bg-BG IETF Locale.

    cs IETF Locale.

    cs-CZ IETF Locale.

    da IETF Locale.

    da-DK IETF Locale.

    de IETF Locale.

    de-DE IETF Locale.

    el IETF Locale.

    Show 74 more

  • defaults.responsibilitiesobject

    Default responsibilities held by either Stripe or the platform.

    Hide child parameters

    • defaults.responsibilities.fees_collectorenumRequired

      A value indicating the party responsible for collecting fees from this account.

      Possible enum values

      application The platform is responsible for collecting fees from the Account.

      stripe Stripe is responsible for collecting fees from the Account.

    • defaults.responsibilities.losses_collectorenumRequired

      A value indicating who is responsible for losses when this Account can’t pay back negative balances from payments.

      Possible enum values

      application The platform is responsible for negative balances on the Account.

      stripe Stripe is responsible for negative balances on this Account.

• display_namestring

  A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.

• identityobject

  Information about the company, individual, and business represented by the Account.

  Hide child parameters

  • identity.attestationsobject

    Attestations from the identity’s key people, e.g. owners, executives, directors.

    Hide child parameters

    • identity.attestations.directorship_declarationobject

      This hash is used to attest that the directors information provided to Stripe is both current and correct.

      Hide child parameters

      • identity.attestations.directorship_declaration.datetimestamp

        The time marking when the director attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

      • identity.attestations.directorship_declaration.ipstring

        The IP address from which the director attestation was made.

      • identity.attestations.directorship_declaration.user_agentstring

        The user agent of the browser from which the director attestation was made.

    • identity.attestations.ownership_declarationobject

      This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.

      Hide child parameters

      • identity.attestations.ownership_declaration.datetimestamp

        The time marking when the beneficial owner attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

      • identity.attestations.ownership_declaration.ipstring

        The IP address from which the beneficial owner attestation was made.

      • identity.attestations.ownership_declaration.user_agentstring

        The user agent of the browser from which the beneficial owner attestation was made.

    • identity.attestations.persons_providedobject

      Attestation that all Persons with a specific Relationship value have been provided.

      Hide child parameters

      • identity.attestations.persons_provided.directorsboolean

        Whether the company’s directors have been provided. Set this Boolean to true after creating all the company’s directors with the Persons API.

      • identity.attestations.persons_provided.executivesboolean

        Whether the company’s executives have been provided. Set this Boolean to true after creating all the company’s executives with the Persons API.

      • identity.attestations.persons_provided.ownersboolean

        Whether the company’s owners have been provided. Set this Boolean to true after creating all the company’s owners with the Persons API.

      • identity.attestations.persons_provided.ownership_exemption_reasonenum

        Reason for why the company is exempt from providing ownership information.

        Possible enum values

        qualified_entity_exceeds_ownership_threshold A qualifying entity or group of qualifying entities own a significant enough share of the merchant’s business that they are exempt from providing ownership information based on regulatory guidelines in the merchant’s country.

        qualifies_as_financial_institution A merchant is a financial institution.

    • identity.attestations.terms_of_serviceobject

      Attestations of accepted terms of service agreements.

      Hide child parameters

      • identity.attestations.terms_of_service.accountobject

        Details on the Account’s acceptance of the Stripe Services Agreement.

        Hide child parameters

        • identity.attestations.terms_of_service.account.datetimestamp

          The time when the Account’s representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

        • identity.attestations.terms_of_service.account.ipstring

          The IP address from which the Account’s representative accepted the terms of service.

        • identity.attestations.terms_of_service.account.user_agentstring

          The user agent of the browser from which the Account’s representative accepted the terms of service.

      • identity.attestations.terms_of_service.storerobject

        Details on the Account’s acceptance of Treasury-specific terms of service.

        Hide child parameters

        • identity.attestations.terms_of_service.storer.datetimestamp

          The time when the Account’s representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

        • identity.attestations.terms_of_service.storer.ipstring

          The IP address from which the Account’s representative accepted the terms of service.

        • identity.attestations.terms_of_service.storer.user_agentstring

          The user agent of the browser from which the Account’s representative accepted the terms of service.

  • identity.business_detailsobject

    Information about the company or business.

    Hide child parameters

    • identity.business_details.addressobject

      The business registration address of the business entity.

      Hide child parameters

      • identity.business_details.address.citystring

        City, district, suburb, town, or village.

      • identity.business_details.address.countryenum

        Two-letter country code (ISO 3166-1 alpha-2).

      • identity.business_details.address.line1string

        Address line 1 (e.g., street, PO Box, or company name).

      • identity.business_details.address.line2string

        Address line 2 (e.g., apartment, suite, unit, or building).

      • identity.business_details.address.postal_codestring

        ZIP or postal code.

      • identity.business_details.address.statestring

        State, county, province, or region.

      • identity.business_details.address.townstring

        Town or cho-me.

    • identity.business_details.annual_revenueobject

      The business gross annual revenue for its preceding fiscal year.

      Hide child parameters

      • identity.business_details.annual_revenue.amountobject

        A non-negative integer representing the amount in the smallest currency unit.

        Hide child parameters

        • identity.business_details.annual_revenue.amount.currencystringRequired

          A lowercase alpha3 currency code like “usd”.

        • identity.business_details.annual_revenue.amount.valueintegerRequired

          In minor units like 123 for 1.23 USD.

      • identity.business_details.annual_revenue.fiscal_year_endstring

        The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.

    • identity.business_details.documentsobject

      A document verifying the business.

      Hide child parameters

      • identity.business_details.documents.bank_account_ownership_verificationobject

        One or more documents that support the bank account ownership verification requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.

        Hide child parameters

        • identity.business_details.documents.bank_account_ownership_verification.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.business_details.documents.bank_account_ownership_verification.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.business_details.documents.company_licenseobject

        One or more documents that demonstrate proof of a company’s license to operate.

        Hide child parameters

        • identity.business_details.documents.company_license.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.business_details.documents.company_license.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.business_details.documents.company_memorandum_of_associationobject

        One or more documents showing the company’s Memorandum of Association.

        Hide child parameters

        • identity.business_details.documents.company_memorandum_of_association.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.business_details.documents.company_memorandum_of_association.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.business_details.documents.company_ministerial_decreeobject

        Certain countries only: One or more documents showing the ministerial decree legalizing the company’s establishment.

        Hide child parameters

        • identity.business_details.documents.company_ministerial_decree.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.business_details.documents.company_ministerial_decree.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.business_details.documents.company_registration_verificationobject

        One or more documents that demonstrate proof of a company’s registration with the appropriate local authorities.

        Hide child parameters

        • identity.business_details.documents.company_registration_verification.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.business_details.documents.company_registration_verification.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.business_details.documents.company_tax_id_verificationobject

        One or more documents that demonstrate proof of a company’s tax ID.

        Hide child parameters

        • identity.business_details.documents.company_tax_id_verification.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.business_details.documents.company_tax_id_verification.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.business_details.documents.primary_verificationobject

        A document verifying the business.

        Hide child parameters

        • identity.business_details.documents.primary_verification.front_backobjectRequired

          The file upload tokens referring to each side of the document.

          Hide child parameters

          • identity.business_details.documents.primary_verification.front_back.backstring

            A file upload token representing the back of the verification document. The purpose of the uploaded file should be ‘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.

          • identity.business_details.documents.primary_verification.front_back.frontstring

            A file upload token representing the front of the verification document. The purpose of the uploaded file should be ‘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.

        • identity.business_details.documents.primary_verification.typeenumRequired

          The format of the verification document. Currently supports front_back only.

          Possible enum values

          front_back Document type with both front and back sides.

      • identity.business_details.documents.proof_of_addressobject

        One or more documents that demonstrate proof of address.

        Hide child parameters

        • identity.business_details.documents.proof_of_address.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.business_details.documents.proof_of_address.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.business_details.documents.proof_of_registrationobject

        One or more documents showing the company’s proof of registration with the national business registry.

        Hide child parameters

        • identity.business_details.documents.proof_of_registration.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.business_details.documents.proof_of_registration.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.business_details.documents.proof_of_ultimate_beneficial_ownershipobject

        One or more documents that demonstrate proof of ultimate beneficial ownership.

        Hide child parameters

        • identity.business_details.documents.proof_of_ultimate_beneficial_ownership.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.business_details.documents.proof_of_ultimate_beneficial_ownership.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

    • identity.business_details.doing_business_asstring

      The name which is used by the business.

    • identity.business_details.estimated_worker_countinteger

      An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.

    • identity.business_details.id_numbersarray of objects

      The ID numbers of a business entity.

      Hide child parameters

      • identity.business_details.id_numbers.registrarstring

        The registrar of the ID number (Only valid for DE ID number types).

      • identity.business_details.id_numbers.typeenumRequired

        The ID number type of a business entity.

        Possible enum values

        ae_crn Company registration number - United Arab Emirates.

        ae_vat Business VAT ID - United Arab Emirates.

        ao_nif Número de Identificação Fiscal (NIF) - Angola.

        at_fn Firmenbuchnummer - Austria.

        au_abn Australian Business Number - Australia.

        au_acn Australian Company Number - Australia.

        au_in Incorporation Number - Australia.

        az_tin Tax Identification Number - Azerbaijan.

        bd_etin Electronic Tax Identification Number (ETIN) - Bangladesh.

        be_cbe Enterprise number - Belgium.

        Show 62 more

      • identity.business_details.id_numbers.valuestringRequired

        The value of the ID number.

    • identity.business_details.monthly_estimated_revenueobject

      An estimate of the monthly revenue of the business.

      Hide child parameters

      • identity.business_details.monthly_estimated_revenue.amountobject

        A non-negative integer representing the amount in the smallest currency unit.

        Hide child parameters

        • identity.business_details.monthly_estimated_revenue.amount.currencystringRequired

          A lowercase alpha3 currency code like “usd”.

        • identity.business_details.monthly_estimated_revenue.amount.valueintegerRequired

          In minor units like 123 for 1.23 USD.

    • identity.business_details.phonestring

      The phone number of the Business Entity.

    • identity.business_details.product_descriptionstring

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

    • identity.business_details.registered_namestring

      The business legal name.

    • identity.business_details.script_addressesobject

      The business registration address of the business entity in non latin script.

      Hide child parameters

      • identity.business_details.script_addresses.kanaobject

        Kana Address.

        Hide child parameters

        • identity.business_details.script_addresses.kana.citystring

          City, district, suburb, town, or village.

        • identity.business_details.script_addresses.kana.countryenum

          Two-letter country code (ISO 3166-1 alpha-2).

        • identity.business_details.script_addresses.kana.line1string

          Address line 1 (e.g., street, PO Box, or company name).

        • identity.business_details.script_addresses.kana.line2string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • identity.business_details.script_addresses.kana.postal_codestring

          ZIP or postal code.

        • identity.business_details.script_addresses.kana.statestring

          State, county, province, or region.

        • identity.business_details.script_addresses.kana.townstring

          Town or cho-me.

      • identity.business_details.script_addresses.kanjiobject

        Kanji Address.

        Hide child parameters

        • identity.business_details.script_addresses.kanji.citystring

          City, district, suburb, town, or village.

        • identity.business_details.script_addresses.kanji.countryenum

          Two-letter country code (ISO 3166-1 alpha-2).

        • identity.business_details.script_addresses.kanji.line1string

          Address line 1 (e.g., street, PO Box, or company name).

        • identity.business_details.script_addresses.kanji.line2string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • identity.business_details.script_addresses.kanji.postal_codestring

          ZIP or postal code.

        • identity.business_details.script_addresses.kanji.statestring

          State, county, province, or region.

        • identity.business_details.script_addresses.kanji.townstring

          Town or cho-me.

    • identity.business_details.script_namesobject

      The business legal name in non latin script.

      Hide child parameters

      • identity.business_details.script_names.kanaobject

        Kana name.

        Hide child parameters

        • identity.business_details.script_names.kana.registered_namestring

          Registered name of the business.

      • identity.business_details.script_names.kanjiobject

        Kanji name.

        Hide child parameters

        • identity.business_details.script_names.kanji.registered_namestring

          Registered name of the business.

    • identity.business_details.structureenum

      The category identifying the legal structure of the business.

      Possible enum values

      cooperative A cooperative organization.

      free_zone_establishment A free zone establishment.

      free_zone_llc A free zone LLC.

      government_instrumentality An organization formed by a government statute or body based in the US to perform a certain function, but not the actual government body itself.

      governmental_unit A branch of the state, local, or federal government of the US.

      incorporated_association An incorporated association.

      incorporated_non_profit An organization incorporated under the laws of a US state that has obtained tax-exempt status as a non-profit entity under either state or federal law (for example, 501©(3)).

      incorporated_partnership Also called ‘Limited Partnerships’ or ‘Registered Ordinary Partnerships’, these are businesses registered in Thailand owned by two or more people. The business’ legal entity and its legal personality is separated and distinct from the individual partners.

      limited_liability_partnership A limited liability partnership.

      llc An LLC.

      Show 17 more

    • identity.business_details.urlstring

      The business’s publicly available website.

  • identity.countryenum

    The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code.

  • identity.entity_typeenum

    The entity type.

    Possible enum values

    company A registered business.

    government_entity Government entity.

    individual An individual that is not registered as a business.

    non_profit A Non profit organization.

  • identity.individualobject

    Information about the individual represented by the Account. This property is null unless entity_type is set to individual.

    Hide child parameters

    • identity.individual.additional_addressesarray of objects

      Additional addresses associated with the individual.

      Hide child parameters

      • identity.individual.additional_addresses.citystring

        City, district, suburb, town, or village.

      • identity.individual.additional_addresses.countryenum

        Two-letter country code (ISO 3166-1 alpha-2).

      • identity.individual.additional_addresses.line1string

        Address line 1 (e.g., street, PO Box, or company name).

      • identity.individual.additional_addresses.line2string

        Address line 2 (e.g., apartment, suite, unit, or building).

      • identity.individual.additional_addresses.postal_codestring

        ZIP or postal code.

      • identity.individual.additional_addresses.purposeenumRequired

        Purpose of additional address.

        Possible enum values

        registered Registered.

      • identity.individual.additional_addresses.statestring

        State, county, province, or region.

      • identity.individual.additional_addresses.townstring

        Town or cho-me.

    • identity.individual.additional_namesarray of objects

      Additional names (e.g. aliases) associated with the individual.

      Hide child parameters

      • identity.individual.additional_names.full_namestring

        The person’s full name.

      • identity.individual.additional_names.given_namestring

        The person’s first or given name.

      • identity.individual.additional_names.purposeenumRequired

        The purpose or type of the additional name.

        Possible enum values

        alias An alias for the individual’s name.

        maiden The maiden name of the individual.

      • identity.individual.additional_names.surnamestring

        The person’s last or family name.

    • identity.individual.addressobject

      The individual’s residential address.

      Hide child parameters

      • identity.individual.address.citystring

        City, district, suburb, town, or village.

      • identity.individual.address.countryenum

        Two-letter country code (ISO 3166-1 alpha-2).

      • identity.individual.address.line1string

        Address line 1 (e.g., street, PO Box, or company name).

      • identity.individual.address.line2string

        Address line 2 (e.g., apartment, suite, unit, or building).

      • identity.individual.address.postal_codestring

        ZIP or postal code.

      • identity.individual.address.statestring

        State, county, province, or region.

      • identity.individual.address.townstring

        Town or cho-me.

    • identity.individual.date_of_birthobject

      The individual’s date of birth.

      Hide child parameters

      • identity.individual.date_of_birth.dayintegerRequired

        The day of the birth.

      • identity.individual.date_of_birth.monthintegerRequired

        The month of birth.

      • identity.individual.date_of_birth.yearintegerRequired

        The year of birth.

    • identity.individual.documentsobject

      Documents that may be submitted to satisfy various informational requests.

      Hide child parameters

      • identity.individual.documents.company_authorizationobject

        One or more documents that demonstrate proof that this person is authorized to represent the company.

        Hide child parameters

        • identity.individual.documents.company_authorization.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.individual.documents.company_authorization.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.individual.documents.passportobject

        One or more documents showing the person’s passport page with photo and personal data.

        Hide child parameters

        • identity.individual.documents.passport.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.individual.documents.passport.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

      • identity.individual.documents.primary_verificationobject

        An identifying document showing the person’s name, either a passport or local ID card.

        Hide child parameters

        • identity.individual.documents.primary_verification.front_backobjectRequired

          The file upload tokens referring to each side of the document.

          Hide child parameters

          • identity.individual.documents.primary_verification.front_back.backstring

            A file upload token representing the back of the verification document. The purpose of the uploaded file should be ‘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.

          • identity.individual.documents.primary_verification.front_back.frontstring

            A file upload token representing the front of the verification document. The purpose of the uploaded file should be ‘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.

        • identity.individual.documents.primary_verification.typeenumRequired

          The format of the verification document. Currently supports front_back only.

          Possible enum values

          front_back Document type with both front and back sides.

      • identity.individual.documents.secondary_verificationobject

        A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

        Hide child parameters

        • identity.individual.documents.secondary_verification.front_backobjectRequired

          The file upload tokens referring to each side of the document.

          Hide child parameters

          • identity.individual.documents.secondary_verification.front_back.backstring

            A file upload token representing the back of the verification document. The purpose of the uploaded file should be ‘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.

          • identity.individual.documents.secondary_verification.front_back.frontstring

            A file upload token representing the front of the verification document. The purpose of the uploaded file should be ‘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.

        • identity.individual.documents.secondary_verification.typeenumRequired

          The format of the verification document. Currently supports front_back only.

          Possible enum values

          front_back Document type with both front and back sides.

      • identity.individual.documents.visaobject

        One or more documents showing the person’s visa required for living in the country where they are residing.

        Hide child parameters

        • identity.individual.documents.visa.filesarray of stringsRequired

          One or more document IDs returned by a file upload with a purpose value of account_requirement.

        • identity.individual.documents.visa.typeenumRequired

          The format of the document. Currently supports files only.

          Possible enum values

          files Document type with multiple files.

    • identity.individual.emailstring

      The individual’s email address.

    • identity.individual.given_namestring

      The individual’s first name.

    • identity.individual.id_numbersarray of objects

      The identification numbers (e.g., SSN) associated with the individual.

      Hide child parameters

      • identity.individual.id_numbers.typeenumRequired

        The ID number type of an individual.

        Possible enum values

        ae_eid Emirates ID - United Arab Emirates.

        ao_nif Número de Identificação Fiscal (Tax Identification Number) - Angola.

        az_tin Tax Identification Number - Azerbaijan.

        bd_brc Birth Registration Certificate (BRC) - Bangladesh.

        bd_etin Electronic Tax Identification Number (ETIN) - Bangladesh.

        bd_nid National Identification Number (NID) - Bangladesh.

        br_cpf Cadastro de Pessoas Físicas - Brazil.

        cr_cpf Cédula de Persona Fisica (CPF) - Costa Rica.

        cr_dimex Documento de identificación Tributario Especial (DIMEX) - Costa Rica.

        cr_nite Número de Indetificación Tributario Especial (NITE) - Costa Rica.

        Show 21 more

      • identity.individual.id_numbers.valuestringRequired

        The value of the ID number.

    • identity.individual.legal_genderenum

      The individual’s gender (International regulations require either “male” or “female”).

      Possible enum values

      female Female person gender.

      male Male person gender.

    • identity.individual.metadatamap

      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.

    • identity.individual.nationalitiesarray of enums

      The countries where the individual is a national. Two-letter country code (ISO 3166-1 alpha-2).

    • identity.individual.phonestring

      The individual’s phone number.

    • identity.individual.political_exposureenum

      The individual’s political exposure.

      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.

    • identity.individual.relationshipobject

      The relationship that this individual has with the account’s identity.

      Hide child parameters

      • identity.individual.relationship.directorboolean

        Whether the person is a director of the account’s identity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.

      • identity.individual.relationship.executiveboolean

        Whether the person has significant responsibility to control, manage, or direct the organization.

      • identity.individual.relationship.ownerboolean

        Whether the person is an owner of the account’s identity.

      • identity.individual.relationship.percent_ownershipdecimal

        The percent owned by the person of the account’s legal entity.

      • identity.individual.relationship.titlestring

        The person’s title (e.g., CEO, Support Engineer).

    • identity.individual.script_addressesobject

      The script addresses (e.g., non-Latin characters) associated with the individual.

      Hide child parameters

      • identity.individual.script_addresses.kanaobject

        Kana Address.

        Hide child parameters

        • identity.individual.script_addresses.kana.citystring

          City, district, suburb, town, or village.

        • identity.individual.script_addresses.kana.countryenum

          Two-letter country code (ISO 3166-1 alpha-2).

        • identity.individual.script_addresses.kana.line1string

          Address line 1 (e.g., street, PO Box, or company name).

        • identity.individual.script_addresses.kana.line2string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • identity.individual.script_addresses.kana.postal_codestring

          ZIP or postal code.

        • identity.individual.script_addresses.kana.statestring

          State, county, province, or region.

        • identity.individual.script_addresses.kana.townstring

          Town or cho-me.

      • identity.individual.script_addresses.kanjiobject

        Kanji Address.

        Hide child parameters

        • identity.individual.script_addresses.kanji.citystring

          City, district, suburb, town, or village.

        • identity.individual.script_addresses.kanji.countryenum

          Two-letter country code (ISO 3166-1 alpha-2).

        • identity.individual.script_addresses.kanji.line1string

          Address line 1 (e.g., street, PO Box, or company name).

        • identity.individual.script_addresses.kanji.line2string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • identity.individual.script_addresses.kanji.postal_codestring

          ZIP or postal code.

        • identity.individual.script_addresses.kanji.statestring

          State, county, province, or region.

        • identity.individual.script_addresses.kanji.townstring

          Town or cho-me.

    • identity.individual.script_namesobject

      The individuals primary name in non latin script.

      Hide child parameters

      • identity.individual.script_names.kanaobject

        Persons name in kana script.

        Hide child parameters

        • identity.individual.script_names.kana.given_namestring

          The person’s first or given name.

        • identity.individual.script_names.kana.surnamestring

          The person’s last or family name.

      • identity.individual.script_names.kanjiobject

        Persons name in kanji script.

        Hide child parameters

        • identity.individual.script_names.kanji.given_namestring

          The person’s first or given name.

        • identity.individual.script_names.kanji.surnamestring

          The person’s last or family name.

    • identity.individual.surnamestring

      The individual’s last name.

• includearray of enums

  Additional fields to include in the response.

  Possible enum values

  configuration.customer Include parameter to expose configuration.customer on an Account.

  configuration.merchant Include parameter to expose configuration.merchant on an Account.

  configuration.recipient Include parameter to expose configuration.recipient on an Account.

  configuration.storer Include parameter to expose configuration.storer on an Account.

  defaults Include parameter to expose defaults on an Account.

  identity Include parameter to expose identity on an Account.

  requirements Include parameter to expose requirements on an Account.

• metadatamap

  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.