API reference

Accounts

For new integrations, we recommend using the Accounts v2 API, in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where controller.requirement_collection is application, which includes Custom accounts, the properties below are always returned. For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.

Knox answers these operations with the same requests and responses as Stripe's API. Authenticate with your secret key, Authorization: Bearer sk_test_..., from your server, and send form-encoded bodies. Test mode only: live processing is currently disabled.

Create an account

POST/v1/accounts

With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform. If you’ve already collected information for your connected accounts, you can prefill that information when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.

Body parameters

  • account_tokenstring

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

  • bank_accountobject | string

    Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.

    Show 9 child parameters
    • account_numberstringRequired
    • countrystringRequired
    • account_holder_namestring
    • account_holder_typestring
      Possible values
      • company
      • individual
    • account_typestring
      Possible values
      • checking
      • futsu
      • savings
      • toza
    • currencystring
    • documentsobject
      Show 1 child parameter
      • bank_account_ownership_verificationobject

        Child parameters are listed in the OpenAPI document.

    • objectstring
      Possible values
      • bank_account
    • routing_numberstring
  • business_profileobject

    Business information about the account.

    Show 12 child parameters
    • annual_revenueobject
      Show 3 child parameters
      • amountintegerRequired
      • currencystringRequired
      • fiscal_year_endstringRequired
    • estimated_worker_countinteger
    • mccstring
    • minority_owned_business_designationarray of strings
    • monthly_estimated_revenueobject
      Show 2 child parameters
      • amountintegerRequired
      • currencystringRequired
    • namestring
    • product_descriptionstring
    • support_addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • support_emailstring
    • support_phonestring
    • support_urlstring
    • urlstring
  • business_typestring

    The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

    Possible values
    • company
    • government_entity
    • individual
    • non_profit
  • capabilitiesobject

    Each key of the dictionary represents a capability, and each capability maps to its settings (for example, whether it has been requested or not). Each capability is inactive until you have provided its specific requirements and Stripe has verified them. An account might have some of its requested capabilities be active and some be inactive. Required when account.controller.stripe_dashboard.type is none, which includes Custom accounts.

    Show 66 child parameters
    • acss_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • affirm_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • afterpay_clearpay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • alma_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • amazon_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • app_distributionobject
      Show 1 child parameter
      • requestedboolean
    • au_becs_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • bacs_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • bancontact_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • billie_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • bizum_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • blik_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • boleto_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • card_issuingobject
      Show 1 child parameter
      • requestedboolean
    • card_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • cartes_bancaires_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • cashapp_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • crypto_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • eps_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • fpx_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • gb_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • giropay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • grabpay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • ideal_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • india_international_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • jcb_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • jp_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • kakao_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • klarna_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • konbini_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • kr_card_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • legacy_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • link_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • mb_way_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • mobilepay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • multibanco_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • mx_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • naver_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • nz_bank_account_becs_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • oxxo_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • p24_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • pay_by_bank_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • payco_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • paynow_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • payto_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • pix_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • promptpay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • revolut_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • samsung_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • satispay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • scalapay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • sepa_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • sepa_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • sofort_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • sunbit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • swish_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • tax_reporting_us_1099_kobject
      Show 1 child parameter
      • requestedboolean
    • tax_reporting_us_1099_miscobject
      Show 1 child parameter
      • requestedboolean
    • transfersobject
      Show 1 child parameter
      • requestedboolean
    • treasuryobject
      Show 1 child parameter
      • requestedboolean
    • twint_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • upi_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • us_bank_account_ach_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • us_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • zip_paymentsobject
      Show 1 child parameter
      • requestedboolean
  • companyobject

    Information about the company or business. This field is available for any business_type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

    Show 25 child parameters
    • addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • address_kanaobject
      Show 7 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
      • townstring
    • address_kanjiobject
      Show 7 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
      • townstring
    • administrative_addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • directors_providedboolean
    • directorship_declarationobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
    • executives_providedboolean
    • export_license_idstring
    • export_purpose_codestring
    • namestring
    • name_kanastring
    • name_kanjistring
    • owners_providedboolean
    • ownership_declarationobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
    • ownership_exemption_reasonstring
      Possible values
      • qualified_entity_exceeds_ownership_threshold
      • qualifies_as_financial_institution
    • phonestring
    • principal_place_of_businessobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • registration_dateobject
      Show 3 child parameters
      • dayintegerRequired
      • monthintegerRequired
      • yearintegerRequired
    • registration_numberstring
    • representative_declarationobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
    • structurestring
      Possible values
      • free_zone_establishment
      • free_zone_llc
      • government_instrumentality
      • governmental_unit
      • incorporated_non_profit
      • incorporated_partnership
      • limited_liability_partnership
      • llc
      • multi_member_llc
      • private_company
      • private_corporation
      • private_partnership
      • public_company
      • public_corporation
      • public_partnership
      • registered_charity
      • and 7 more
    • tax_idstring
    • tax_id_registrarstring
    • vat_idstring
    • verificationobject
      Show 1 child parameter
  • controllerobject

    A hash of configuration describing the account controller's attributes.

    Show 4 child parameters
    • feesobject
      Show 1 child parameter
      • payerstring
        Possible values
        • account
        • application
    • lossesobject
      Show 1 child parameter
      • paymentsstring
        Possible values
        • application
        • stripe
    • requirement_collectionstring
      Possible values
      • application
      • stripe
    • stripe_dashboardobject
      Show 1 child parameter
      • typestring
        Possible values
        • express
        • full
        • none
  • countrystring

    The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use CA as the country for the account being created. Available countries include Stripe's global markets as well as countries where cross-border payouts are supported.

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

  • documentsobject

    Documents that may be submitted to satisfy various informational requests.

    Show 8 child parameters
    • bank_account_ownership_verificationobject
      Show 1 child parameter
      • filesarray of strings
    • company_licenseobject
      Show 1 child parameter
      • filesarray of strings
    • company_memorandum_of_associationobject
      Show 1 child parameter
      • filesarray of strings
    • company_ministerial_decreeobject
      Show 1 child parameter
      • filesarray of strings
    • company_registration_verificationobject
      Show 1 child parameter
      • filesarray of strings
    • company_tax_id_verificationobject
      Show 1 child parameter
      • filesarray of strings
    • proof_of_addressobject
      Show 1 child parameter
      • filesarray of strings
    • proof_of_ultimate_beneficial_ownershipobject
      Show 2 child parameters
      • filesarray of strings
      • signerobject

        Child parameters are listed in the OpenAPI document.

  • emailstring

    The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is application, which includes Custom accounts, Stripe doesn't email the account without your consent.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • external_accountstring

    A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account parameter for bank account creation. By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

  • groupsobject

    A hash of account group type to tokens. These are account groups this account should be added to.

    Show 1 child parameter
    • payments_pricingstring
  • individualobject

    Information about the person represented by the account. This field is null unless business_type is set to individual. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

    Show 23 child parameters
    • addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • address_kanaobject
      Show 7 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
      • townstring
    • address_kanjiobject
      Show 7 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
      • townstring
    • dobobject
      Show 3 child parameters
      • dayintegerRequired
      • monthintegerRequired
      • yearintegerRequired
    • emailstring
    • first_namestring
    • first_name_kanastring
    • first_name_kanjistring
    • full_name_aliasesarray of strings
    • genderstring
    • id_numberstring
    • id_number_secondarystring
    • last_namestring
    • last_name_kanastring
    • last_name_kanjistring
    • maiden_namestring
    • metadataobject
    • phonestring
    • political_exposurestring
      Possible values
      • existing
      • none
    • registered_addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • relationshipobject
      Show 5 child parameters
      • directorboolean
      • executiveboolean
      • ownerboolean
      • percent_ownershipnumber
      • titlestring
    • ssn_last_4string
    • verificationobject
      Show 2 child parameters
  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • settingsobject

    Options for customizing how the account functions within Stripe.

    Show 8 child parameters
    • bacs_debit_paymentsobject
      Show 1 child parameter
      • display_namestring
    • brandingobject
      Show 4 child parameters
      • iconstring
      • logostring
      • primary_colorstring
      • secondary_colorstring
    • card_issuingobject
      Show 1 child parameter
    • card_paymentsobject
      Show 4 child parameters
      • decline_onobject

        Child parameters are listed in the OpenAPI document.

      • statement_descriptor_prefixstring
      • statement_descriptor_prefix_kanastring
      • statement_descriptor_prefix_kanjistring
    • invoicesobject
      Show 1 child parameter
      • hosted_payment_method_savestring
        Possible values
        • always
        • never
        • offer
    • paymentsobject
      Show 3 child parameters
      • statement_descriptorstring
      • statement_descriptor_kanastring
      • statement_descriptor_kanjistring
    • payoutsobject
      Show 3 child parameters
      • debit_negative_balancesboolean
      • scheduleobject

        Child parameters are listed in the OpenAPI document.

      • statement_descriptorstring
    • treasuryobject
      Show 1 child parameter
  • tos_acceptanceobject

    Details on the account's acceptance of the Stripe Services Agreement. This property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts. This property defaults to a full service agreement when empty.

    Show 4 child parameters
    • dateinteger
    • ipstring
    • service_agreementstring
    • user_agentstring
  • typestring

    The type parameter is deprecated. Use controller instead to configure dashboard access, fee payer, loss liability, and requirement collection.

    Possible values
    • custom
    • express
    • standard

