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.
https://api.knoxapi.com- POST/
v1/ accounts - GET/
v1/ accounts - POST/
v1/ accounts/ {account} - GET/
v1/ accounts/ {account} - DELETE/
v1/ accounts/ {account} - POST/
v1/ accounts/ {account}/ bank_accounts - GET/
v1/ accounts/ {account}/ capabilities - POST/
v1/ accounts/ {account}/ external_accounts - GET/
v1/ accounts/ {account}/ external_accounts - POST/
v1/ accounts/ {account}/ login_links - POST/
v1/ accounts/ {account}/ people - GET/
v1/ accounts/ {account}/ people - POST/
v1/ accounts/ {account}/ persons - GET/
v1/ accounts/ {account}/ persons - POST/
v1/ accounts/ {account}/ reject - POST/
v1/ accounts/ {account}/ unreject - POST/
v1/ accounts/ {account}/ bank_accounts/ {id} - GET/
v1/ accounts/ {account}/ bank_accounts/ {id} - DELETE/
v1/ accounts/ {account}/ bank_accounts/ {id} - POST/
v1/ accounts/ {account}/ capabilities/ {capability} - GET/
v1/ accounts/ {account}/ capabilities/ {capability} - POST/
v1/ accounts/ {account}/ external_accounts/ {id} - GET/
v1/ accounts/ {account}/ external_accounts/ {id} - DELETE/
v1/ accounts/ {account}/ external_accounts/ {id} - POST/
v1/ accounts/ {account}/ people/ {person} - GET/
v1/ accounts/ {account}/ people/ {person} - DELETE/
v1/ accounts/ {account}/ people/ {person} - POST/
v1/ accounts/ {account}/ persons/ {person} - GET/
v1/ accounts/ {account}/ persons/ {person} - DELETE/
v1/ accounts/ {account}/ persons/ {person}
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_tokenstringAn account token, used to securely provide details to the account.
bank_accountobject | stringEither a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
Show 9 child parameters
account_numberstringRequiredcountrystringRequiredaccount_holder_namestringaccount_holder_typestringPossible valuescompanyindividual
account_typestringPossible valuescheckingfutsusavingstoza
currencystringdocumentsobjectShow 1 child parameter
bank_account_ownership_verificationobjectChild parameters are listed in the OpenAPI document.
objectstringPossible valuesbank_account
routing_numberstring
business_profileobjectBusiness information about the account.
Show 12 child parameters
annual_revenueobjectShow 3 child parameters
amountintegerRequiredcurrencystringRequiredfiscal_year_endstringRequired
estimated_worker_countintegermccstringminority_owned_business_designationarray of stringsmonthly_estimated_revenueobjectShow 2 child parameters
amountintegerRequiredcurrencystringRequired
namestringproduct_descriptionstringsupport_addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
support_emailstringsupport_phonestringsupport_urlstringurlstring
business_typestringThe 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 valuescompanygovernment_entityindividualnon_profit
capabilitiesobjectEach 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_paymentsobjectShow 1 child parameter
requestedboolean
affirm_paymentsobjectShow 1 child parameter
requestedboolean
afterpay_clearpay_paymentsobjectShow 1 child parameter
requestedboolean
alma_paymentsobjectShow 1 child parameter
requestedboolean
amazon_pay_paymentsobjectShow 1 child parameter
requestedboolean
app_distributionobjectShow 1 child parameter
requestedboolean
au_becs_debit_paymentsobjectShow 1 child parameter
requestedboolean
bacs_debit_paymentsobjectShow 1 child parameter
requestedboolean
bancontact_paymentsobjectShow 1 child parameter
requestedboolean
bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
billie_paymentsobjectShow 1 child parameter
requestedboolean
bizum_paymentsobjectShow 1 child parameter
requestedboolean
blik_paymentsobjectShow 1 child parameter
requestedboolean
boleto_paymentsobjectShow 1 child parameter
requestedboolean
card_issuingobjectShow 1 child parameter
requestedboolean
card_paymentsobjectShow 1 child parameter
requestedboolean
cartes_bancaires_paymentsobjectShow 1 child parameter
requestedboolean
cashapp_paymentsobjectShow 1 child parameter
requestedboolean
crypto_paymentsobjectShow 1 child parameter
requestedboolean
eps_paymentsobjectShow 1 child parameter
requestedboolean
fpx_paymentsobjectShow 1 child parameter
requestedboolean
gb_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
giropay_paymentsobjectShow 1 child parameter
requestedboolean
grabpay_paymentsobjectShow 1 child parameter
requestedboolean
ideal_paymentsobjectShow 1 child parameter
requestedboolean
india_international_paymentsobjectShow 1 child parameter
requestedboolean
jcb_paymentsobjectShow 1 child parameter
requestedboolean
jp_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
kakao_pay_paymentsobjectShow 1 child parameter
requestedboolean
klarna_paymentsobjectShow 1 child parameter
requestedboolean
konbini_paymentsobjectShow 1 child parameter
requestedboolean
kr_card_paymentsobjectShow 1 child parameter
requestedboolean
legacy_paymentsobjectShow 1 child parameter
requestedboolean
link_paymentsobjectShow 1 child parameter
requestedboolean
mb_way_paymentsobjectShow 1 child parameter
requestedboolean
mobilepay_paymentsobjectShow 1 child parameter
requestedboolean
multibanco_paymentsobjectShow 1 child parameter
requestedboolean
mx_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
naver_pay_paymentsobjectShow 1 child parameter
requestedboolean
nz_bank_account_becs_debit_paymentsobjectShow 1 child parameter
requestedboolean
oxxo_paymentsobjectShow 1 child parameter
requestedboolean
p24_paymentsobjectShow 1 child parameter
requestedboolean
pay_by_bank_paymentsobjectShow 1 child parameter
requestedboolean
payco_paymentsobjectShow 1 child parameter
requestedboolean
paynow_paymentsobjectShow 1 child parameter
requestedboolean
payto_paymentsobjectShow 1 child parameter
requestedboolean
pix_paymentsobjectShow 1 child parameter
requestedboolean
promptpay_paymentsobjectShow 1 child parameter
requestedboolean
revolut_pay_paymentsobjectShow 1 child parameter
requestedboolean
samsung_pay_paymentsobjectShow 1 child parameter
requestedboolean
satispay_paymentsobjectShow 1 child parameter
requestedboolean
scalapay_paymentsobjectShow 1 child parameter
requestedboolean
sepa_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
sepa_debit_paymentsobjectShow 1 child parameter
requestedboolean
sofort_paymentsobjectShow 1 child parameter
requestedboolean
sunbit_paymentsobjectShow 1 child parameter
requestedboolean
swish_paymentsobjectShow 1 child parameter
requestedboolean
tax_reporting_us_1099_kobjectShow 1 child parameter
requestedboolean
tax_reporting_us_1099_miscobjectShow 1 child parameter
requestedboolean
transfersobjectShow 1 child parameter
requestedboolean
treasuryobjectShow 1 child parameter
requestedboolean
twint_paymentsobjectShow 1 child parameter
requestedboolean
upi_paymentsobjectShow 1 child parameter
requestedboolean
us_bank_account_ach_paymentsobjectShow 1 child parameter
requestedboolean
us_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
zip_paymentsobjectShow 1 child parameter
requestedboolean
companyobjectInformation 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 isapplication, which includes Custom accounts.Show 25 child parameters
addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
address_kanaobjectShow 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
address_kanjiobjectShow 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
administrative_addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
directors_providedbooleandirectorship_declarationobjectShow 3 child parameters
dateintegeripstringuser_agentstring
executives_providedbooleanexport_license_idstringexport_purpose_codestringnamestringname_kanastringname_kanjistringowners_providedbooleanownership_declarationobjectShow 3 child parameters
dateintegeripstringuser_agentstring
ownership_exemption_reasonstringPossible valuesqualified_entity_exceeds_ownership_thresholdqualifies_as_financial_institution
phonestringprincipal_place_of_businessobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
registration_dateobjectShow 3 child parameters
dayintegerRequiredmonthintegerRequiredyearintegerRequired
registration_numberstringrepresentative_declarationobjectShow 3 child parameters
dateintegeripstringuser_agentstring
structurestringPossible valuesfree_zone_establishmentfree_zone_llcgovernment_instrumentalitygovernmental_unitincorporated_non_profitincorporated_partnershiplimited_liability_partnershipllcmulti_member_llcprivate_companyprivate_corporationprivate_partnershippublic_companypublic_corporationpublic_partnershipregistered_charity- and 7 more
tax_idstringtax_id_registrarstringvat_idstringverificationobjectShow 1 child parameter
documentobjectChild parameters are listed in the OpenAPI document.
controllerobjectA hash of configuration describing the account controller's attributes.
Show 4 child parameters
feesobjectShow 1 child parameter
payerstringPossible valuesaccountapplication
lossesobjectShow 1 child parameter
paymentsstringPossible valuesapplicationstripe
requirement_collectionstringPossible valuesapplicationstripe
stripe_dashboardobjectShow 1 child parameter
typestringPossible valuesexpressfullnone
countrystringThe 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
CAas 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_currencystringThree-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
documentsobjectDocuments that may be submitted to satisfy various informational requests.
Show 8 child parameters
bank_account_ownership_verificationobjectShow 1 child parameter
filesarray of strings
company_licenseobjectShow 1 child parameter
filesarray of strings
company_memorandum_of_associationobjectShow 1 child parameter
filesarray of strings
company_ministerial_decreeobjectShow 1 child parameter
filesarray of strings
company_registration_verificationobjectShow 1 child parameter
filesarray of strings
company_tax_id_verificationobjectShow 1 child parameter
filesarray of strings
proof_of_addressobjectShow 1 child parameter
filesarray of strings
proof_of_ultimate_beneficial_ownershipobjectShow 2 child parameters
filesarray of stringssignerobjectChild parameters are listed in the OpenAPI document.
emailstringThe 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 stringsSpecifies which fields in the response should be expanded.
external_accountstringA 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_accountparameter 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 isapplication, which includes Custom accounts.groupsobjectA hash of account group type to tokens. These are account groups this account should be added to.
Show 1 child parameter
payments_pricingstring
individualobjectInformation about the person represented by the account. This field is null unless
business_typeis set toindividual. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection isapplication, which includes Custom accounts.Show 23 child parameters
addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
address_kanaobjectShow 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
address_kanjiobjectShow 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
dobobjectShow 3 child parameters
dayintegerRequiredmonthintegerRequiredyearintegerRequired
emailstringfirst_namestringfirst_name_kanastringfirst_name_kanjistringfull_name_aliasesarray of stringsgenderstringid_numberstringid_number_secondarystringlast_namestringlast_name_kanastringlast_name_kanjistringmaiden_namestringmetadataobjectphonestringpolitical_exposurestringPossible valuesexistingnone
registered_addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
relationshipobjectShow 5 child parameters
directorbooleanexecutivebooleanownerbooleanpercent_ownershipnumbertitlestring
ssn_last_4stringverificationobjectShow 2 child parameters
additional_documentobjectChild parameters are listed in the OpenAPI document.
documentobjectChild parameters are listed in the OpenAPI document.
metadataobjectSet 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.settingsobjectOptions for customizing how the account functions within Stripe.
Show 8 child parameters
bacs_debit_paymentsobjectShow 1 child parameter
display_namestring
brandingobjectShow 4 child parameters
iconstringlogostringprimary_colorstringsecondary_colorstring
card_issuingobjectShow 1 child parameter
tos_acceptanceobjectChild parameters are listed in the OpenAPI document.
card_paymentsobjectShow 4 child parameters
decline_onobjectChild parameters are listed in the OpenAPI document.
statement_descriptor_prefixstringstatement_descriptor_prefix_kanastringstatement_descriptor_prefix_kanjistring
invoicesobjectShow 1 child parameter
hosted_payment_method_savestringPossible valuesalwaysneveroffer
paymentsobjectShow 3 child parameters
statement_descriptorstringstatement_descriptor_kanastringstatement_descriptor_kanjistring
payoutsobjectShow 3 child parameters
debit_negative_balancesbooleanscheduleobjectChild parameters are listed in the OpenAPI document.
statement_descriptorstring
treasuryobjectShow 1 child parameter
tos_acceptanceobjectChild parameters are listed in the OpenAPI document.
tos_acceptanceobjectDetails 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 afullservice agreement when empty.Show 4 child parameters
dateintegeripstringservice_agreementstringuser_agentstring
typestringThe
typeparameter is deprecated. Usecontrollerinstead to configure dashboard access, fee payer, loss liability, and requirement collection.Possible valuescustomexpressstandard
Returns
The account object.
curl -X POST https://api.knoxapi.com/v1/accounts \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const account = await stripe.accounts.create();import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
account = client.v1.accounts.create()require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
account = Stripe::Account.create(){
"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 | integerOnly return connected accounts that were created during the given date interval.
Show 4 child parameters
gtintegergteintegerltintegerlteinteger
ending_beforestringA cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.expandarray of stringsSpecifies which fields in the response should be expanded.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_afterstringA cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
Returns
A list of account objects.
curl -G https://api.knoxapi.com/v1/accounts \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
--data-urlencode limit=3const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const page = await stripe.accounts.list({
limit: 3,
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
page = client.v1.accounts.list(params={
"limit": 3,
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
page = Stripe::Account.list({
limit: 3,
}){
"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_tokenstringAn account token, used to securely provide details to the account.
business_profileobjectBusiness information about the account.
Show 12 child parameters
annual_revenueobjectShow 3 child parameters
amountintegerRequiredcurrencystringRequiredfiscal_year_endstringRequired
estimated_worker_countintegermccstringminority_owned_business_designationarray of stringsmonthly_estimated_revenueobjectShow 2 child parameters
amountintegerRequiredcurrencystringRequired
namestringproduct_descriptionstringsupport_addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
support_emailstringsupport_phonestringsupport_urlstringurlstring
business_typestringThe 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 valuescompanygovernment_entityindividualnon_profit
capabilitiesobjectEach 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_paymentsobjectShow 1 child parameter
requestedboolean
affirm_paymentsobjectShow 1 child parameter
requestedboolean
afterpay_clearpay_paymentsobjectShow 1 child parameter
requestedboolean
alma_paymentsobjectShow 1 child parameter
requestedboolean
amazon_pay_paymentsobjectShow 1 child parameter
requestedboolean
app_distributionobjectShow 1 child parameter
requestedboolean
au_becs_debit_paymentsobjectShow 1 child parameter
requestedboolean
bacs_debit_paymentsobjectShow 1 child parameter
requestedboolean
bancontact_paymentsobjectShow 1 child parameter
requestedboolean
bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
billie_paymentsobjectShow 1 child parameter
requestedboolean
bizum_paymentsobjectShow 1 child parameter
requestedboolean
blik_paymentsobjectShow 1 child parameter
requestedboolean
boleto_paymentsobjectShow 1 child parameter
requestedboolean
card_issuingobjectShow 1 child parameter
requestedboolean
card_paymentsobjectShow 1 child parameter
requestedboolean
cartes_bancaires_paymentsobjectShow 1 child parameter
requestedboolean
cashapp_paymentsobjectShow 1 child parameter
requestedboolean
crypto_paymentsobjectShow 1 child parameter
requestedboolean
eps_paymentsobjectShow 1 child parameter
requestedboolean
fpx_paymentsobjectShow 1 child parameter
requestedboolean
gb_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
giropay_paymentsobjectShow 1 child parameter
requestedboolean
grabpay_paymentsobjectShow 1 child parameter
requestedboolean
ideal_paymentsobjectShow 1 child parameter
requestedboolean
india_international_paymentsobjectShow 1 child parameter
requestedboolean
jcb_paymentsobjectShow 1 child parameter
requestedboolean
jp_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
kakao_pay_paymentsobjectShow 1 child parameter
requestedboolean
klarna_paymentsobjectShow 1 child parameter
requestedboolean
konbini_paymentsobjectShow 1 child parameter
requestedboolean
kr_card_paymentsobjectShow 1 child parameter
requestedboolean
legacy_paymentsobjectShow 1 child parameter
requestedboolean
link_paymentsobjectShow 1 child parameter
requestedboolean
mb_way_paymentsobjectShow 1 child parameter
requestedboolean
mobilepay_paymentsobjectShow 1 child parameter
requestedboolean
multibanco_paymentsobjectShow 1 child parameter
requestedboolean
mx_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
naver_pay_paymentsobjectShow 1 child parameter
requestedboolean
nz_bank_account_becs_debit_paymentsobjectShow 1 child parameter
requestedboolean
oxxo_paymentsobjectShow 1 child parameter
requestedboolean
p24_paymentsobjectShow 1 child parameter
requestedboolean
pay_by_bank_paymentsobjectShow 1 child parameter
requestedboolean
payco_paymentsobjectShow 1 child parameter
requestedboolean
paynow_paymentsobjectShow 1 child parameter
requestedboolean
payto_paymentsobjectShow 1 child parameter
requestedboolean
pix_paymentsobjectShow 1 child parameter
requestedboolean
promptpay_paymentsobjectShow 1 child parameter
requestedboolean
revolut_pay_paymentsobjectShow 1 child parameter
requestedboolean
samsung_pay_paymentsobjectShow 1 child parameter
requestedboolean
satispay_paymentsobjectShow 1 child parameter
requestedboolean
scalapay_paymentsobjectShow 1 child parameter
requestedboolean
sepa_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
sepa_debit_paymentsobjectShow 1 child parameter
requestedboolean
sofort_paymentsobjectShow 1 child parameter
requestedboolean
sunbit_paymentsobjectShow 1 child parameter
requestedboolean
swish_paymentsobjectShow 1 child parameter
requestedboolean
tax_reporting_us_1099_kobjectShow 1 child parameter
requestedboolean
tax_reporting_us_1099_miscobjectShow 1 child parameter
requestedboolean
transfersobjectShow 1 child parameter
requestedboolean
treasuryobjectShow 1 child parameter
requestedboolean
twint_paymentsobjectShow 1 child parameter
requestedboolean
upi_paymentsobjectShow 1 child parameter
requestedboolean
us_bank_account_ach_paymentsobjectShow 1 child parameter
requestedboolean
us_bank_transfer_paymentsobjectShow 1 child parameter
requestedboolean
zip_paymentsobjectShow 1 child parameter
requestedboolean
companyobjectInformation 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 isapplication, which includes Custom accounts.Show 25 child parameters
addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
address_kanaobjectShow 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
address_kanjiobjectShow 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
administrative_addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
directors_providedbooleandirectorship_declarationobjectShow 3 child parameters
dateintegeripstringuser_agentstring
executives_providedbooleanexport_license_idstringexport_purpose_codestringnamestringname_kanastringname_kanjistringowners_providedbooleanownership_declarationobjectShow 3 child parameters
dateintegeripstringuser_agentstring
ownership_exemption_reasonstringPossible valuesqualified_entity_exceeds_ownership_thresholdqualifies_as_financial_institution
phonestringprincipal_place_of_businessobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
registration_dateobjectShow 3 child parameters
dayintegerRequiredmonthintegerRequiredyearintegerRequired
registration_numberstringrepresentative_declarationobjectShow 3 child parameters
dateintegeripstringuser_agentstring
structurestringPossible valuesfree_zone_establishmentfree_zone_llcgovernment_instrumentalitygovernmental_unitincorporated_non_profitincorporated_partnershiplimited_liability_partnershipllcmulti_member_llcprivate_companyprivate_corporationprivate_partnershippublic_companypublic_corporationpublic_partnershipregistered_charity- and 7 more
tax_idstringtax_id_registrarstringvat_idstringverificationobjectShow 1 child parameter
documentobjectChild parameters are listed in the OpenAPI document.
default_currencystringThree-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
documentsobjectDocuments that may be submitted to satisfy various informational requests.
Show 9 child parameters
bank_account_ownership_verificationobjectShow 1 child parameter
filesarray of strings
company_licenseobjectShow 1 child parameter
filesarray of strings
company_memorandum_of_associationobjectShow 1 child parameter
filesarray of strings
company_ministerial_decreeobjectShow 1 child parameter
filesarray of strings
company_registration_verificationobjectShow 1 child parameter
filesarray of strings
company_tax_id_verificationobjectShow 1 child parameter
filesarray of strings
proof_of_addressobjectShow 1 child parameter
filesarray of strings
proof_of_registrationobjectShow 2 child parameters
filesarray of stringssignerobjectChild parameters are listed in the OpenAPI document.
proof_of_ultimate_beneficial_ownershipobjectShow 2 child parameters
filesarray of stringssignerobjectChild parameters are listed in the OpenAPI document.
emailstringThe 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 stringsSpecifies which fields in the response should be expanded.
external_accountstringA 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_accountparameter 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 isapplication, which includes Custom accounts.groupsobjectA hash of account group type to tokens. These are account groups this account should be added to.
Show 1 child parameter
payments_pricingstring
individualobjectInformation about the person represented by the account. This field is null unless
business_typeis set toindividual. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection isapplication, which includes Custom accounts.Show 23 child parameters
addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
address_kanaobjectShow 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
address_kanjiobjectShow 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
dobobjectShow 3 child parameters
dayintegerRequiredmonthintegerRequiredyearintegerRequired
emailstringfirst_namestringfirst_name_kanastringfirst_name_kanjistringfull_name_aliasesarray of stringsgenderstringid_numberstringid_number_secondarystringlast_namestringlast_name_kanastringlast_name_kanjistringmaiden_namestringmetadataobjectphonestringpolitical_exposurestringPossible valuesexistingnone
registered_addressobjectShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
relationshipobjectShow 5 child parameters
directorbooleanexecutivebooleanownerbooleanpercent_ownershipnumbertitlestring
ssn_last_4stringverificationobjectShow 2 child parameters
additional_documentobjectChild parameters are listed in the OpenAPI document.
documentobjectChild parameters are listed in the OpenAPI document.
metadataobjectSet 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.settingsobjectOptions for customizing how the account functions within Stripe.
Show 9 child parameters
bacs_debit_paymentsobjectShow 1 child parameter
display_namestring
brandingobjectShow 4 child parameters
iconstringlogostringprimary_colorstringsecondary_colorstring
card_issuingobjectShow 1 child parameter
tos_acceptanceobjectChild parameters are listed in the OpenAPI document.
card_paymentsobjectShow 4 child parameters
decline_onobjectChild parameters are listed in the OpenAPI document.
statement_descriptor_prefixstringstatement_descriptor_prefix_kanastringstatement_descriptor_prefix_kanjistring
invoicesobjectShow 2 child parameters
default_account_tax_idsarray of stringshosted_payment_method_savestringPossible valuesalwaysneveroffer
paymentsobjectShow 3 child parameters
statement_descriptorstringstatement_descriptor_kanastringstatement_descriptor_kanjistring
payoutsobjectShow 3 child parameters
debit_negative_balancesbooleanscheduleobjectChild parameters are listed in the OpenAPI document.
statement_descriptorstring
sepa_debit_paymentsobjectShow 1 child parameter
creditor_idstring
treasuryobjectShow 1 child parameter
tos_acceptanceobjectChild parameters are listed in the OpenAPI document.
tos_acceptanceobjectDetails 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 afullservice agreement when empty.Show 4 child parameters
dateintegeripstringservice_agreementstringuser_agentstring
Returns
The account object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
-d "metadata[order_id]=6735"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const account = await stripe.accounts.update('acct_1PgafTB7WZ01zgkW', {
metadata: {
order_id: '6735',
},
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
account = client.v1.accounts.update("acct_1PgafTB7WZ01zgkW", params={
"metadata": {
"order_id": "6735",
},
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
account = Stripe::Account.update('acct_1PgafTB7WZ01zgkW', {
metadata: {
order_id: '6735',
},
}){
"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 stringsSpecifies which fields in the response should be expanded.
Returns
The account object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const account = await stripe.accounts.retrieve('acct_1PgafTB7WZ01zgkW');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
account = client.v1.accounts.retrieve("acct_1PgafTB7WZ01zgkW")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
account = Stripe::Account.retrieve('acct_1PgafTB7WZ01zgkW'){
"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.
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const deletedAccount = await stripe.accounts.del('acct_1PgafTB7WZ01zgkW');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
deleted_account = client.v1.accounts.delete("acct_1PgafTB7WZ01zgkW")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
deleted_account = Stripe::Account.delete('acct_1PgafTB7WZ01zgkW'){
"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 | stringEither a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
Show 9 child parameters
account_numberstringRequiredcountrystringRequiredaccount_holder_namestringaccount_holder_typestringPossible valuescompanyindividual
account_typestringPossible valuescheckingfutsusavingstoza
currencystringdocumentsobjectShow 1 child parameter
bank_account_ownership_verificationobjectChild parameters are listed in the OpenAPI document.
objectstringPossible valuesbank_account
routing_numberstring
default_for_currencybooleanWhen 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 stringsSpecifies which fields in the response should be expanded.
external_accountstringA 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.
metadataobjectSet 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.
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts'){
"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 stringsSpecifies which fields in the response should be expanded.
Returns
A list of capability objects.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities'){
"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 | stringEither a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
Show 9 child parameters
account_numberstringRequiredcountrystringRequiredaccount_holder_namestringaccount_holder_typestringPossible valuescompanyindividual
account_typestringPossible valuescheckingfutsusavingstoza
currencystringdocumentsobjectShow 1 child parameter
bank_account_ownership_verificationobjectChild parameters are listed in the OpenAPI document.
objectstringPossible valuesbank_account
routing_numberstring
default_for_currencybooleanWhen 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 stringsSpecifies which fields in the response should be expanded.
external_accountstringA 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.
metadataobjectSet 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.
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts'){
"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_beforestringA cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.expandarray of stringsSpecifies which fields in the response should be expanded.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
objectstringFilter external accounts according to a particular object type.
Possible valuesbank_accountcard
starting_afterstringA cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
Returns
A list of bank_account objects.
curl -G https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
--data-urlencode limit=3const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts', {
limit: 3,
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts", limit=3)require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts', {
limit: 3,
}){
"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 login link
POST/v1/accounts/{account}/login_links
Creates a login link for a connected account to access the Express Dashboard. You can only create login links for accounts that use the Express Dashboard and are connected to your platform.
Path parameters
accountstringRequired
Body parameters
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The login_link object.
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/login_links \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/login_links');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/login_links")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/login_links'){
"created": 1234567890,
"object": "login_link",
"url": "https://sangeekp-15t6ai--manage-mydev.dev.stripe.me/express/acct_1PgafTB7WZ01zgkW/ehJImT2clfHr"
}Create a person
POST/v1/accounts/{account}/people
Creates a new person.
Path parameters
accountstringRequired
Body parameters
additional_tos_acceptancesobjectDetails on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
Show 1 child parameter
accountobjectShow 3 child parameters
dateintegeripstringuser_agentstring
addressobjectThe person's address.
Show 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
address_kanaobjectThe Kana variation of the person's address (Japan only).
Show 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
address_kanjiobjectThe Kanji variation of the person's address (Japan only).
Show 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
dobobjectThe person's date of birth.
Show 3 child parameters
dayintegerRequiredmonthintegerRequiredyearintegerRequired
documentsobjectDocuments that may be submitted to satisfy various informational requests.
Show 3 child parameters
company_authorizationobjectShow 1 child parameter
filesarray of strings
passportobjectShow 1 child parameter
filesarray of strings
visaobjectShow 1 child parameter
filesarray of strings
emailstringThe person's email address.
expandarray of stringsSpecifies which fields in the response should be expanded.
first_namestringThe person's first name.
first_name_kanastringThe Kana variation of the person's first name (Japan only).
first_name_kanjistringThe Kanji variation of the person's first name (Japan only).
full_name_aliasesarray of stringsA list of alternate names or aliases that the person is known by.
genderstringThe person's gender (International regulations require either "male" or "female").
id_numberstringThe 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_secondarystringThe 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_namestringThe person's last name.
last_name_kanastringThe Kana variation of the person's last name (Japan only).
last_name_kanjistringThe Kanji variation of the person's last name (Japan only).
maiden_namestringThe person's maiden name.
metadataobjectSet 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.nationalitystringThe country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.
person_tokenstringA person token, used to securely provide details to the person.
phonestringThe person's phone number.
political_exposurestringIndicates 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 valuesexistingnone
registered_addressobjectThe person's registered address.
Show 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
relationshipobjectThe relationship that this person has with the account's legal entity.
Show 8 child parameters
authorizerbooleandirectorbooleanexecutivebooleanlegal_guardianbooleanownerbooleanpercent_ownershipnumberrepresentativebooleantitlestring
ssn_last_4stringThe 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_dataobjectDemographic data related to the person.
Show 3 child parameters
ethnicity_detailsobjectShow 2 child parameters
ethnicityarray of stringsethnicity_otherstring
race_detailsobjectShow 2 child parameters
racearray of stringsrace_otherstring
self_identified_genderstring
verificationobjectThe person's verification status.
Show 2 child parameters
additional_documentobjectShow 2 child parameters
backstringfrontstring
documentobjectShow 2 child parameters
backstringfrontstring
Returns
The person object.
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/people');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/people")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/people'){
"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_beforestringA cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.expandarray of stringsSpecifies which fields in the response should be expanded.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
relationshipobjectFilters on the list of people returned based on the person's relationship to the account's company.
Show 6 child parameters
authorizerbooleandirectorbooleanexecutivebooleanlegal_guardianbooleanownerbooleanrepresentativeboolean
starting_afterstringA cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
Returns
A list of person objects.
curl -G https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
--data-urlencode limit=3const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/accounts/acct_1PgafTB7WZ01zgkW/people', {
limit: 3,
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/accounts/acct_1PgafTB7WZ01zgkW/people", limit=3)require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/accounts/acct_1PgafTB7WZ01zgkW/people', {
limit: 3,
}){
"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_acceptancesobjectDetails on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
Show 1 child parameter
accountobjectShow 3 child parameters
dateintegeripstringuser_agentstring
addressobjectThe person's address.
Show 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
address_kanaobjectThe Kana variation of the person's address (Japan only).
Show 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
address_kanjiobjectThe Kanji variation of the person's address (Japan only).
Show 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
dobobjectThe person's date of birth.
Show 3 child parameters
dayintegerRequiredmonthintegerRequiredyearintegerRequired
documentsobjectDocuments that may be submitted to satisfy various informational requests.
Show 3 child parameters
company_authorizationobjectShow 1 child parameter
filesarray of strings
passportobjectShow 1 child parameter
filesarray of strings
visaobjectShow 1 child parameter
filesarray of strings
emailstringThe person's email address.
expandarray of stringsSpecifies which fields in the response should be expanded.
first_namestringThe person's first name.
first_name_kanastringThe Kana variation of the person's first name (Japan only).
first_name_kanjistringThe Kanji variation of the person's first name (Japan only).
full_name_aliasesarray of stringsA list of alternate names or aliases that the person is known by.
genderstringThe person's gender (International regulations require either "male" or "female").
id_numberstringThe 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_secondarystringThe 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_namestringThe person's last name.
last_name_kanastringThe Kana variation of the person's last name (Japan only).
last_name_kanjistringThe Kanji variation of the person's last name (Japan only).
maiden_namestringThe person's maiden name.
metadataobjectSet 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.nationalitystringThe country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.
person_tokenstringA person token, used to securely provide details to the person.
phonestringThe person's phone number.
political_exposurestringIndicates 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 valuesexistingnone
registered_addressobjectThe person's registered address.
Show 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
relationshipobjectThe relationship that this person has with the account's legal entity.
Show 8 child parameters
authorizerbooleandirectorbooleanexecutivebooleanlegal_guardianbooleanownerbooleanpercent_ownershipnumberrepresentativebooleantitlestring
ssn_last_4stringThe 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_dataobjectDemographic data related to the person.
Show 3 child parameters
ethnicity_detailsobjectShow 2 child parameters
ethnicityarray of stringsethnicity_otherstring
race_detailsobjectShow 2 child parameters
racearray of stringsrace_otherstring
self_identified_genderstring
verificationobjectThe person's verification status.
Show 2 child parameters
additional_documentobjectShow 2 child parameters
backstringfrontstring
documentobjectShow 2 child parameters
backstringfrontstring
Returns
The person object.
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/persons")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons'){
"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_beforestringA cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.expandarray of stringsSpecifies which fields in the response should be expanded.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
relationshipobjectFilters on the list of people returned based on the person's relationship to the account's company.
Show 6 child parameters
authorizerbooleandirectorbooleanexecutivebooleanlegal_guardianbooleanownerbooleanrepresentativeboolean
starting_afterstringA cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
Returns
A list of person objects.
curl -G https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
--data-urlencode limit=3const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons', {
limit: 3,
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/accounts/acct_1PgafTB7WZ01zgkW/persons", limit=3)require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons', {
limit: 3,
}){
"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
reasonstringRequiredThe reason for rejecting the account. Can be
fraud,terms_of_service, orother.expandarray of stringsSpecifies which fields in the response should be expanded.
payouts_actionstringWhether to pause payouts on the account as part of the rejection. Defaults to
pause. Usenoneto leave payouts enabled.Possible valuesnonepause
Returns
The account object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/reject \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
-d reason=exampleconst Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const account = await stripe.accounts.reject('acct_1PgafTB7WZ01zgkW', {
reason: 'example',
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
account = client.v1.accounts.reject("acct_1PgafTB7WZ01zgkW", params={
"reason": "example",
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
account = Stripe::Account.reject('acct_1PgafTB7WZ01zgkW', {
reason: 'example',
}){
"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 stringsSpecifies which fields in the response should be expanded.
Returns
The account object.
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/unreject \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const account = await stripe.accounts.unreject('acct_1PgafTB7WZ01zgkW');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
account = client.v1.accounts.unreject("acct_1PgafTB7WZ01zgkW")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
account = Stripe::Account.unreject('acct_1PgafTB7WZ01zgkW'){
"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
accountstringRequiredidstringRequired
Body parameters
account_holder_namestringThe name of the person or business that owns the bank account.
account_holder_typestringThe type of entity that holds the account. This can be either
individualorcompany.Possible valuescompanyindividual
account_typestringThe bank account type. This can only be
checkingorsavingsin most countries. In Japan, this can only befutsuortoza.Possible valuescheckingfutsusavingstoza
address_citystringCity/District/Suburb/Town/Village.
address_countrystringBilling address country, if provided when creating card.
address_line1stringAddress line 1 (Street address/PO Box/Company name).
address_line2stringAddress line 2 (Apartment/Suite/Unit/Building).
address_statestringState/County/Province/Region.
address_zipstringZIP or postal code.
default_for_currencybooleanWhen set to true, this becomes the default external account for its currency.
documentsobjectDocuments that may be submitted to satisfy various informational requests.
Show 1 child parameter
bank_account_ownership_verificationobjectShow 1 child parameter
filesarray of strings
exp_monthstringTwo digit number representing the card’s expiration month.
exp_yearstringFour digit number representing the card’s expiration year.
expandarray of stringsSpecifies which fields in the response should be expanded.
metadataobjectSet 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.namestringCardholder name.
Returns
The external_account object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
-d "metadata[order_id]=6735"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q', {
metadata: {
order_id: '6735',
},
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q", metadata={
"order_id": "6735",
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q', {
metadata: {
order_id: '6735',
},
}){
"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
accountstringRequiredidstringRequiredUnique identifier for the external account to be retrieved.
Query parameters
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The external_account object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q'){
"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
accountstringRequiredidstringRequiredUnique identifier for the external account to be deleted.
Returns
The deleted_external_account object.
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('DELETE', '/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("delete", "/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:delete, '/v1/accounts/acct_1PgafTB7WZ01zgkW/bank_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q'){
"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
accountstringRequiredcapabilitystringRequired
Body parameters
expandarray of stringsSpecifies which fields in the response should be expanded.
requestedbooleanTo 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
requirementsarrays. 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.
curl -X POST https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments'){
"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
accountstringRequiredcapabilitystringRequired
Query parameters
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The capability object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/accounts/acct_1PgafTB7WZ01zgkW/capabilities/card_payments'){
"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
accountstringRequiredidstringRequired
Body parameters
account_holder_namestringThe name of the person or business that owns the bank account.
account_holder_typestringThe type of entity that holds the account. This can be either
individualorcompany.Possible valuescompanyindividual
account_typestringThe bank account type. This can only be
checkingorsavingsin most countries. In Japan, this can only befutsuortoza.Possible valuescheckingfutsusavingstoza
address_citystringCity/District/Suburb/Town/Village.
address_countrystringBilling address country, if provided when creating card.
address_line1stringAddress line 1 (Street address/PO Box/Company name).
address_line2stringAddress line 2 (Apartment/Suite/Unit/Building).
address_statestringState/County/Province/Region.
address_zipstringZIP or postal code.
default_for_currencybooleanWhen set to true, this becomes the default external account for its currency.
documentsobjectDocuments that may be submitted to satisfy various informational requests.
Show 1 child parameter
bank_account_ownership_verificationobjectShow 1 child parameter
filesarray of strings
exp_monthstringTwo digit number representing the card’s expiration month.
exp_yearstringFour digit number representing the card’s expiration year.
expandarray of stringsSpecifies which fields in the response should be expanded.
metadataobjectSet 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.namestringCardholder name.
Returns
The external_account object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
-d "metadata[order_id]=6735"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q', {
metadata: {
order_id: '6735',
},
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q", metadata={
"order_id": "6735",
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q', {
metadata: {
order_id: '6735',
},
}){
"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
accountstringRequiredidstringRequiredUnique identifier for the external account to be retrieved.
Query parameters
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The external_account object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q'){
"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
accountstringRequiredidstringRequiredUnique identifier for the external account to be deleted.
Returns
The deleted_external_account object.
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('DELETE', '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("delete", "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:delete, '/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts/ba_1PgagAB7WZ01zgkWr3DySp2Q'){
"deleted": true,
"id": "ba_1PgagAB7WZ01zgkWr3DySp2Q",
"object": "bank_account"
}Update a person
POST/v1/accounts/{account}/people/{person}
Updates an existing person.
Path parameters
accountstringRequiredpersonstringRequired
Body parameters
additional_tos_acceptancesobjectDetails on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
Show 1 child parameter
accountobjectShow 3 child parameters
dateintegeripstringuser_agentstring
addressobjectThe person's address.
Show 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
address_kanaobjectThe Kana variation of the person's address (Japan only).
Show 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
address_kanjiobjectThe Kanji variation of the person's address (Japan only).
Show 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
dobobjectThe person's date of birth.
Show 3 child parameters
dayintegerRequiredmonthintegerRequiredyearintegerRequired
documentsobjectDocuments that may be submitted to satisfy various informational requests.
Show 3 child parameters
company_authorizationobjectShow 1 child parameter
filesarray of strings
passportobjectShow 1 child parameter
filesarray of strings
visaobjectShow 1 child parameter
filesarray of strings
emailstringThe person's email address.
expandarray of stringsSpecifies which fields in the response should be expanded.
first_namestringThe person's first name.
first_name_kanastringThe Kana variation of the person's first name (Japan only).
first_name_kanjistringThe Kanji variation of the person's first name (Japan only).
full_name_aliasesarray of stringsA list of alternate names or aliases that the person is known by.
genderstringThe person's gender (International regulations require either "male" or "female").
id_numberstringThe 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_secondarystringThe 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_namestringThe person's last name.
last_name_kanastringThe Kana variation of the person's last name (Japan only).
last_name_kanjistringThe Kanji variation of the person's last name (Japan only).
maiden_namestringThe person's maiden name.
metadataobjectSet 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.nationalitystringThe country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.
person_tokenstringA person token, used to securely provide details to the person.
phonestringThe person's phone number.
political_exposurestringIndicates 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 valuesexistingnone
registered_addressobjectThe person's registered address.
Show 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
relationshipobjectThe relationship that this person has with the account's legal entity.
Show 8 child parameters
authorizerbooleandirectorbooleanexecutivebooleanlegal_guardianbooleanownerbooleanpercent_ownershipnumberrepresentativebooleantitlestring
ssn_last_4stringThe 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_dataobjectDemographic data related to the person.
Show 3 child parameters
ethnicity_detailsobjectShow 2 child parameters
ethnicityarray of stringsethnicity_otherstring
race_detailsobjectShow 2 child parameters
racearray of stringsrace_otherstring
self_identified_genderstring
verificationobjectThe person's verification status.
Show 2 child parameters
additional_documentobjectShow 2 child parameters
backstringfrontstring
documentobjectShow 2 child parameters
backstringfrontstring
Returns
The person object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
-d "metadata[order_id]=6735"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS', {
metadata: {
order_id: '6735',
},
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS", metadata={
"order_id": "6735",
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS', {
metadata: {
order_id: '6735',
},
}){
"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
accountstringRequiredpersonstringRequired
Query parameters
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The person object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS'){
"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
accountstringRequiredpersonstringRequired
Returns
The deleted_person object.
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('DELETE', '/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("delete", "/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:delete, '/v1/accounts/acct_1PgafTB7WZ01zgkW/people/person_1Pgc6oB7WZ01zgkWnmLL70wS'){
"deleted": true,
"id": "person_1Pgc6oB7WZ01zgkWnmLL70wS",
"object": "person"
}Update a person
POST/v1/accounts/{account}/persons/{person}
Updates an existing person.
Path parameters
accountstringRequiredpersonstringRequired
Body parameters
additional_tos_acceptancesobjectDetails on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
Show 1 child parameter
accountobjectShow 3 child parameters
dateintegeripstringuser_agentstring
addressobjectThe person's address.
Show 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
address_kanaobjectThe Kana variation of the person's address (Japan only).
Show 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
address_kanjiobjectThe Kanji variation of the person's address (Japan only).
Show 7 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestringtownstring
dobobjectThe person's date of birth.
Show 3 child parameters
dayintegerRequiredmonthintegerRequiredyearintegerRequired
documentsobjectDocuments that may be submitted to satisfy various informational requests.
Show 3 child parameters
company_authorizationobjectShow 1 child parameter
filesarray of strings
passportobjectShow 1 child parameter
filesarray of strings
visaobjectShow 1 child parameter
filesarray of strings
emailstringThe person's email address.
expandarray of stringsSpecifies which fields in the response should be expanded.
first_namestringThe person's first name.
first_name_kanastringThe Kana variation of the person's first name (Japan only).
first_name_kanjistringThe Kanji variation of the person's first name (Japan only).
full_name_aliasesarray of stringsA list of alternate names or aliases that the person is known by.
genderstringThe person's gender (International regulations require either "male" or "female").
id_numberstringThe 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_secondarystringThe 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_namestringThe person's last name.
last_name_kanastringThe Kana variation of the person's last name (Japan only).
last_name_kanjistringThe Kanji variation of the person's last name (Japan only).
maiden_namestringThe person's maiden name.
metadataobjectSet 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.nationalitystringThe country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.
person_tokenstringA person token, used to securely provide details to the person.
phonestringThe person's phone number.
political_exposurestringIndicates 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 valuesexistingnone
registered_addressobjectThe person's registered address.
Show 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
relationshipobjectThe relationship that this person has with the account's legal entity.
Show 8 child parameters
authorizerbooleandirectorbooleanexecutivebooleanlegal_guardianbooleanownerbooleanpercent_ownershipnumberrepresentativebooleantitlestring
ssn_last_4stringThe 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_dataobjectDemographic data related to the person.
Show 3 child parameters
ethnicity_detailsobjectShow 2 child parameters
ethnicityarray of stringsethnicity_otherstring
race_detailsobjectShow 2 child parameters
racearray of stringsrace_otherstring
self_identified_genderstring
verificationobjectThe person's verification status.
Show 2 child parameters
additional_documentobjectShow 2 child parameters
backstringfrontstring
documentobjectShow 2 child parameters
backstringfrontstring
Returns
The person object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
-d "metadata[order_id]=6735"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS', {
metadata: {
order_id: '6735',
},
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS", metadata={
"order_id": "6735",
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS', {
metadata: {
order_id: '6735',
},
}){
"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
accountstringRequiredpersonstringRequired
Query parameters
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The person object.
curl https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS'){
"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
accountstringRequiredpersonstringRequired
Returns
The deleted_person object.
curl -X DELETE https://api.knoxapi.com/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('DELETE', '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("delete", "/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:delete, '/v1/accounts/acct_1PgafTB7WZ01zgkW/persons/person_1Pgc6oB7WZ01zgkWnmLL70wS'){
"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.