stripe 20.0.0 → 20.1.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (315) hide show
  1. package/CHANGELOG.md +1503 -11
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +1 -0
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +115 -1
  6. package/cjs/apiVersion.js +2 -3
  7. package/cjs/resources/AccountNotices.js +21 -0
  8. package/cjs/resources/Billing/Analytics/MeterUsage.js +12 -0
  9. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  10. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  11. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  12. package/cjs/resources/ExternalAccounts.js +23 -0
  13. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  14. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  15. package/cjs/resources/FxQuotes.js +15 -0
  16. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  17. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  18. package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
  19. package/cjs/resources/Mandates.js +5 -0
  20. package/cjs/resources/Margins.js +22 -0
  21. package/cjs/resources/Orders.js +24 -0
  22. package/cjs/resources/PaymentIntents.js +8 -0
  23. package/cjs/resources/Privacy/RedactionJobs.js +42 -0
  24. package/cjs/resources/Quotes.js +32 -0
  25. package/cjs/resources/SubscriptionSchedules.js +4 -0
  26. package/cjs/resources/Subscriptions.js +4 -0
  27. package/cjs/resources/Tax/Forms.js +20 -0
  28. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  29. package/cjs/resources/V2/Billing/BillSettings/Versions.js +17 -0
  30. package/cjs/resources/V2/Billing/BillSettings.js +27 -0
  31. package/cjs/resources/V2/Billing/Cadences.js +23 -0
  32. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +17 -0
  33. package/cjs/resources/V2/Billing/CollectionSettings.js +30 -0
  34. package/cjs/resources/V2/Billing/Profiles.js +19 -0
  35. package/cjs/resources/V2/Core/AccountLinks.js +9 -0
  36. package/cjs/resources/V2/Core/AccountTokens.js +13 -0
  37. package/cjs/resources/V2/Core/Accounts/PersonTokens.js +16 -0
  38. package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
  39. package/cjs/resources/V2/Core/Accounts.js +27 -0
  40. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +33 -0
  41. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +37 -0
  42. package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
  43. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +29 -0
  44. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
  45. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
  46. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
  47. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
  48. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
  49. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
  50. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
  51. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
  52. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
  53. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
  54. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
  55. package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
  56. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
  57. package/cjs/resources.js +100 -8
  58. package/cjs/stripe.core.js +1 -1
  59. package/esm/Error.js +100 -0
  60. package/esm/apiVersion.js +1 -2
  61. package/esm/resources/AccountNotices.js +18 -0
  62. package/esm/resources/Billing/Analytics/MeterUsage.js +9 -0
  63. package/esm/resources/Capital/FinancingOffers.js +18 -0
  64. package/esm/resources/Capital/FinancingSummary.js +9 -0
  65. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  66. package/esm/resources/ExternalAccounts.js +20 -0
  67. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  68. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  69. package/esm/resources/FxQuotes.js +12 -0
  70. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  71. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  72. package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
  73. package/esm/resources/Mandates.js +5 -0
  74. package/esm/resources/Margins.js +19 -0
  75. package/esm/resources/Orders.js +21 -0
  76. package/esm/resources/PaymentIntents.js +8 -0
  77. package/esm/resources/Privacy/RedactionJobs.js +39 -0
  78. package/esm/resources/Quotes.js +32 -0
  79. package/esm/resources/SubscriptionSchedules.js +4 -0
  80. package/esm/resources/Subscriptions.js +4 -0
  81. package/esm/resources/Tax/Forms.js +17 -0
  82. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  83. package/esm/resources/V2/Billing/BillSettings/Versions.js +14 -0
  84. package/esm/resources/V2/Billing/BillSettings.js +24 -0
  85. package/esm/resources/V2/Billing/Cadences.js +20 -0
  86. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +14 -0
  87. package/esm/resources/V2/Billing/CollectionSettings.js +27 -0
  88. package/esm/resources/V2/Billing/Profiles.js +16 -0
  89. package/esm/resources/V2/Core/AccountLinks.js +6 -0
  90. package/esm/resources/V2/Core/AccountTokens.js +10 -0
  91. package/esm/resources/V2/Core/Accounts/PersonTokens.js +13 -0
  92. package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
  93. package/esm/resources/V2/Core/Accounts.js +24 -0
  94. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +30 -0
  95. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +34 -0
  96. package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
  97. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +26 -0
  98. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
  99. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
  100. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
  101. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
  102. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
  103. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
  104. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
  105. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
  106. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
  107. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
  108. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
  109. package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
  110. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
  111. package/esm/resources.js +87 -0
  112. package/esm/stripe.core.js +1 -1
  113. package/package.json +1 -1
  114. package/types/AccountLinksResource.d.ts +5 -1
  115. package/types/AccountNotices.d.ts +113 -0
  116. package/types/AccountNoticesResource.d.ts +98 -0
  117. package/types/AccountSessions.d.ts +45 -0
  118. package/types/AccountSessionsResource.d.ts +264 -0
  119. package/types/Accounts.d.ts +232 -1
  120. package/types/AccountsResource.d.ts +586 -0
  121. package/types/BankAccounts.d.ts +2 -0
  122. package/types/Billing/AlertTriggereds.d.ts +1 -1
  123. package/types/Billing/Analytics/MeterUsage.d.ts +31 -0
  124. package/types/Billing/Analytics/MeterUsageResource.d.ts +689 -0
  125. package/types/Billing/Analytics/MeterUsageRows.d.ts +51 -0
  126. package/types/Billing/CreditBalanceSummary.d.ts +5 -0
  127. package/types/Billing/CreditBalanceSummaryResource.d.ts +8 -3
  128. package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
  129. package/types/Billing/CreditGrants.d.ts +5 -0
  130. package/types/Billing/CreditGrantsResource.d.ts +13 -3
  131. package/types/BillingPortal/Sessions.d.ts +5 -0
  132. package/types/BillingPortal/SessionsResource.d.ts +12 -4
  133. package/types/Capabilities.d.ts +2 -0
  134. package/types/Capital/FinancingOffers.d.ts +188 -0
  135. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  136. package/types/Capital/FinancingSummary.d.ts +106 -0
  137. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  138. package/types/Capital/FinancingTransactions.d.ts +135 -0
  139. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  140. package/types/Cards.d.ts +5 -0
  141. package/types/CashBalances.d.ts +5 -0
  142. package/types/Charges.d.ts +176 -0
  143. package/types/ChargesResource.d.ts +3855 -75
  144. package/types/Checkout/Sessions.d.ts +369 -2
  145. package/types/Checkout/SessionsResource.d.ts +632 -2
  146. package/types/ConfirmationTokens.d.ts +125 -0
  147. package/types/Coupons.d.ts +35 -0
  148. package/types/CouponsResource.d.ts +23 -0
  149. package/types/CreditNoteLineItems.d.ts +17 -0
  150. package/types/CreditNotes.d.ts +5 -0
  151. package/types/CreditNotesResource.d.ts +5 -0
  152. package/types/CustomerBalanceTransactions.d.ts +2 -0
  153. package/types/CustomerCashBalanceTransactions.d.ts +2 -0
  154. package/types/CustomerSessions.d.ts +46 -0
  155. package/types/CustomerSessionsResource.d.ts +47 -1
  156. package/types/Customers.d.ts +2 -0
  157. package/types/CustomersResource.d.ts +8 -0
  158. package/types/Discounts.d.ts +10 -0
  159. package/types/Disputes.d.ts +40 -0
  160. package/types/DisputesResource.d.ts +11 -0
  161. package/types/Errors.d.ts +85 -0
  162. package/types/EventTypes.d.ts +630 -0
  163. package/types/Events.d.ts +96 -0
  164. package/types/ExternalAccountsResource.d.ts +304 -0
  165. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  166. package/types/FinancialConnections/Accounts.d.ts +36 -1
  167. package/types/FinancialConnections/AccountsResource.d.ts +40 -3
  168. package/types/FinancialConnections/Institutions.d.ts +98 -0
  169. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  170. package/types/FinancialConnections/Sessions.d.ts +51 -1
  171. package/types/FinancialConnections/SessionsResource.d.ts +43 -1
  172. package/types/FxQuotes.d.ts +155 -0
  173. package/types/FxQuotesResource.d.ts +130 -0
  174. package/types/Identity/VerificationSessions.d.ts +5 -0
  175. package/types/Identity/VerificationSessionsResource.d.ts +7 -0
  176. package/types/InvoiceItems.d.ts +10 -0
  177. package/types/InvoiceItemsResource.d.ts +117 -6
  178. package/types/InvoiceLineItems.d.ts +45 -1
  179. package/types/Invoices.d.ts +203 -4
  180. package/types/InvoicesResource.d.ts +1620 -2
  181. package/types/Issuing/CardholdersResource.d.ts +2 -1
  182. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  183. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  184. package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
  185. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  186. package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
  187. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
  188. package/types/Issuing/Settlements.d.ts +113 -0
  189. package/types/Issuing/Transactions.d.ts +5 -0
  190. package/types/Issuing/TransactionsResource.d.ts +5 -0
  191. package/types/LineItems.d.ts +49 -0
  192. package/types/Mandates.d.ts +135 -1
  193. package/types/MandatesResource.d.ts +31 -0
  194. package/types/Margins.d.ts +56 -0
  195. package/types/MarginsResource.d.ts +114 -0
  196. package/types/Orders.d.ts +1163 -0
  197. package/types/OrdersResource.d.ts +5505 -0
  198. package/types/PaymentAttemptRecords.d.ts +141 -0
  199. package/types/PaymentIntents.d.ts +752 -3
  200. package/types/PaymentIntentsResource.d.ts +19244 -6298
  201. package/types/PaymentLinks.d.ts +6 -0
  202. package/types/PaymentLinksResource.d.ts +12 -0
  203. package/types/PaymentMethodConfigurations.d.ts +216 -0
  204. package/types/PaymentMethodConfigurationsResource.d.ts +300 -0
  205. package/types/PaymentMethods.d.ts +130 -0
  206. package/types/PaymentMethodsResource.d.ts +179 -2
  207. package/types/PaymentRecords.d.ts +141 -0
  208. package/types/Persons.d.ts +2 -0
  209. package/types/Prices.d.ts +22 -0
  210. package/types/PricesResource.d.ts +22 -0
  211. package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
  212. package/types/Privacy/RedactionJobs.d.ts +111 -0
  213. package/types/Privacy/RedactionJobsResource.d.ts +230 -0
  214. package/types/PromotionCodes.d.ts +5 -0
  215. package/types/PromotionCodesResource.d.ts +10 -0
  216. package/types/QuoteLines.d.ts +634 -0
  217. package/types/QuotePreviewInvoices.d.ts +1771 -0
  218. package/types/QuotePreviewSubscriptionSchedules.d.ts +908 -0
  219. package/types/Quotes.d.ts +594 -1
  220. package/types/QuotesResource.d.ts +2588 -243
  221. package/types/Refunds.d.ts +14 -0
  222. package/types/SetupAttempts.d.ts +51 -1
  223. package/types/SetupIntents.d.ts +218 -2
  224. package/types/SetupIntentsResource.d.ts +954 -4
  225. package/types/Sources.d.ts +29 -0
  226. package/types/SubscriptionItems.d.ts +26 -0
  227. package/types/SubscriptionItemsResource.d.ts +109 -0
  228. package/types/SubscriptionSchedules.d.ts +205 -0
  229. package/types/SubscriptionSchedulesResource.d.ts +1233 -5
  230. package/types/Subscriptions.d.ts +262 -1
  231. package/types/SubscriptionsResource.d.ts +745 -8
  232. package/types/Tax/Forms.d.ts +220 -0
  233. package/types/Tax/FormsResource.d.ts +107 -0
  234. package/types/TaxIds.d.ts +10 -0
  235. package/types/TaxIdsResource.d.ts +10 -0
  236. package/types/Terminal/Configurations.d.ts +9 -0
  237. package/types/Terminal/ConfigurationsResource.d.ts +28 -0
  238. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  239. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  240. package/types/Terminal/Readers.d.ts +20 -0
  241. package/types/TestHelpers/ConfirmationTokensResource.d.ts +126 -0
  242. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  243. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  244. package/types/Transfers.d.ts +5 -0
  245. package/types/TransfersResource.d.ts +5 -0
  246. package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
  247. package/types/Treasury/FinancialAccounts.d.ts +5 -0
  248. package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
  249. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  250. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  251. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  252. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  253. package/types/V2/Billing/BillSettingVersions.d.ts +97 -0
  254. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +58 -0
  255. package/types/V2/Billing/BillSettings.d.ts +120 -0
  256. package/types/V2/Billing/BillSettingsResource.d.ts +241 -0
  257. package/types/V2/Billing/Cadences.d.ts +690 -0
  258. package/types/V2/Billing/CadencesResource.d.ts +487 -0
  259. package/types/V2/Billing/CollectionSettingVersions.d.ts +318 -0
  260. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
  261. package/types/V2/Billing/CollectionSettings.d.ts +341 -0
  262. package/types/V2/Billing/CollectionSettingsResource.d.ts +683 -0
  263. package/types/V2/Billing/Profiles.d.ts +70 -0
  264. package/types/V2/Billing/ProfilesResource.d.ts +150 -0
  265. package/types/V2/Core/AccountLinks.d.ts +168 -0
  266. package/types/V2/Core/AccountLinksResource.d.ts +152 -0
  267. package/types/V2/Core/AccountPersonTokens.d.ts +44 -0
  268. package/types/V2/Core/AccountPersons.d.ts +616 -0
  269. package/types/V2/Core/AccountTokens.d.ts +44 -0
  270. package/types/V2/Core/AccountTokensResource.d.ts +1042 -0
  271. package/types/V2/Core/Accounts/PersonTokensResource.d.ts +509 -0
  272. package/types/V2/Core/Accounts/PersonsResource.d.ts +1165 -0
  273. package/types/V2/Core/Accounts.d.ts +6513 -0
  274. package/types/V2/Core/AccountsResource.d.ts +5322 -0
  275. package/types/V2/Core/EventTypes.d.ts +1541 -9
  276. package/types/V2/Core/Events.d.ts +9 -0
  277. package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
  278. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +194 -0
  279. package/types/V2/Core/Vault/UsBankAccounts.d.ts +116 -0
  280. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +198 -0
  281. package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
  282. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +32 -0
  283. package/types/V2/MoneyManagement/Adjustments.d.ts +110 -0
  284. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
  285. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +148 -0
  286. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +172 -0
  287. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +175 -0
  288. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +109 -0
  289. package/types/V2/MoneyManagement/InboundTransfers.d.ts +212 -0
  290. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
  291. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +170 -0
  292. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
  293. package/types/V2/MoneyManagement/OutboundPayments.d.ts +278 -0
  294. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +242 -0
  295. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
  296. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +296 -0
  297. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +251 -0
  298. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +208 -0
  299. package/types/V2/MoneyManagement/PayoutMethods.d.ts +160 -0
  300. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +93 -0
  301. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
  302. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
  303. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +302 -0
  304. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
  305. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +176 -0
  306. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
  307. package/types/V2/MoneyManagement/TransactionEntries.d.ts +162 -0
  308. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
  309. package/types/V2/MoneyManagement/Transactions.d.ts +177 -0
  310. package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
  311. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +68 -0
  312. package/types/WebhookEndpointsResource.d.ts +76 -0
  313. package/types/apiVersion.d.ts +1 -2
  314. package/types/index.d.ts +147 -0
  315. package/types/lib.d.ts +10 -0