Returns

The account object.

POST /v1/accounts
curl -X POST https://api.knoxapi.com/v1/accounts \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "business_profile": {
    "annual_revenue": {
      "amount": null,
      "currency": null,
      "fiscal_year_end": null
    },
    "estimated_worker_count": null,
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null,
    "minority_owned_business_designation": null
  },
  "business_type": null,
  "capabilities": {
    "card_payments": "active",
    "transfers": "active"
  },
  "charges_enabled": false,
  "controller": {
    "type": "account"
  },
  "country": "US",
  "created": 1234567890,
  "default_currency": "usd",
  "details_submitted": false,
  "email": "[email protected]",
  "external_accounts": {
    "data": [],
    "has_more": false,
    "object": "list",
    "url": "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "acct_1PgafTB7WZ01zgkW",
  "metadata": {},
  "object": "account",
  "payouts_enabled": false,
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "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": true,
        "cvc_failure": true
      },
      "statement_descriptor_prefix": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_kanji": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "invoices": {
      "default_account_tax_ids": null,
      "hosted_payment_method_save": null
    },
    "payments": {
      "statement_descriptor": null,
      "statement_descriptor_kana": null,
      "statement_descriptor_kanji": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_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": "standard"
}

List all connected accounts

GET/v1/accounts

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

Query parameters

  • createdobject | integer

    Only return connected accounts that were created during the given date interval.

    Show 4 child parameters
    • gtinteger
    • gteinteger
    • ltinteger
    • lteinteger
  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

A list of account objects.

GET /v1/accounts
curl -G https://api.knoxapi.com/v1/accounts \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  --data-urlencode limit=3
Response
{
  "object": "list",
  "url": "/v1/accounts",
  "has_more": false,
  "data": [
    {
      "business_profile": {
        "annual_revenue": {
          "amount": null,
          "currency": null,
          "fiscal_year_end": null
        },
        "estimated_worker_count": null,
        "mcc": null,
        "name": null,
        "product_description": null,
        "support_address": {
          "city": null,
          "country": null,
          "line1": null,
          "line2": null,
          "postal_code": null,
          "state": null
        },
        "support_email": null,
        "support_phone": null,
        "support_url": null,
        "url": null,
        "minority_owned_business_designation": null
      },
      "business_type": null,
      "capabilities": {
        "card_payments": "active",
        "transfers": "active"
      },
      "charges_enabled": false,
      "controller": {
        "type": "account"
      },
      "country": "US",
      "created": 1234567890,
      "default_currency": "usd",
      "details_submitted": false,
      "email": "[email protected]",
      "external_accounts": {
        "data": [],
        "has_more": false,
        "object": "list",
        "url": "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts"
      },
      "future_requirements": {
        "alternatives": [],
        "current_deadline": null,
        "currently_due": [],
        "disabled_reason": null,
        "errors": [],
        "eventually_due": [],
        "past_due": [],
        "pending_verification": []
      },
      "id": "acct_1PgafTB7WZ01zgkW",
      "metadata": {},
      "object": "account",
      "payouts_enabled": false,
      "requirements": {
        "alternatives": [],
        "current_deadline": null,
        "currently_due": [
          "business_profile.product_description",
          "business_profile.support_phone",
          "business_profile.url",
          "external_account",
          "tos_acceptance.date",
          "tos_acceptance.ip"
        ],
        "disabled_reason": "requirements.past_due",
        "errors": [],
        "eventually_due": [
          "business_profile.product_description",
          "business_profile.support_phone",
          "business_profile.url",
          "external_account",
          "tos_acceptance.date",
          "tos_acceptance.ip"
        ],
        "past_due": [],
        "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": true,
            "cvc_failure": true
          },
          "statement_descriptor_prefix": null,
          "statement_descriptor_prefix_kana": null,
          "statement_descriptor_prefix_kanji": null
        },
        "dashboard": {
          "display_name": null,
          "timezone": "Etc/UTC"
        },
        "invoices": {
          "default_account_tax_ids": null,
          "hosted_payment_method_save": null
        },
        "payments": {
          "statement_descriptor": null,
          "statement_descriptor_kana": null,
          "statement_descriptor_kanji": null,
          "statement_descriptor_prefix_kana": null,
          "statement_descriptor_prefix_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": "standard"
    }
  ]
}

Update an account

POST/v1/accounts/{account}

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. For accounts where controller.requirement_collection is application, which includes Custom accounts, you can update any information on the account. For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, you can update all information until you create an Account Link or Account Session to start Connect onboarding, after which some properties can no longer be updated. To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

Path parameters

  • accountstringRequired

Body parameters

  • account_tokenstring

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

  • business_profileobject

    Business information about the account.

    Show 12 child parameters
    • annual_revenueobject
      Show 3 child parameters
      • amountintegerRequired
      • currencystringRequired
      • fiscal_year_endstringRequired
    • estimated_worker_countinteger
    • mccstring
    • minority_owned_business_designationarray of strings
    • monthly_estimated_revenueobject
      Show 2 child parameters
      • amountintegerRequired
      • currencystringRequired
    • namestring
    • product_descriptionstring
    • support_addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • support_emailstring
    • support_phonestring
    • support_urlstring
    • urlstring
  • business_typestring

    The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

    Possible values
    • company
    • government_entity
    • individual
    • non_profit
  • capabilitiesobject

    Each key of the dictionary represents a capability, and each capability maps to its settings (for example, whether it has been requested or not). Each capability is inactive until you have provided its specific requirements and Stripe has verified them. An account might have some of its requested capabilities be active and some be inactive. Required when account.controller.stripe_dashboard.type is none, which includes Custom accounts.

    Show 66 child parameters
    • acss_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • affirm_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • afterpay_clearpay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • alma_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • amazon_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • app_distributionobject
      Show 1 child parameter
      • requestedboolean
    • au_becs_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • bacs_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • bancontact_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • billie_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • bizum_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • blik_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • boleto_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • card_issuingobject
      Show 1 child parameter
      • requestedboolean
    • card_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • cartes_bancaires_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • cashapp_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • crypto_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • eps_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • fpx_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • gb_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • giropay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • grabpay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • ideal_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • india_international_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • jcb_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • jp_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • kakao_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • klarna_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • konbini_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • kr_card_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • legacy_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • link_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • mb_way_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • mobilepay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • multibanco_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • mx_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • naver_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • nz_bank_account_becs_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • oxxo_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • p24_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • pay_by_bank_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • payco_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • paynow_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • payto_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • pix_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • promptpay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • revolut_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • samsung_pay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • satispay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • scalapay_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • sepa_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • sepa_debit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • sofort_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • sunbit_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • swish_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • tax_reporting_us_1099_kobject
      Show 1 child parameter
      • requestedboolean
    • tax_reporting_us_1099_miscobject
      Show 1 child parameter
      • requestedboolean
    • transfersobject
      Show 1 child parameter
      • requestedboolean
    • treasuryobject
      Show 1 child parameter
      • requestedboolean
    • twint_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • upi_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • us_bank_account_ach_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • us_bank_transfer_paymentsobject
      Show 1 child parameter
      • requestedboolean
    • zip_paymentsobject
      Show 1 child parameter
      • requestedboolean
  • companyobject

    Information about the company or business. This field is available for any business_type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

    Show 25 child parameters
    • addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • address_kanaobject
      Show 7 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
      • townstring
    • address_kanjiobject
      Show 7 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
      • townstring
    • administrative_addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • directors_providedboolean
    • directorship_declarationobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
    • executives_providedboolean
    • export_license_idstring
    • export_purpose_codestring
    • namestring
    • name_kanastring
    • name_kanjistring
    • owners_providedboolean
    • ownership_declarationobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
    • ownership_exemption_reasonstring
      Possible values
      • qualified_entity_exceeds_ownership_threshold
      • qualifies_as_financial_institution
    • phonestring
    • principal_place_of_businessobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • registration_dateobject
      Show 3 child parameters
      • dayintegerRequired
      • monthintegerRequired
      • yearintegerRequired
    • registration_numberstring
    • representative_declarationobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
    • structurestring
      Possible values
      • free_zone_establishment
      • free_zone_llc
      • government_instrumentality
      • governmental_unit
      • incorporated_non_profit
      • incorporated_partnership
      • limited_liability_partnership
      • llc
      • multi_member_llc
      • private_company
      • private_corporation
      • private_partnership
      • public_company
      • public_corporation
      • public_partnership
      • registered_charity
      • and 7 more
    • tax_idstring
    • tax_id_registrarstring
    • vat_idstring
    • verificationobject
      Show 1 child parameter
  • 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.

  • documentsobject

    Documents that may be submitted to satisfy various informational requests.

    Show 9 child parameters
    • bank_account_ownership_verificationobject
      Show 1 child parameter
      • filesarray of strings
    • company_licenseobject
      Show 1 child parameter
      • filesarray of strings
    • company_memorandum_of_associationobject
      Show 1 child parameter
      • filesarray of strings
    • company_ministerial_decreeobject
      Show 1 child parameter
      • filesarray of strings
    • company_registration_verificationobject
      Show 1 child parameter
      • filesarray of strings
    • company_tax_id_verificationobject
      Show 1 child parameter
      • filesarray of strings
    • proof_of_addressobject
      Show 1 child parameter
      • filesarray of strings
    • proof_of_registrationobject
      Show 2 child parameters
      • filesarray of strings
      • signerobject

        Child parameters are listed in the OpenAPI document.

    • proof_of_ultimate_beneficial_ownershipobject
      Show 2 child parameters
      • filesarray of strings
      • signerobject

        Child parameters are listed in the OpenAPI document.

  • emailstring

    The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is application, which includes Custom accounts, Stripe doesn't email the account without your consent.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • external_accountstring

    A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account parameter for bank account creation. By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

  • groupsobject

    A hash of account group type to tokens. These are account groups this account should be added to.

    Show 1 child parameter
    • payments_pricingstring
  • individualobject

    Information about the person represented by the account. This field is null unless business_type is set to individual. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

    Show 23 child parameters
    • addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • address_kanaobject
      Show 7 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
      • townstring
    • address_kanjiobject
      Show 7 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
      • townstring
    • dobobject
      Show 3 child parameters
      • dayintegerRequired
      • monthintegerRequired
      • yearintegerRequired
    • emailstring
    • first_namestring
    • first_name_kanastring
    • first_name_kanjistring
    • full_name_aliasesarray of strings
    • genderstring
    • id_numberstring
    • id_number_secondarystring
    • last_namestring
    • last_name_kanastring
    • last_name_kanjistring
    • maiden_namestring
    • metadataobject
    • phonestring
    • political_exposurestring
      Possible values
      • existing
      • none
    • registered_addressobject
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • relationshipobject
      Show 5 child parameters
      • directorboolean
      • executiveboolean
      • ownerboolean
      • percent_ownershipnumber
      • titlestring
    • ssn_last_4string
    • verificationobject
      Show 2 child parameters
  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • settingsobject

    Options for customizing how the account functions within Stripe.

    Show 9 child parameters
    • bacs_debit_paymentsobject
      Show 1 child parameter
      • display_namestring
    • brandingobject
      Show 4 child parameters
      • iconstring
      • logostring
      • primary_colorstring
      • secondary_colorstring
    • card_issuingobject
      Show 1 child parameter
    • card_paymentsobject
      Show 4 child parameters
      • decline_onobject

        Child parameters are listed in the OpenAPI document.

      • statement_descriptor_prefixstring
      • statement_descriptor_prefix_kanastring
      • statement_descriptor_prefix_kanjistring
    • invoicesobject
      Show 2 child parameters
      • default_account_tax_idsarray of strings
      • hosted_payment_method_savestring
        Possible values
        • always
        • never
        • offer
    • paymentsobject
      Show 3 child parameters
      • statement_descriptorstring
      • statement_descriptor_kanastring
      • statement_descriptor_kanjistring
    • payoutsobject
      Show 3 child parameters
      • debit_negative_balancesboolean
      • scheduleobject

        Child parameters are listed in the OpenAPI document.

      • statement_descriptorstring
    • sepa_debit_paymentsobject
      Show 1 child parameter
      • creditor_idstring
    • treasuryobject
      Show 1 child parameter
  • tos_acceptanceobject

    Details on the account's acceptance of the Stripe Services Agreement. This property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts. This property defaults to a full service agreement when empty.

    Show 4 child parameters
    • dateinteger
    • ipstring
    • service_agreementstring
    • user_agentstring

Returns

The account object.

POST /v1/accounts/{account}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  -d "metadata[order_id]=6735"
Response
{
  "business_profile": {
    "annual_revenue": {
      "amount": null,
      "currency": null,
      "fiscal_year_end": null
    },
    "estimated_worker_count": null,
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null,
    "minority_owned_business_designation": null
  },
  "business_type": null,
  "capabilities": {
    "card_payments": "active",
    "transfers": "active"
  },
  "charges_enabled": false,
  "controller": {
    "type": "account"
  },
  "country": "US",
  "created": 1234567890,
  "default_currency": "usd",
  "details_submitted": false,
  "email": "[email protected]",
  "external_accounts": {
    "data": [],
    "has_more": false,
    "object": "list",
    "url": "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "acct_1PgafTB7WZ01zgkW",
  "metadata": {},
  "object": "account",
  "payouts_enabled": false,
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "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": true,
        "cvc_failure": true
      },
      "statement_descriptor_prefix": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_kanji": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "invoices": {
      "default_account_tax_ids": null,
      "hosted_payment_method_save": null
    },
    "payments": {
      "statement_descriptor": null,
      "statement_descriptor_kana": null,
      "statement_descriptor_kanji": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_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": "standard"
}

Retrieve account

GET/v1/accounts/{account}

Retrieves the details of an account.

Path parameters

  • accountstringRequired

Query parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The account object.