@@ -0,0 +1,1042 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace V2 {
6
+ namespace Core {
7
+ interface AccountTokenCreateParams {
8
+ /**
9
+ * Information about the company, individual, and business represented by the Account.
10
+ */
11
+ identity: AccountTokenCreateParams.Identity;
12
+
13
+ /**
14
+ * The default contact email address for the Account. Required when configuring the account as a merchant or recipient.
15
+ */
16
+ contact_email?: string;
17
+
18
+ /**
19
+ * A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.
20
+ */
21
+ display_name?: string;
22
+ }
23
+
24
+ namespace AccountTokenCreateParams {
25
+ interface Identity {
26
+ /**
27
+ * Attestations from the identity's key people, e.g. owners, executives, directors, representatives.
28
+ */
29
+ attestations?: Identity.Attestations;
30
+
31
+ /**
32
+ * Information about the company or business.
33
+ */
34
+ business_details?: Identity.BusinessDetails;
35
+
36
+ /**
37
+ * The entity type.
38
+ */
39
+ entity_type?: Identity.EntityType;
40
+
41
+ /**
42
+ * Information about the person represented by the account.
43
+ */
44
+ individual?: Identity.Individual;
45
+ }
46
+
47
+ namespace Identity {
48
+ interface Attestations {
49
+ /**
50
+ * This hash is used to attest that the directors information provided to Stripe is both current and correct; IP, date, and User Agent are expanded by Stripe.
51
+ */
52
+ directorship_declaration?: Attestations.DirectorshipDeclaration;
53
+
54
+ /**
55
+ * This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct; IP, date, and User Agent are expanded by Stripe.
56
+ */
57
+ ownership_declaration?: Attestations.OwnershipDeclaration;
58
+
59
+ /**
60
+ * Attestation that all Persons with a specific Relationship value have been provided.
61
+ */
62
+ persons_provided?: Attestations.PersonsProvided;
63
+
64
+ /**
65
+ * This hash is used to attest that the representative is authorized to act as the representative of their legal entity; IP, date, and User Agent are expanded by Stripe.
66
+ */
67
+ representative_declaration?: Attestations.RepresentativeDeclaration;
68
+
69
+ /**
70
+ * Attestations of accepted terms of service agreements.
71
+ */
72
+ terms_of_service?: Attestations.TermsOfService;
73
+ }
74
+
75
+ namespace Attestations {
76
+ interface DirectorshipDeclaration {
77
+ /**
78
+ * A boolean indicating if the directors information has been attested.
79
+ */
80
+ attested?: boolean;
81
+ }
82
+
83
+ interface OwnershipDeclaration {
84
+ /**
85
+ * A boolean indicating if the beneficial owner information has been attested.
86
+ */
87
+ attested?: boolean;
88
+ }
89
+
90
+ interface PersonsProvided {
91
+ /**
92
+ * Whether the company's directors have been provided. Set this Boolean to true after creating all the company's directors with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
93
+ */
94
+ directors?: boolean;
95
+
96
+ /**
97
+ * Whether the company's executives have been provided. Set this Boolean to true after creating all the company's executives with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
98
+ */
99
+ executives?: boolean;
100
+
101
+ /**
102
+ * Whether the company's owners have been provided. Set this Boolean to true after creating all the company's owners with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
103
+ */
104
+ owners?: boolean;
105
+
106
+ /**
107
+ * Reason for why the company is exempt from providing ownership information.
108
+ */
109
+ ownership_exemption_reason?: PersonsProvided.OwnershipExemptionReason;
110
+ }
111
+
112
+ namespace PersonsProvided {
113
+ type OwnershipExemptionReason =
114
+ | 'qualified_entity_exceeds_ownership_threshold'
115
+ | 'qualifies_as_financial_institution';
116
+ }
117
+
118
+ interface RepresentativeDeclaration {
119
+ /**
120
+ * A boolean indicating if the representative is authorized to act as the representative of their legal entity.
121
+ */
122
+ attested?: boolean;
123
+ }
124
+
125
+ interface TermsOfService {
126
+ /**
127
+ * Details on the Account's acceptance of the [Stripe Services Agreement]; IP, date, and User Agent are expanded by Stripe.
128
+ */
129
+ account?: TermsOfService.Account;
130
+
131
+ /**
132
+ * Details on the Account's acceptance of Treasury-specific terms of service; IP, date, and User Agent are expanded by Stripe.
133
+ */
134
+ storer?: TermsOfService.Storer;
135
+ }
136
+
137
+ namespace TermsOfService {
138
+ interface Account {
139
+ /**
140
+ * The boolean value indicating if the terms of service have been accepted.
141
+ */
142
+ shown_and_accepted?: boolean;
143
+ }
144
+
145
+ interface Storer {
146
+ /**
147
+ * The boolean value indicating if the terms of service have been accepted.
148
+ */
149
+ shown_and_accepted?: boolean;
150
+ }
151
+ }
152
+ }
153
+
154
+ interface BusinessDetails {
155
+ /**
156
+ * The business registration address of the business entity.
157
+ */
158
+ address?: Stripe.JapanAddressParam;
159
+
160
+ /**
161
+ * The business gross annual revenue for its preceding fiscal year.
162
+ */
163
+ annual_revenue?: BusinessDetails.AnnualRevenue;
164
+
165
+ /**
166
+ * A document verifying the business.
167
+ */
168
+ documents?: BusinessDetails.Documents;
169
+
170
+ /**
171
+ * An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
172
+ */
173
+ estimated_worker_count?: number;
174
+
175
+ /**
176
+ * The ID numbers of a business entity.
177
+ */
178
+ id_numbers?: Array<BusinessDetails.IdNumber>;
179
+
180
+ /**
181
+ * An estimate of the monthly revenue of the business.
182
+ */
183
+ monthly_estimated_revenue?: BusinessDetails.MonthlyEstimatedRevenue;
184
+
185
+ /**
186
+ * The phone number of the Business Entity.
187
+ */
188
+ phone?: string;
189
+
190
+ /**
191
+ * The business legal name.
192
+ */
193
+ registered_name?: string;
194
+
195
+ /**
196
+ * The business registration address of the business entity in non latin script.
197
+ */
198
+ script_addresses?: BusinessDetails.ScriptAddresses;
199
+
200
+ /**
201
+ * The business legal name in non latin script.
202
+ */
203
+ script_names?: BusinessDetails.ScriptNames;
204
+
205
+ /**
206
+ * The category identifying the legal structure of the business.
207
+ */
208
+ structure?: BusinessDetails.Structure;
209
+ }
210
+
211
+ namespace BusinessDetails {
212
+ interface AnnualRevenue {
213
+ /**
214
+ * A non-negative integer representing the amount in the smallest currency unit.
215
+ */
216
+ amount?: Amount;
217
+
218
+ /**
219
+ * The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
220
+ */
221
+ fiscal_year_end?: string;
222
+ }
223
+
224
+ interface Documents {
225
+ /**
226
+ * One or more documents that support the bank account ownership verification requirement. Must be a document associated with the account's primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
227
+ */
228
+ bank_account_ownership_verification?: Documents.BankAccountOwnershipVerification;
229
+
230
+ /**
231
+ * One or more documents that demonstrate proof of a company's license to operate.
232
+ */
233
+ company_license?: Documents.CompanyLicense;
234
+
235
+ /**
236
+ * One or more documents showing the company's Memorandum of Association.
237
+ */
238
+ company_memorandum_of_association?: Documents.CompanyMemorandumOfAssociation;
239
+
240
+ /**
241
+ * Certain countries only: One or more documents showing the ministerial decree legalizing the company's establishment.
242
+ */
243
+ company_ministerial_decree?: Documents.CompanyMinisterialDecree;
244
+
245
+ /**
246
+ * One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.
247
+ */
248
+ company_registration_verification?: Documents.CompanyRegistrationVerification;
249
+
250
+ /**
251
+ * One or more documents that demonstrate proof of a company's tax ID.
252
+ */
253
+ company_tax_id_verification?: Documents.CompanyTaxIdVerification;
254
+
255
+ /**
256
+ * A document verifying the business.
257
+ */
258
+ primary_verification?: Documents.PrimaryVerification;
259
+
260
+ /**
261
+ * One or more documents that demonstrate proof of address.
262
+ */
263
+ proof_of_address?: Documents.ProofOfAddress;
264
+
265
+ /**
266
+ * One or more documents showing the company's proof of registration with the national business registry.
267
+ */
268
+ proof_of_registration?: Documents.ProofOfRegistration;
269
+
270
+ /**
271
+ * One or more documents that demonstrate proof of ultimate beneficial ownership.
272
+ */
273
+ proof_of_ultimate_beneficial_ownership?: Documents.ProofOfUltimateBeneficialOwnership;
274
+ }
275
+
276
+ namespace Documents {
277
+ interface BankAccountOwnershipVerification {
278
+ /**
279
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
280
+ */
281
+ files: Array<string>;
282
+
283
+ /**
284
+ * The format of the document. Currently supports `files` only.
285
+ */
286
+ type: 'files';
287
+ }
288
+
289
+ interface CompanyLicense {
290
+ /**
291
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
292
+ */
293
+ files: Array<string>;
294
+
295
+ /**
296
+ * The format of the document. Currently supports `files` only.
297
+ */
298
+ type: 'files';
299
+ }
300
+
301
+ interface CompanyMemorandumOfAssociation {
302
+ /**
303
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
304
+ */
305
+ files: Array<string>;
306
+
307
+ /**
308
+ * The format of the document. Currently supports `files` only.
309
+ */
310
+ type: 'files';
311
+ }
312
+
313
+ interface CompanyMinisterialDecree {
314
+ /**
315
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
316
+ */
317
+ files: Array<string>;
318
+
319
+ /**
320
+ * The format of the document. Currently supports `files` only.
321
+ */
322
+ type: 'files';
323
+ }
324
+
325
+ interface CompanyRegistrationVerification {
326
+ /**
327
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
328
+ */
329
+ files: Array<string>;
330
+
331
+ /**
332
+ * The format of the document. Currently supports `files` only.
333
+ */
334
+ type: 'files';
335
+ }
336
+
337
+ interface CompanyTaxIdVerification {
338
+ /**
339
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
340
+ */
341
+ files: Array<string>;
342
+
343
+ /**
344
+ * The format of the document. Currently supports `files` only.
345
+ */
346
+ type: 'files';
347
+ }
348
+
349
+ interface PrimaryVerification {
350
+ /**
351
+ * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
352
+ */
353
+ front_back: PrimaryVerification.FrontBack;
354
+
355
+ /**
356
+ * The format of the verification document. Currently supports `front_back` only.
357
+ */
358
+ type: 'front_back';
359
+ }
360
+
361
+ namespace PrimaryVerification {
362
+ interface FrontBack {
363
+ /**
364
+ * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
365
+ */
366
+ back?: string;
367
+
368
+ /**
369
+ * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
370
+ */
371
+ front?: string;
372
+ }
373
+ }
374
+
375
+ interface ProofOfAddress {
376
+ /**
377
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
378
+ */
379
+ files: Array<string>;
380
+
381
+ /**
382
+ * The format of the document. Currently supports `files` only.
383
+ */
384
+ type: 'files';
385
+ }
386
+
387
+ interface ProofOfRegistration {
388
+ /**
389
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
390
+ */
391
+ files: Array<string>;
392
+
393
+ /**
394
+ * The format of the document. Currently supports `files` only.
395
+ */
396
+ type: 'files';
397
+ }
398
+
399
+ interface ProofOfUltimateBeneficialOwnership {
400
+ /**
401
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
402
+ */
403
+ files: Array<string>;
404
+
405
+ /**
406
+ * The format of the document. Currently supports `files` only.
407
+ */
408
+ type: 'files';
409
+ }
410
+ }
411
+
412
+ interface IdNumber {
413
+ /**
414
+ * The registrar of the ID number (Only valid for DE ID number types).
415
+ */
416
+ registrar?: string;
417
+
418
+ /**
419
+ * Open Enum. The ID number type of a business entity.
420
+ */
421
+ type: IdNumber.Type;
422
+
423
+ /**
424
+ * The value of the ID number.
425
+ */
426
+ value: string;
427
+ }
428
+
429
+ namespace IdNumber {
430
+ type Type =
431
+ | 'ae_crn'
432
+ | 'ae_vat'
433
+ | 'ao_nif'
434
+ | 'ar_cuit'
435
+ | 'at_fn'
436
+ | 'au_abn'
437
+ | 'au_acn'
438
+ | 'au_in'
439
+ | 'az_tin'
440
+ | 'bd_etin'
441
+ | 'be_cbe'
442
+ | 'bg_uic'
443
+ | 'br_cnpj'
444
+ | 'ca_cn'
445
+ | 'ca_crarr'
446
+ | 'ca_neq'
447
+ | 'ca_rid'
448
+ | 'ch_chid'
449
+ | 'ch_uid'
450
+ | 'cr_cpj'
451
+ | 'cr_nite'
452
+ | 'cy_tic'
453
+ | 'cz_ico'
454
+ | 'de_hrn'
455
+ | 'de_vat'
456
+ | 'dk_cvr'
457
+ | 'do_rcn'
458
+ | 'ee_rk'
459
+ | 'es_cif'
460
+ | 'fi_yt'
461
+ | 'fr_siren'
462
+ | 'fr_vat'
463
+ | 'gb_crn'
464
+ | 'gi_crn'
465
+ | 'gr_gemi'
466
+ | 'gt_nit'
467
+ | 'hk_br'
468
+ | 'hk_cr'
469
+ | 'hk_mbs'
470
+ | 'hu_cjs'
471
+ | 'ie_crn'
472
+ | 'it_rea'
473
+ | 'it_vat'
474
+ | 'jp_cn'
475
+ | 'kz_bin'
476
+ | 'li_uid'
477
+ | 'lt_ccrn'
478
+ | 'lu_rcs'
479
+ | 'lv_urn'
480
+ | 'mt_crn'
481
+ | 'mx_rfc'
482
+ | 'my_brn'
483
+ | 'my_coid'
484
+ | 'my_sst'
485
+ | 'mz_nuit'
486
+ | 'nl_kvk'
487
+ | 'no_orgnr'
488
+ | 'nz_bn'
489
+ | 'pe_ruc'
490
+ | 'pk_ntn'
491
+ | 'pl_regon'
492
+ | 'pt_vat'
493
+ | 'ro_cui'
494
+ | 'sa_crn'
495
+ | 'sa_tin'
496
+ | 'se_orgnr'
497
+ | 'sg_uen'
498
+ | 'si_msp'
499
+ | 'sk_ico'
500
+ | 'th_crn'
501
+ | 'th_prn'
502
+ | 'th_tin'
503
+ | 'us_ein';
504
+ }
505
+
506
+ interface MonthlyEstimatedRevenue {
507
+ /**
508
+ * A non-negative integer representing the amount in the smallest currency unit.
509
+ */
510
+ amount?: Amount;
511
+ }
512
+
513
+ interface ScriptAddresses {
514
+ /**
515
+ * Kana Address.
516
+ */
517
+ kana?: Stripe.JapanAddressParam;
518
+
519
+ /**
520
+ * Kanji Address.
521
+ */
522
+ kanji?: Stripe.JapanAddressParam;
523
+ }
524
+
525
+ interface ScriptNames {
526
+ /**
527
+ * Kana name.
528
+ */
529
+ kana?: ScriptNames.Kana;
530
+
531
+ /**
532
+ * Kanji name.
533
+ */
534
+ kanji?: ScriptNames.Kanji;
535
+ }
536
+
537
+ namespace ScriptNames {
538
+ interface Kana {
539
+ /**
540
+ * Registered name of the business.
541
+ */
542
+ registered_name?: string;
543
+ }
544
+
545
+ interface Kanji {
546
+ /**
547
+ * Registered name of the business.
548
+ */
549
+ registered_name?: string;
550
+ }
551
+ }
552
+
553
+ type Structure =
554
+ | 'cooperative'
555
+ | 'free_zone_establishment'
556
+ | 'free_zone_llc'
557
+ | 'governmental_unit'
558
+ | 'government_instrumentality'
559
+ | 'incorporated_association'
560
+ | 'incorporated_non_profit'
561
+ | 'incorporated_partnership'
562
+ | 'limited_liability_partnership'
563
+ | 'llc'
564
+ | 'multi_member_llc'
565
+ | 'private_company'
566
+ | 'private_corporation'
567
+ | 'private_partnership'
568
+ | 'public_company'
569
+ | 'public_corporation'
570
+ | 'public_listed_corporation'
571
+ | 'public_partnership'
572
+ | 'registered_charity'
573
+ | 'single_member_llc'
574
+ | 'sole_establishment'
575
+ | 'sole_proprietorship'
576
+ | 'tax_exempt_government_instrumentality'
577
+ | 'trust'
578
+ | 'unincorporated_association'
579
+ | 'unincorporated_non_profit'
580
+ | 'unincorporated_partnership';
581
+ }
582
+
583
+ type EntityType =
584
+ | 'company'
585
+ | 'government_entity'
586
+ | 'individual'
587
+ | 'non_profit';
588
+
589
+ interface Individual {
590
+ /**
591
+ * Additional addresses associated with the individual.
592
+ */
593
+ additional_addresses?: Array<Individual.AdditionalAddress>;
594
+
595
+ /**
596
+ * Additional names (e.g. aliases) associated with the individual.
597
+ */
598
+ additional_names?: Array<Individual.AdditionalName>;
599
+
600
+ /**
601
+ * The individual's residential address.
602
+ */
603
+ address?: Stripe.JapanAddressParam;
604
+
605
+ /**
606
+ * The individual's date of birth.
607
+ */
608
+ date_of_birth?: Individual.DateOfBirth;
609
+
610
+ /**
611
+ * Documents that may be submitted to satisfy various informational requests.
612
+ */
613
+ documents?: Individual.Documents;
614
+
615
+ /**
616
+ * The individual's email address.
617
+ */
618
+ email?: string;
619
+
620
+ /**
621
+ * The individual's first name.
622
+ */
623
+ given_name?: string;
624
+
625
+ /**
626
+ * The identification numbers (e.g., SSN) associated with the individual.
627
+ */
628
+ id_numbers?: Array<Individual.IdNumber>;
629
+
630
+ /**
631
+ * The individual's gender (International regulations require either "male" or "female").
632
+ */
633
+ legal_gender?: Individual.LegalGender;
634
+
635
+ /**
636
+ * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
637
+ */
638
+ metadata?: Stripe.MetadataParam;
639
+
640
+ /**
641
+ * The countries where the individual is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
642
+ */
643
+ nationalities?: Array<string>;
644
+
645
+ /**
646
+ * The individual's phone number.
647
+ */
648
+ phone?: string;
649
+
650
+ /**
651
+ * The individual's political exposure.
652
+ */
653
+ political_exposure?: Individual.PoliticalExposure;
654
+
655
+ /**
656
+ * The relationship that this individual has with the account's identity.
657
+ */
658
+ relationship?: Individual.Relationship;
659
+
660
+ /**
661
+ * The script addresses (e.g., non-Latin characters) associated with the individual.
662
+ */
663
+ script_addresses?: Individual.ScriptAddresses;
664
+
665
+ /**
666
+ * The individuals primary name in non latin script.
667
+ */
668
+ script_names?: Individual.ScriptNames;
669
+
670
+ /**
671
+ * The individual's last name.
672
+ */
673
+ surname?: string;
674
+ }
675
+
676
+ namespace Individual {
677
+ interface AdditionalAddress {
678
+ /**
679
+ * City, district, suburb, town, or village.
680
+ */
681
+ city?: string;
682
+
683
+ /**
684
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
685
+ */
686
+ country?: string;
687
+
688
+ /**
689
+ * Address line 1 (e.g., street, PO Box, or company name).
690
+ */
691
+ line1?: string;
692
+
693
+ /**
694
+ * Address line 2 (e.g., apartment, suite, unit, or building).
695
+ */
696
+ line2?: string;
697
+
698
+ /**
699
+ * ZIP or postal code.
700
+ */
701
+ postal_code?: string;
702
+
703
+ /**
704
+ * Purpose of additional address.
705
+ */
706
+ purpose: 'registered';
707
+
708
+ /**
709
+ * State, county, province, or region.
710
+ */
711
+ state?: string;
712
+
713
+ /**
714
+ * Town or cho-me.
715
+ */
716
+ town?: string;
717
+ }
718
+
719
+ interface AdditionalName {
720
+ /**
721
+ * The person's full name.
722
+ */
723
+ full_name?: string;
724
+
725
+ /**
726
+ * The person's first or given name.
727
+ */
728
+ given_name?: string;
729
+
730
+ /**
731
+ * The purpose or type of the additional name.
732
+ */
733
+ purpose: AdditionalName.Purpose;
734
+
735
+ /**
736
+ * The person's last or family name.
737
+ */
738
+ surname?: string;
739
+ }
740
+
741
+ namespace AdditionalName {
742
+ type Purpose = 'alias' | 'maiden';
743
+ }
744
+
745
+ interface DateOfBirth {
746
+ /**
747
+ * The day of the birth.
748
+ */
749
+ day: number;
750
+
751
+ /**
752
+ * The month of birth.
753
+ */
754
+ month: number;
755
+
756
+ /**
757
+ * The year of birth.
758
+ */
759
+ year: number;
760
+ }
761
+
762
+ interface Documents {
763
+ /**
764
+ * One or more documents that demonstrate proof that this person is authorized to represent the company.
765
+ */
766
+ company_authorization?: Documents.CompanyAuthorization;
767
+
768
+ /**
769
+ * One or more documents showing the person's passport page with photo and personal data.
770
+ */
771
+ passport?: Documents.Passport;
772
+
773
+ /**
774
+ * An identifying document showing the person's name, either a passport or local ID card.
775
+ */
776
+ primary_verification?: Documents.PrimaryVerification;
777
+
778
+ /**
779
+ * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
780
+ */
781
+ secondary_verification?: Documents.SecondaryVerification;
782
+
783
+ /**
784
+ * One or more documents showing the person's visa required for living in the country where they are residing.
785
+ */
786
+ visa?: Documents.Visa;
787
+ }
788
+
789
+ namespace Documents {
790
+ interface CompanyAuthorization {
791
+ /**
792
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
793
+ */
794
+ files: Array<string>;
795
+
796
+ /**
797
+ * The format of the document. Currently supports `files` only.
798
+ */
799
+ type: 'files';
800
+ }
801
+
802
+ interface Passport {
803
+ /**
804
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
805
+ */
806
+ files: Array<string>;
807
+
808
+ /**
809
+ * The format of the document. Currently supports `files` only.
810
+ */
811
+ type: 'files';
812
+ }
813
+
814
+ interface PrimaryVerification {
815
+ /**
816
+ * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
817
+ */
818
+ front_back: PrimaryVerification.FrontBack;
819
+
820
+ /**
821
+ * The format of the verification document. Currently supports `front_back` only.
822
+ */
823
+ type: 'front_back';
824
+ }
825
+
826
+ namespace PrimaryVerification {
827
+ interface FrontBack {
828
+ /**
829
+ * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
830
+ */
831
+ back?: string;
832
+
833
+ /**
834
+ * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
835
+ */
836
+ front?: string;
837
+ }
838
+ }
839
+
840
+ interface SecondaryVerification {
841
+ /**
842
+ * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
843
+ */
844
+ front_back: SecondaryVerification.FrontBack;
845
+
846
+ /**
847
+ * The format of the verification document. Currently supports `front_back` only.
848
+ */
849
+ type: 'front_back';
850
+ }
851
+
852
+ namespace SecondaryVerification {
853
+ interface FrontBack {
854
+ /**
855
+ * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
856
+ */
857
+ back?: string;
858
+
859
+ /**
860
+ * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
861
+ */
862
+ front?: string;
863
+ }
864
+ }
865
+
866
+ interface Visa {
867
+ /**
868
+ * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
869
+ */
870
+ files: Array<string>;
871
+
872
+ /**
873
+ * The format of the document. Currently supports `files` only.
874
+ */
875
+ type: 'files';
876
+ }
877
+ }
878
+
879
+ interface IdNumber {
880
+ /**
881
+ * The ID number type of an individual.
882
+ */
883
+ type: IdNumber.Type;
884
+
885
+ /**
886
+ * The value of the ID number.
887
+ */
888
+ value: string;
889
+ }
890
+
891
+ namespace IdNumber {
892
+ type Type =
893
+ | 'ae_eid'
894
+ | 'ao_nif'
895
+ | 'ar_dni'
896
+ | 'az_tin'
897
+ | 'bd_brc'
898
+ | 'bd_etin'
899
+ | 'bd_nid'
900
+ | 'br_cpf'
901
+ | 'cr_cpf'
902
+ | 'cr_dimex'
903
+ | 'cr_nite'
904
+ | 'de_stn'
905
+ | 'do_rcn'
906
+ | 'gt_nit'
907
+ | 'hk_id'
908
+ | 'kz_iin'
909
+ | 'mx_rfc'
910
+ | 'my_nric'
911
+ | 'mz_nuit'
912
+ | 'nl_bsn'
913
+ | 'pe_dni'
914
+ | 'pk_cnic'
915
+ | 'pk_snic'
916
+ | 'sa_tin'
917
+ | 'sg_fin'
918
+ | 'sg_nric'
919
+ | 'th_lc'
920
+ | 'th_pin'
921
+ | 'us_itin'
922
+ | 'us_itin_last_4'
923
+ | 'us_ssn'
924
+ | 'us_ssn_last_4';
925
+ }
926
+
927
+ type LegalGender = 'female' | 'male';
928
+
929
+ type PoliticalExposure = 'existing' | 'none';
930
+
931
+ interface Relationship {
932
+ /**
933
+ * Whether the person is a director of the account's identity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
934
+ */
935
+ director?: boolean;
936
+
937
+ /**
938
+ * Whether the person has significant responsibility to control, manage, or direct the organization.
939
+ */
940
+ executive?: boolean;
941
+
942
+ /**
943
+ * Whether the person is an owner of the account's identity.
944
+ */
945
+ owner?: boolean;
946
+
947
+ /**
948
+ * The percent owned by the person of the account's legal entity.
949
+ */
950
+ percent_ownership?: string;
951
+
952
+ /**
953
+ * The person's title (e.g., CEO, Support Engineer).
954
+ */
955
+ title?: string;
956
+ }
957
+
958
+ interface ScriptAddresses {
959
+ /**
960
+ * Kana Address.
961
+ */
962
+ kana?: Stripe.JapanAddressParam;
963
+
964
+ /**
965
+ * Kanji Address.
966
+ */
967
+ kanji?: Stripe.JapanAddressParam;
968
+ }
969
+
970
+ interface ScriptNames {
971
+ /**
972
+ * Persons name in kana script.
973
+ */
974
+ kana?: ScriptNames.Kana;
975
+
976
+ /**
977
+ * Persons name in kanji script.
978
+ */
979
+ kanji?: ScriptNames.Kanji;
980
+ }
981
+
982
+ namespace ScriptNames {
983
+ interface Kana {
984
+ /**
985
+ * The person's first or given name.
986
+ */
987
+ given_name?: string;
988
+
989
+ /**
990
+ * The person's last or family name.
991
+ */
992
+ surname?: string;
993
+ }
994
+
995
+ interface Kanji {
996
+ /**
997
+ * The person's first or given name.
998
+ */
999
+ given_name?: string;
1000
+
1001
+ /**
1002
+ * The person's last or family name.
1003
+ */
1004
+ surname?: string;
1005
+ }
1006
+ }
1007
+ }
1008
+ }
1009
+ }
1010
+ }
1011
+
1012
+ namespace Core {
1013
+ interface AccountTokenRetrieveParams {}
1014
+ }
1015
+
1016
+ namespace Core {
1017
+ class AccountTokensResource {
1018
+ /**
1019
+ * Creates an Account Token.
1020
+ */
1021
+ create(
1022
+ params: AccountTokenCreateParams,
1023
+ options?: RequestOptions
1024
+ ): Promise<Stripe.Response<Stripe.V2.Core.AccountToken>>;
1025
+
1026
+ /**
1027
+ * Retrieves an Account Token.
1028
+ */
1029
+ retrieve(
1030
+ id: string,
1031
+ params?: AccountTokenRetrieveParams,
1032
+ options?: RequestOptions
1033
+ ): Promise<Stripe.Response<Stripe.V2.Core.AccountToken>>;
1034
+ retrieve(
1035
+ id: string,
1036
+ options?: RequestOptions
1037
+ ): Promise<Stripe.Response<Stripe.V2.Core.AccountToken>>;
1038
+ }
1039
+ }
1040
+ }
1041
+ }
1042
+ }