GET /v1/accounts/{account}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "business_profile": {
    "annual_revenue": {
      "amount": null,
      "currency": null,
      "fiscal_year_end": null
    },
    "estimated_worker_count": null,
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null,
    "minority_owned_business_designation": null
  },
  "business_type": null,
  "capabilities": {
    "card_payments": "active",
    "transfers": "active"
  },
  "charges_enabled": false,
  "controller": {
    "type": "account"
  },
  "country": "US",
  "created": 1234567890,
  "default_currency": "usd",
  "details_submitted": false,
  "email": "[email protected]",
  "external_accounts": {
    "data": [],
    "has_more": false,
    "object": "list",
    "url": "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "acct_1PgafTB7WZ01zgkW",
  "metadata": {},
  "object": "account",
  "payouts_enabled": false,
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "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": true,
        "cvc_failure": true
      },
      "statement_descriptor_prefix": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_kanji": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "invoices": {
      "default_account_tax_ids": null,
      "hosted_payment_method_save": null
    },
    "payments": {
      "statement_descriptor": null,
      "statement_descriptor_kana": null,
      "statement_descriptor_kanji": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_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": "standard"
}

Delete an account

DELETE/v1/accounts/{account}

With Connect, you can delete accounts you manage. Test-mode accounts can be deleted at any time. Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all balances are zero. If you want to delete your own account, use the account information tab in your account settings instead.

Path parameters

  • accountstringRequired

Returns

The deleted_account object.

DELETE /v1/accounts/{account}
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "deleted": true,
  "id": "acct_1PgafTB7WZ01zgkW",
  "object": "account"
}

Create an external account

POST/v1/accounts/{account}/bank_accounts

Create an external account for a given account.

Path parameters

  • accountstringRequired

Body parameters

  • bank_accountobject | string

    Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.

    Show 9 child parameters
    • account_numberstringRequired
    • countrystringRequired
    • account_holder_namestring
    • account_holder_typestring
      Possible values
      • company
      • individual
    • account_typestring
      Possible values
      • checking
      • futsu
      • savings
      • toza
    • currencystring
    • documentsobject
      Show 1 child parameter
      • bank_account_ownership_verificationobject

        Child parameters are listed in the OpenAPI document.

    • objectstring
      Possible values
      • bank_account
    • routing_numberstring
  • default_for_currencyboolean

    When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • external_accountstring

    A token, like the ones returned by Stripe.js or a dictionary containing a user's external account details (with the options shown below). Please refer to full documentation instead.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

The external_account object.

POST /v1/accounts/{account}/bank_accounts
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account_holder_name": "Jane Austen",
  "account_holder_type": "company",
  "account_type": null,
  "bank_name": "STRIPE TEST BANK",
  "country": "US",
  "currency": "usd",
  "customer": null,
  "fingerprint": "AuoSJ18zsVWV9SPc",
  "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
  "last4": "6789",
  "metadata": {},
  "object": "bank_account",
  "routing_number": "110000000",
  "status": "new"
}

List all account capabilities

GET/v1/accounts/{account}/capabilities

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

Path parameters

  • accountstringRequired

Query parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

A list of capability objects.

GET /v1/accounts/{account}/capabilities
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "object": "list",
  "url": "/v1/accounts",
  "has_more": false,
  "data": [
    {
      "account": "acct_1PgafTB7WZ01zgkW",
      "future_requirements": {
        "alternatives": [],
        "current_deadline": null,
        "currently_due": [],
        "disabled_reason": null,
        "errors": [],
        "eventually_due": [],
        "past_due": [],
        "pending_verification": []
      },
      "id": "card_payments",
      "object": "capability",
      "requested": true,
      "requested_at": 1234567890,
      "requirements": {
        "alternatives": [],
        "current_deadline": null,
        "currently_due": [],
        "disabled_reason": null,
        "errors": [],
        "eventually_due": [],
        "past_due": [],
        "pending_verification": []
      },
      "status": "inactive"
    }
  ]
}

Create an external account

POST/v1/accounts/{account}/external_accounts

Create an external account for a given account.

Path parameters

  • accountstringRequired

Body parameters

  • bank_accountobject | string

    Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.

    Show 9 child parameters
    • account_numberstringRequired
    • countrystringRequired
    • account_holder_namestring
    • account_holder_typestring
      Possible values
      • company
      • individual
    • account_typestring
      Possible values
      • checking
      • futsu
      • savings
      • toza
    • currencystring
    • documentsobject
      Show 1 child parameter
      • bank_account_ownership_verificationobject

        Child parameters are listed in the OpenAPI document.

    • objectstring
      Possible values
      • bank_account
    • routing_numberstring
  • default_for_currencyboolean

    When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • external_accountstring

    A token, like the ones returned by Stripe.js or a dictionary containing a user's external account details (with the options shown below). Please refer to full documentation instead.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

The external_account object.

POST /v1/accounts/{account}/external_accounts
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account_holder_name": "Jane Austen",
  "account_holder_type": "company",
  "account_type": null,
  "bank_name": "STRIPE TEST BANK",
  "country": "US",
  "currency": "usd",
  "customer": null,
  "fingerprint": "AuoSJ18zsVWV9SPc",
  "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
  "last4": "6789",
  "metadata": {},
  "object": "bank_account",
  "routing_number": "110000000",
  "status": "new"
}

List all external accounts

GET/v1/accounts/{account}/external_accounts

List external accounts for an account.

Path parameters

  • accountstringRequired

Query parameters

  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • objectstring

    Filter external accounts according to a particular object type.

    Possible values
    • bank_account
    • card
  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

A list of bank_account objects.

GET /v1/accounts/{account}/external_accounts
curl -G https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  --data-urlencode limit=3
Response
{
  "object": "list",
  "url": "/v1/accounts",
  "has_more": false,
  "data": [
    {
      "account_holder_name": "Jane Austen",
      "account_holder_type": "company",
      "account_type": null,
      "bank_name": "STRIPE TEST BANK",
      "country": "US",
      "currency": "usd",
      "customer": null,
      "fingerprint": "AuoSJ18zsVWV9SPc",
      "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
      "last4": "6789",
      "metadata": {},
      "object": "bank_account",
      "routing_number": "110000000",
      "status": "new"
    }
  ]
}

Create a person

POST/v1/accounts/{account}/people

Creates a new person.

Path parameters

  • accountstringRequired

Body parameters

  • additional_tos_acceptancesobject

    Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.

    Show 1 child parameter
    • accountobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
  • addressobject

    The person's address.

    Show 6 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
  • address_kanaobject

    The Kana variation of the person's address (Japan only).

    Show 7 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
    • townstring
  • address_kanjiobject

    The Kanji variation of the person's address (Japan only).

    Show 7 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
    • townstring
  • dobobject

    The person's date of birth.

    Show 3 child parameters
    • dayintegerRequired
    • monthintegerRequired
    • yearintegerRequired
  • documentsobject

    Documents that may be submitted to satisfy various informational requests.

    Show 3 child parameters
    • company_authorizationobject
      Show 1 child parameter
      • filesarray of strings
    • passportobject
      Show 1 child parameter
      • filesarray of strings
    • visaobject
      Show 1 child parameter
      • filesarray of strings
  • emailstring

    The person's email address.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • first_namestring

    The person's first name.

  • first_name_kanastring

    The Kana variation of the person's first name (Japan only).

  • first_name_kanjistring

    The Kanji variation of the person's first name (Japan only).

  • full_name_aliasesarray of strings

    A list of alternate names or aliases that the person is known by.

  • genderstring

    The person's gender (International regulations require either "male" or "female").

  • id_numberstring

    The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account's representative requires that the account re-accept the terms of service.

  • id_number_secondarystring

    The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account's representative requires that the account re-accept the terms of service.

  • last_namestring

    The person's last name.

  • last_name_kanastring

    The Kana variation of the person's last name (Japan only).

  • last_name_kanjistring

    The Kanji variation of the person's last name (Japan only).

  • maiden_namestring

    The person's maiden name.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • nationalitystring

    The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.

  • person_tokenstring

    A person token, used to securely provide details to the person.

  • phonestring

    The person's phone number.

  • political_exposurestring

    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 values
    • existing
    • none
  • registered_addressobject

    The person's registered address.

    Show 6 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
  • relationshipobject

    The relationship that this person has with the account's legal entity.

    Show 8 child parameters
    • authorizerboolean
    • directorboolean
    • executiveboolean
    • legal_guardianboolean
    • ownerboolean
    • percent_ownershipnumber
    • representativeboolean
    • titlestring
  • ssn_last_4string

    The last four digits of the person's Social Security number (U.S. only). Changing this value for the account's representative requires that the account re-accept the terms of service.

  • us_cfpb_dataobject

    Demographic data related to the person.

    Show 3 child parameters
    • ethnicity_detailsobject
      Show 2 child parameters
      • ethnicityarray of strings
      • ethnicity_otherstring
    • race_detailsobject
      Show 2 child parameters
      • racearray of strings
      • race_otherstring
    • self_identified_genderstring
  • verificationobject

    The person's verification status.

    Show 2 child parameters
    • additional_documentobject
      Show 2 child parameters
      • backstring
      • frontstring
    • documentobject
      Show 2 child parameters
      • backstring
      • frontstring

Returns

The person object.

POST /v1/accounts/{account}/people
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account": "acct_1PgafTB7WZ01zgkW",
  "additional_tos_acceptances": {
    "account": {
      "date": null,
      "ip": null,
      "user_agent": null
    }
  },
  "created": 1234567890,
  "dob": {
    "day": null,
    "month": null,
    "year": null
  },
  "first_name": null,
  "future_requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
  "id_number_provided": false,
  "last_name": null,
  "metadata": {},
  "object": "person",
  "relationship": {
    "director": false,
    "executive": false,
    "legal_guardian": false,
    "owner": false,
    "percent_ownership": null,
    "representative": false,
    "title": null,
    "authorizer": null
  },
  "requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "ssn_last_4_provided": false,
  "verification": {
    "additional_document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "details": null,
    "details_code": null,
    "document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "status": "unverified"
  }
}

List all persons

GET/v1/accounts/{account}/people

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Path parameters

  • accountstringRequired

Query parameters

  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • relationshipobject

    Filters on the list of people returned based on the person's relationship to the account's company.

    Show 6 child parameters
    • authorizerboolean
    • directorboolean
    • executiveboolean
    • legal_guardianboolean
    • ownerboolean
    • representativeboolean
  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

A list of person objects.

GET /v1/accounts/{account}/people
curl -G https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  --data-urlencode limit=3
Response
{
  "object": "list",
  "url": "/v1/accounts",
  "has_more": false,
  "data": [
    {
      "account": "acct_1PgafTB7WZ01zgkW",
      "additional_tos_acceptances": {
        "account": {
          "date": null,
          "ip": null,
          "user_agent": null
        }
      },
      "created": 1234567890,
      "dob": {
        "day": null,
        "month": null,
        "year": null
      },
      "first_name": null,
      "future_requirements": {
        "alternatives": [],
        "currently_due": [],
        "errors": [],
        "eventually_due": [],
        "past_due": [],
        "pending_verification": []
      },
      "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
      "id_number_provided": false,
      "last_name": null,
      "metadata": {},
      "object": "person",
      "relationship": {
        "director": false,
        "executive": false,
        "legal_guardian": false,
        "owner": false,
        "percent_ownership": null,
        "representative": false,
        "title": null,
        "authorizer": null
      },
      "requirements": {
        "alternatives": [],
        "currently_due": [],
        "errors": [],
        "eventually_due": [],
        "past_due": [],
        "pending_verification": []
      },
      "ssn_last_4_provided": false,
      "verification": {
        "additional_document": {
          "back": null,
          "details": null,
          "details_code": null,
          "front": null
        },
        "details": null,
        "details_code": null,
        "document": {
          "back": null,
          "details": null,
          "details_code": null,
          "front": null
        },
        "status": "unverified"
      }
    }
  ]
}

Create a person

POST/v1/accounts/{account}/persons

Creates a new person.

Path parameters

  • accountstringRequired

Body parameters

  • additional_tos_acceptancesobject

    Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.

    Show 1 child parameter
    • accountobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
  • addressobject

    The person's address.

    Show 6 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
  • address_kanaobject

    The Kana variation of the person's address (Japan only).

    Show 7 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
    • townstring
  • address_kanjiobject

    The Kanji variation of the person's address (Japan only).

    Show 7 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
    • townstring
  • dobobject

    The person's date of birth.

    Show 3 child parameters
    • dayintegerRequired
    • monthintegerRequired
    • yearintegerRequired
  • documentsobject

    Documents that may be submitted to satisfy various informational requests.

    Show 3 child parameters
    • company_authorizationobject
      Show 1 child parameter
      • filesarray of strings
    • passportobject
      Show 1 child parameter
      • filesarray of strings
    • visaobject
      Show 1 child parameter
      • filesarray of strings
  • emailstring

    The person's email address.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • first_namestring

    The person's first name.

  • first_name_kanastring

    The Kana variation of the person's first name (Japan only).

  • first_name_kanjistring

    The Kanji variation of the person's first name (Japan only).

  • full_name_aliasesarray of strings

    A list of alternate names or aliases that the person is known by.

  • genderstring

    The person's gender (International regulations require either "male" or "female").

  • id_numberstring

    The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account's representative requires that the account re-accept the terms of service.

  • id_number_secondarystring

    The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account's representative requires that the account re-accept the terms of service.

  • last_namestring

    The person's last name.

  • last_name_kanastring

    The Kana variation of the person's last name (Japan only).

  • last_name_kanjistring

    The Kanji variation of the person's last name (Japan only).

  • maiden_namestring

    The person's maiden name.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • nationalitystring

    The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.

  • person_tokenstring

    A person token, used to securely provide details to the person.

  • phonestring

    The person's phone number.

  • political_exposurestring

    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 values
    • existing
    • none
  • registered_addressobject

    The person's registered address.

    Show 6 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
  • relationshipobject

    The relationship that this person has with the account's legal entity.

    Show 8 child parameters
    • authorizerboolean
    • directorboolean
    • executiveboolean
    • legal_guardianboolean
    • ownerboolean
    • percent_ownershipnumber
    • representativeboolean
    • titlestring
  • ssn_last_4string

    The last four digits of the person's Social Security number (U.S. only). Changing this value for the account's representative requires that the account re-accept the terms of service.

  • us_cfpb_dataobject

    Demographic data related to the person.

    Show 3 child parameters
    • ethnicity_detailsobject
      Show 2 child parameters
      • ethnicityarray of strings
      • ethnicity_otherstring
    • race_detailsobject
      Show 2 child parameters
      • racearray of strings
      • race_otherstring
    • self_identified_genderstring
  • verificationobject

    The person's verification status.

    Show 2 child parameters
    • additional_documentobject
      Show 2 child parameters
      • backstring
      • frontstring
    • documentobject
      Show 2 child parameters
      • backstring
      • frontstring

Returns

The person object.

POST /v1/accounts/{account}/persons
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account": "acct_1PgafTB7WZ01zgkW",
  "additional_tos_acceptances": {
    "account": {
      "date": null,
      "ip": null,
      "user_agent": null
    }
  },
  "created": 1234567890,
  "dob": {
    "day": null,
    "month": null,
    "year": null
  },
  "first_name": null,
  "future_requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
  "id_number_provided": false,
  "last_name": null,
  "metadata": {},
  "object": "person",
  "relationship": {
    "director": false,
    "executive": false,
    "legal_guardian": false,
    "owner": false,
    "percent_ownership": null,
    "representative": false,
    "title": null,
    "authorizer": null
  },
  "requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "ssn_last_4_provided": false,
  "verification": {
    "additional_document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "details": null,
    "details_code": null,
    "document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "status": "unverified"
  }
}

List all persons

GET/v1/accounts/{account}/persons

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Path parameters

  • accountstringRequired

Query parameters

  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • relationshipobject

    Filters on the list of people returned based on the person's relationship to the account's company.

    Show 6 child parameters
    • authorizerboolean
    • directorboolean
    • executiveboolean
    • legal_guardianboolean
    • ownerboolean
    • representativeboolean
  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

A list of person objects.

GET /v1/accounts/{account}/persons
curl -G https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  --data-urlencode limit=3
Response
{
  "object": "list",
  "url": "/v1/accounts",
  "has_more": false,
  "data": [
    {
      "account": "acct_1PgafTB7WZ01zgkW",
      "additional_tos_acceptances": {
        "account": {
          "date": null,
          "ip": null,
          "user_agent": null
        }
      },
      "created": 1234567890,
      "dob": {
        "day": null,
        "month": null,
        "year": null
      },
      "first_name": null,
      "future_requirements": {
        "alternatives": [],
        "currently_due": [],
        "errors": [],
        "eventually_due": [],
        "past_due": [],
        "pending_verification": []
      },
      "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
      "id_number_provided": false,
      "last_name": null,
      "metadata": {},
      "object": "person",
      "relationship": {
        "director": false,
        "executive": false,
        "legal_guardian": false,
        "owner": false,
        "percent_ownership": null,
        "representative": false,
        "title": null,
        "authorizer": null
      },
      "requirements": {
        "alternatives": [],
        "currently_due": [],
        "errors": [],
        "eventually_due": [],
        "past_due": [],
        "pending_verification": []
      },
      "ssn_last_4_provided": false,
      "verification": {
        "additional_document": {
          "back": null,
          "details": null,
          "details_code": null,
          "front": null
        },
        "details": null,
        "details_code": null,
        "document": {
          "back": null,
          "details": null,
          "details_code": null,
          "front": null
        },
        "status": "unverified"
      }
    }
  ]
}

Reject an account

POST/v1/accounts/{account}/reject

With Connect, you can reject accounts that you have flagged as suspicious. Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected.

Path parameters

  • accountstringRequired

Body parameters

  • reasonstringRequired

    The reason for rejecting the account. Can be fraud, terms_of_service, or other.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • payouts_actionstring

    Whether to pause payouts on the account as part of the rejection. Defaults to pause. Use none to leave payouts enabled.

    Possible values
    • none
    • pause

Returns

The account object.

POST /v1/accounts/{account}/reject
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/reject \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  -d reason=example
Response
{
  "business_profile": {
    "annual_revenue": {
      "amount": null,
      "currency": null,
      "fiscal_year_end": null
    },
    "estimated_worker_count": null,
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null,
    "minority_owned_business_designation": null
  },
  "business_type": null,
  "capabilities": {
    "card_payments": "active",
    "transfers": "active"
  },
  "charges_enabled": false,
  "controller": {
    "type": "account"
  },
  "country": "US",
  "created": 1234567890,
  "default_currency": "usd",
  "details_submitted": false,
  "email": "[email protected]",
  "external_accounts": {
    "data": [],
    "has_more": false,
    "object": "list",
    "url": "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "acct_1PgafTB7WZ01zgkW",
  "metadata": {},
  "object": "account",
  "payouts_enabled": false,
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "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": true,
        "cvc_failure": true
      },
      "statement_descriptor_prefix": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_kanji": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "invoices": {
      "default_account_tax_ids": null,
      "hosted_payment_method_save": null
    },
    "payments": {
      "statement_descriptor": null,
      "statement_descriptor_kana": null,
      "statement_descriptor_kanji": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_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": "standard"
}

Unreject an account

POST/v1/accounts/{account}/unreject

With Connect, you can unreject accounts that you have previously rejected. Only accounts that were rejected by your platform can be unrejected. This API cannot be used to unreject accounts that were rejected by Stripe. Unreject will only enable charges and/or payouts if there are no other restrictions other than those placed by a previous rejection. If you have separately paused charges and/or payouts outside of rejection, those pauses will remain in place after unrejection.

Path parameters

  • accountstringRequired

Body parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The account object.

POST /v1/accounts/{account}/unreject
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/unreject \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "business_profile": {
    "annual_revenue": {
      "amount": null,
      "currency": null,
      "fiscal_year_end": null
    },
    "estimated_worker_count": null,
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null,
    "minority_owned_business_designation": null
  },
  "business_type": null,
  "capabilities": {
    "card_payments": "active",
    "transfers": "active"
  },
  "charges_enabled": false,
  "controller": {
    "type": "account"
  },
  "country": "US",
  "created": 1234567890,
  "default_currency": "usd",
  "details_submitted": false,
  "email": "[email protected]",
  "external_accounts": {
    "data": [],
    "has_more": false,
    "object": "list",
    "url": "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "acct_1PgafTB7WZ01zgkW",
  "metadata": {},
  "object": "account",
  "payouts_enabled": false,
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "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": true,
        "cvc_failure": true
      },
      "statement_descriptor_prefix": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_kanji": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "invoices": {
      "default_account_tax_ids": null,
      "hosted_payment_method_save": null
    },
    "payments": {
      "statement_descriptor": null,
      "statement_descriptor_kana": null,
      "statement_descriptor_kanji": null,
      "statement_descriptor_prefix_kana": null,
      "statement_descriptor_prefix_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": "standard"
}

Update a bank account

POST/v1/accounts/{account}/bank_accounts/{id}

Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design. You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts. You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Path parameters

  • accountstringRequired
  • idstringRequired

Body parameters

  • account_holder_namestring

    The name of the person or business that owns the bank account.

  • account_holder_typestring

    The type of entity that holds the account. This can be either individual or company.

    Possible values
    • company
    • individual
  • account_typestring

    The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.

    Possible values
    • checking
    • futsu
    • savings
    • toza
  • address_citystring

    City/District/Suburb/Town/Village.

  • address_countrystring

    Billing address country, if provided when creating card.

  • address_line1string

    Address line 1 (Street address/PO Box/Company name).

  • address_line2string

    Address line 2 (Apartment/Suite/Unit/Building).

  • address_statestring

    State/County/Province/Region.

  • address_zipstring

    ZIP or postal code.

  • default_for_currencyboolean

    When set to true, this becomes the default external account for its currency.

  • documentsobject

    Documents that may be submitted to satisfy various informational requests.

    Show 1 child parameter
    • bank_account_ownership_verificationobject
      Show 1 child parameter
      • filesarray of strings
  • exp_monthstring

    Two digit number representing the card’s expiration month.

  • exp_yearstring

    Four digit number representing the card’s expiration year.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • namestring

    Cardholder name.

Returns

The external_account object.

POST /v1/accounts/{account}/bank_accounts/{id}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  -d "metadata[order_id]=6735"
Response
{
  "account_holder_name": "Jane Austen",
  "account_holder_type": "company",
  "account_type": null,
  "bank_name": "STRIPE TEST BANK",
  "country": "US",
  "currency": "usd",
  "customer": null,
  "fingerprint": "AuoSJ18zsVWV9SPc",
  "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
  "last4": "6789",
  "metadata": {},
  "object": "bank_account",
  "routing_number": "110000000",
  "status": "new"
}

Retrieve an external account

GET/v1/accounts/{account}/bank_accounts/{id}

Retrieve a specified external account for a given account.

Path parameters

  • accountstringRequired
  • idstringRequired

    Unique identifier for the external account to be retrieved.

Query parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The external_account object.

GET /v1/accounts/{account}/bank_accounts/{id}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account_holder_name": "Jane Austen",
  "account_holder_type": "company",
  "account_type": null,
  "bank_name": "STRIPE TEST BANK",
  "country": "US",
  "currency": "usd",
  "customer": null,
  "fingerprint": "AuoSJ18zsVWV9SPc",
  "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
  "last4": "6789",
  "metadata": {},
  "object": "bank_account",
  "routing_number": "110000000",
  "status": "new"
}

Delete an external account

DELETE/v1/accounts/{account}/bank_accounts/{id}

Delete a specified external account for a given account.

Path parameters

  • accountstringRequired
  • idstringRequired

    Unique identifier for the external account to be deleted.

Returns

The deleted_external_account object.

DELETE /v1/accounts/{account}/bank_accounts/{id}
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "deleted": true,
  "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
  "object": "bank_account"
}

Update an Account Capability

POST/v1/accounts/{account}/capabilities/{capability}

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

Path parameters

  • accountstringRequired
  • capabilitystringRequired

Body parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • requestedboolean

    To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the requirements arrays. If a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.

Returns

The capability object.

POST /v1/accounts/{account}/capabilities/{capability}
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account": "acct_1PgafTB7WZ01zgkW",
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "card_payments",
  "object": "capability",
  "requested": true,
  "requested_at": 1234567890,
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "status": "inactive"
}

Retrieve an Account Capability

GET/v1/accounts/{account}/capabilities/{capability}

Retrieves information about the specified Account Capability.

Path parameters

  • accountstringRequired
  • capabilitystringRequired

Query parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The capability object.

GET /v1/accounts/{account}/capabilities/{capability}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account": "acct_1PgafTB7WZ01zgkW",
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "card_payments",
  "object": "capability",
  "requested": true,
  "requested_at": 1234567890,
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "status": "inactive"
}

Update a bank account

POST/v1/accounts/{account}/external_accounts/{id}

Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design. You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts. You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Path parameters

  • accountstringRequired
  • idstringRequired

Body parameters

  • account_holder_namestring

    The name of the person or business that owns the bank account.

  • account_holder_typestring

    The type of entity that holds the account. This can be either individual or company.

    Possible values
    • company
    • individual
  • account_typestring

    The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.

    Possible values
    • checking
    • futsu
    • savings
    • toza
  • address_citystring

    City/District/Suburb/Town/Village.

  • address_countrystring

    Billing address country, if provided when creating card.

  • address_line1string

    Address line 1 (Street address/PO Box/Company name).

  • address_line2string

    Address line 2 (Apartment/Suite/Unit/Building).

  • address_statestring

    State/County/Province/Region.

  • address_zipstring

    ZIP or postal code.

  • default_for_currencyboolean

    When set to true, this becomes the default external account for its currency.

  • documentsobject

    Documents that may be submitted to satisfy various informational requests.

    Show 1 child parameter
    • bank_account_ownership_verificationobject
      Show 1 child parameter
      • filesarray of strings
  • exp_monthstring

    Two digit number representing the card’s expiration month.

  • exp_yearstring

    Four digit number representing the card’s expiration year.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • namestring

    Cardholder name.

Returns

The external_account object.

POST /v1/accounts/{account}/external_accounts/{id}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  -d "metadata[order_id]=6735"
Response
{
  "account_holder_name": "Jane Austen",
  "account_holder_type": "company",
  "account_type": null,
  "bank_name": "STRIPE TEST BANK",
  "country": "US",
  "currency": "usd",
  "customer": null,
  "fingerprint": "AuoSJ18zsVWV9SPc",
  "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
  "last4": "6789",
  "metadata": {},
  "object": "bank_account",
  "routing_number": "110000000",
  "status": "new"
}

Retrieve an external account

GET/v1/accounts/{account}/external_accounts/{id}

Retrieve a specified external account for a given account.

Path parameters

  • accountstringRequired
  • idstringRequired

    Unique identifier for the external account to be retrieved.

Query parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The external_account object.

GET /v1/accounts/{account}/external_accounts/{id}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account_holder_name": "Jane Austen",
  "account_holder_type": "company",
  "account_type": null,
  "bank_name": "STRIPE TEST BANK",
  "country": "US",
  "currency": "usd",
  "customer": null,
  "fingerprint": "AuoSJ18zsVWV9SPc",
  "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
  "last4": "6789",
  "metadata": {},
  "object": "bank_account",
  "routing_number": "110000000",
  "status": "new"
}

Delete an external account

DELETE/v1/accounts/{account}/external_accounts/{id}

Delete a specified external account for a given account.

Path parameters

  • accountstringRequired
  • idstringRequired

    Unique identifier for the external account to be deleted.

Returns

The deleted_external_account object.

DELETE /v1/accounts/{account}/external_accounts/{id}
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "deleted": true,
  "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
  "object": "bank_account"
}

Update a person

POST/v1/accounts/{account}/people/{person}

Updates an existing person.

Path parameters

  • accountstringRequired
  • personstringRequired

Body parameters

  • additional_tos_acceptancesobject

    Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.

    Show 1 child parameter
    • accountobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
  • addressobject

    The person's address.

    Show 6 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
  • address_kanaobject

    The Kana variation of the person's address (Japan only).

    Show 7 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
    • townstring
  • address_kanjiobject

    The Kanji variation of the person's address (Japan only).

    Show 7 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
    • townstring
  • dobobject

    The person's date of birth.

    Show 3 child parameters
    • dayintegerRequired
    • monthintegerRequired
    • yearintegerRequired
  • documentsobject

    Documents that may be submitted to satisfy various informational requests.

    Show 3 child parameters
    • company_authorizationobject
      Show 1 child parameter
      • filesarray of strings
    • passportobject
      Show 1 child parameter
      • filesarray of strings
    • visaobject
      Show 1 child parameter
      • filesarray of strings
  • emailstring

    The person's email address.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • first_namestring

    The person's first name.

  • first_name_kanastring

    The Kana variation of the person's first name (Japan only).

  • first_name_kanjistring

    The Kanji variation of the person's first name (Japan only).

  • full_name_aliasesarray of strings

    A list of alternate names or aliases that the person is known by.

  • genderstring

    The person's gender (International regulations require either "male" or "female").

  • id_numberstring

    The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account's representative requires that the account re-accept the terms of service.

  • id_number_secondarystring

    The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account's representative requires that the account re-accept the terms of service.

  • last_namestring

    The person's last name.

  • last_name_kanastring

    The Kana variation of the person's last name (Japan only).

  • last_name_kanjistring

    The Kanji variation of the person's last name (Japan only).

  • maiden_namestring

    The person's maiden name.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • nationalitystring

    The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.

  • person_tokenstring

    A person token, used to securely provide details to the person.

  • phonestring

    The person's phone number.

  • political_exposurestring

    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 values
    • existing
    • none
  • registered_addressobject

    The person's registered address.

    Show 6 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
  • relationshipobject

    The relationship that this person has with the account's legal entity.

    Show 8 child parameters
    • authorizerboolean
    • directorboolean
    • executiveboolean
    • legal_guardianboolean
    • ownerboolean
    • percent_ownershipnumber
    • representativeboolean
    • titlestring
  • ssn_last_4string

    The last four digits of the person's Social Security number (U.S. only). Changing this value for the account's representative requires that the account re-accept the terms of service.

  • us_cfpb_dataobject

    Demographic data related to the person.

    Show 3 child parameters
    • ethnicity_detailsobject
      Show 2 child parameters
      • ethnicityarray of strings
      • ethnicity_otherstring
    • race_detailsobject
      Show 2 child parameters
      • racearray of strings
      • race_otherstring
    • self_identified_genderstring
  • verificationobject

    The person's verification status.

    Show 2 child parameters
    • additional_documentobject
      Show 2 child parameters
      • backstring
      • frontstring
    • documentobject
      Show 2 child parameters
      • backstring
      • frontstring

Returns

The person object.

POST /v1/accounts/{account}/people/{person}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  -d "metadata[order_id]=6735"
Response
{
  "account": "acct_1PgafTB7WZ01zgkW",
  "additional_tos_acceptances": {
    "account": {
      "date": null,
      "ip": null,
      "user_agent": null
    }
  },
  "created": 1234567890,
  "dob": {
    "day": null,
    "month": null,
    "year": null
  },
  "first_name": null,
  "future_requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
  "id_number_provided": false,
  "last_name": null,
  "metadata": {},
  "object": "person",
  "relationship": {
    "director": false,
    "executive": false,
    "legal_guardian": false,
    "owner": false,
    "percent_ownership": null,
    "representative": false,
    "title": null,
    "authorizer": null
  },
  "requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "ssn_last_4_provided": false,
  "verification": {
    "additional_document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "details": null,
    "details_code": null,
    "document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "status": "unverified"
  }
}

Retrieve a person

GET/v1/accounts/{account}/people/{person}

Retrieves an existing person.

Path parameters

  • accountstringRequired
  • personstringRequired

Query parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The person object.

GET /v1/accounts/{account}/people/{person}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account": "acct_1PgafTB7WZ01zgkW",
  "additional_tos_acceptances": {
    "account": {
      "date": null,
      "ip": null,
      "user_agent": null
    }
  },
  "created": 1234567890,
  "dob": {
    "day": null,
    "month": null,
    "year": null
  },
  "first_name": null,
  "future_requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
  "id_number_provided": false,
  "last_name": null,
  "metadata": {},
  "object": "person",
  "relationship": {
    "director": false,
    "executive": false,
    "legal_guardian": false,
    "owner": false,
    "percent_ownership": null,
    "representative": false,
    "title": null,
    "authorizer": null
  },
  "requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "ssn_last_4_provided": false,
  "verification": {
    "additional_document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "details": null,
    "details_code": null,
    "document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "status": "unverified"
  }
}

Delete a person

DELETE/v1/accounts/{account}/people/{person}

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the representative. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

Path parameters

  • accountstringRequired
  • personstringRequired

Returns

The deleted_person object.

DELETE /v1/accounts/{account}/people/{person}
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "deleted": true,
  "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
  "object": "person"
}

Update a person

POST/v1/accounts/{account}/persons/{person}

Updates an existing person.

Path parameters

  • accountstringRequired
  • personstringRequired

Body parameters

  • additional_tos_acceptancesobject

    Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.

    Show 1 child parameter
    • accountobject
      Show 3 child parameters
      • dateinteger
      • ipstring
      • user_agentstring
  • addressobject

    The person's address.

    Show 6 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
  • address_kanaobject

    The Kana variation of the person's address (Japan only).

    Show 7 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
    • townstring
  • address_kanjiobject

    The Kanji variation of the person's address (Japan only).

    Show 7 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
    • townstring
  • dobobject

    The person's date of birth.

    Show 3 child parameters
    • dayintegerRequired
    • monthintegerRequired
    • yearintegerRequired
  • documentsobject

    Documents that may be submitted to satisfy various informational requests.

    Show 3 child parameters
    • company_authorizationobject
      Show 1 child parameter
      • filesarray of strings
    • passportobject
      Show 1 child parameter
      • filesarray of strings
    • visaobject
      Show 1 child parameter
      • filesarray of strings
  • emailstring

    The person's email address.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • first_namestring

    The person's first name.

  • first_name_kanastring

    The Kana variation of the person's first name (Japan only).

  • first_name_kanjistring

    The Kanji variation of the person's first name (Japan only).

  • full_name_aliasesarray of strings

    A list of alternate names or aliases that the person is known by.

  • genderstring

    The person's gender (International regulations require either "male" or "female").

  • id_numberstring

    The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account's representative requires that the account re-accept the terms of service.

  • id_number_secondarystring

    The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account's representative requires that the account re-accept the terms of service.

  • last_namestring

    The person's last name.

  • last_name_kanastring

    The Kana variation of the person's last name (Japan only).

  • last_name_kanjistring

    The Kanji variation of the person's last name (Japan only).

  • maiden_namestring

    The person's maiden name.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • nationalitystring

    The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.

  • person_tokenstring

    A person token, used to securely provide details to the person.

  • phonestring

    The person's phone number.

  • political_exposurestring

    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 values
    • existing
    • none
  • registered_addressobject

    The person's registered address.

    Show 6 child parameters
    • citystring
    • countrystring
    • line1string
    • line2string
    • postal_codestring
    • statestring
  • relationshipobject

    The relationship that this person has with the account's legal entity.

    Show 8 child parameters
    • authorizerboolean
    • directorboolean
    • executiveboolean
    • legal_guardianboolean
    • ownerboolean
    • percent_ownershipnumber
    • representativeboolean
    • titlestring
  • ssn_last_4string

    The last four digits of the person's Social Security number (U.S. only). Changing this value for the account's representative requires that the account re-accept the terms of service.

  • us_cfpb_dataobject

    Demographic data related to the person.

    Show 3 child parameters
    • ethnicity_detailsobject
      Show 2 child parameters
      • ethnicityarray of strings
      • ethnicity_otherstring
    • race_detailsobject
      Show 2 child parameters
      • racearray of strings
      • race_otherstring
    • self_identified_genderstring
  • verificationobject

    The person's verification status.

    Show 2 child parameters
    • additional_documentobject
      Show 2 child parameters
      • backstring
      • frontstring
    • documentobject
      Show 2 child parameters
      • backstring
      • frontstring

Returns

The person object.

POST /v1/accounts/{account}/persons/{person}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  -d "metadata[order_id]=6735"
Response
{
  "account": "acct_1PgafTB7WZ01zgkW",
  "additional_tos_acceptances": {
    "account": {
      "date": null,
      "ip": null,
      "user_agent": null
    }
  },
  "created": 1234567890,
  "dob": {
    "day": null,
    "month": null,
    "year": null
  },
  "first_name": null,
  "future_requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
  "id_number_provided": false,
  "last_name": null,
  "metadata": {},
  "object": "person",
  "relationship": {
    "director": false,
    "executive": false,
    "legal_guardian": false,
    "owner": false,
    "percent_ownership": null,
    "representative": false,
    "title": null,
    "authorizer": null
  },
  "requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "ssn_last_4_provided": false,
  "verification": {
    "additional_document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "details": null,
    "details_code": null,
    "document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "status": "unverified"
  }
}

Retrieve a person

GET/v1/accounts/{account}/persons/{person}

Retrieves an existing person.

Path parameters

  • accountstringRequired
  • personstringRequired

Query parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The person object.

GET /v1/accounts/{account}/persons/{person}
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "account": "acct_1PgafTB7WZ01zgkW",
  "additional_tos_acceptances": {
    "account": {
      "date": null,
      "ip": null,
      "user_agent": null
    }
  },
  "created": 1234567890,
  "dob": {
    "day": null,
    "month": null,
    "year": null
  },
  "first_name": null,
  "future_requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
  "id_number_provided": false,
  "last_name": null,
  "metadata": {},
  "object": "person",
  "relationship": {
    "director": false,
    "executive": false,
    "legal_guardian": false,
    "owner": false,
    "percent_ownership": null,
    "representative": false,
    "title": null,
    "authorizer": null
  },
  "requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "ssn_last_4_provided": false,
  "verification": {
    "additional_document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "details": null,
    "details_code": null,
    "document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "status": "unverified"
  }
}

Delete a person

DELETE/v1/accounts/{account}/persons/{person}

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the representative. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

Path parameters

  • accountstringRequired
  • personstringRequired

Returns

The deleted_person object.

DELETE /v1/accounts/{account}/persons/{person}
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "deleted": true,
  "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
  "object": "person"
}

Operations and schemas come from the pinned Stripe OpenAPI specification (MIT); response examples from its fixtures. Nested object definitions and enums are in the complete specification.