stripe 18.2.0-beta.1 → 18.2.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 (333) hide show
  1. package/CHANGELOG.md +183 -1211
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +11 -12
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -91
  6. package/cjs/RequestSender.js +3 -3
  7. package/cjs/StripeResource.js +1 -1
  8. package/cjs/apiVersion.js +1 -1
  9. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  10. package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
  11. package/cjs/resources/PaymentIntents.js +0 -13
  12. package/cjs/resources/Quotes.js +0 -32
  13. package/cjs/resources/SubscriptionSchedules.js +0 -4
  14. package/cjs/resources/Terminal/Readers.js +0 -8
  15. package/cjs/resources.js +18 -108
  16. package/cjs/stripe.core.js +1 -1
  17. package/cjs/utils.js +5 -0
  18. package/esm/Error.js +0 -79
  19. package/esm/RequestSender.js +3 -3
  20. package/esm/StripeResource.js +1 -1
  21. package/esm/apiVersion.js +1 -1
  22. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  23. package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
  24. package/esm/resources/PaymentIntents.js +0 -13
  25. package/esm/resources/Quotes.js +0 -32
  26. package/esm/resources/SubscriptionSchedules.js +0 -4
  27. package/esm/resources/Terminal/Readers.js +0 -8
  28. package/esm/resources.js +1 -84
  29. package/esm/stripe.core.js +1 -1
  30. package/esm/utils.js +5 -0
  31. package/package.json +1 -1
  32. package/types/AccountLinksResource.d.ts +1 -5
  33. package/types/AccountSessions.d.ts +52 -32
  34. package/types/AccountSessionsResource.d.ts +23 -246
  35. package/types/Accounts.d.ts +19 -223
  36. package/types/AccountsResource.d.ts +61 -581
  37. package/types/Balance.d.ts +83 -1
  38. package/types/BalanceResource.d.ts +1 -1
  39. package/types/BalanceTransactions.d.ts +10 -0
  40. package/types/BankAccounts.d.ts +3 -3
  41. package/types/Billing/Alerts.d.ts +1 -1
  42. package/types/Billing/AlertsResource.d.ts +2 -2
  43. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  44. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  45. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  46. package/types/Billing/CreditGrants.d.ts +0 -5
  47. package/types/Billing/CreditGrantsResource.d.ts +1 -11
  48. package/types/BillingPortal/Sessions.d.ts +1 -6
  49. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  50. package/types/Capabilities.d.ts +1 -1
  51. package/types/Cards.d.ts +2 -7
  52. package/types/CashBalances.d.ts +0 -5
  53. package/types/Charges.d.ts +20 -166
  54. package/types/ChargesResource.d.ts +4 -1318
  55. package/types/Checkout/Sessions.d.ts +120 -418
  56. package/types/Checkout/SessionsResource.d.ts +118 -448
  57. package/types/ConfirmationTokens.d.ts +4 -129
  58. package/types/CountrySpecs.d.ts +1 -1
  59. package/types/Coupons.d.ts +0 -33
  60. package/types/CouponsResource.d.ts +0 -21
  61. package/types/CreditNoteLineItems.d.ts +0 -17
  62. package/types/CreditNotes.d.ts +11 -10
  63. package/types/CreditNotesResource.d.ts +7 -13
  64. package/types/CustomerBalanceTransactions.d.ts +0 -2
  65. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  66. package/types/CustomerSessions.d.ts +3 -8
  67. package/types/CustomerSessionsResource.d.ts +1 -6
  68. package/types/Customers.d.ts +0 -2
  69. package/types/CustomersResource.d.ts +7 -15
  70. package/types/Discounts.d.ts +0 -10
  71. package/types/Disputes.d.ts +1 -1
  72. package/types/DisputesResource.d.ts +1 -1
  73. package/types/Errors.d.ts +2 -69
  74. package/types/EventTypes.d.ts +17 -698
  75. package/types/Events.d.ts +4 -99
  76. package/types/Files.d.ts +1 -1
  77. package/types/FilesResource.d.ts +1 -1
  78. package/types/FinancialConnections/Accounts.d.ts +1 -31
  79. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  80. package/types/FinancialConnections/Sessions.d.ts +1 -51
  81. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  82. package/types/Identity/VerificationReports.d.ts +17 -0
  83. package/types/Identity/VerificationSessions.d.ts +19 -7
  84. package/types/Identity/VerificationSessionsResource.d.ts +5 -12
  85. package/types/InvoiceItems.d.ts +1 -11
  86. package/types/InvoiceItemsResource.d.ts +6 -117
  87. package/types/InvoiceLineItems.d.ts +2 -46
  88. package/types/InvoicePayments.d.ts +9 -7
  89. package/types/InvoicePaymentsResource.d.ts +74 -0
  90. package/types/Invoices.d.ts +10 -142
  91. package/types/InvoicesResource.d.ts +66 -1469
  92. package/types/Issuing/AuthorizationsResource.d.ts +4 -4
  93. package/types/Issuing/CardholdersResource.d.ts +1 -2
  94. package/types/Issuing/CardsResource.d.ts +3 -0
  95. package/types/Issuing/DisputesResource.d.ts +2 -2
  96. package/types/Issuing/Transactions.d.ts +0 -5
  97. package/types/Issuing/TransactionsResource.d.ts +0 -5
  98. package/types/LineItems.d.ts +2 -51
  99. package/types/Mandates.d.ts +0 -77
  100. package/types/PaymentIntents.d.ts +145 -856
  101. package/types/PaymentIntentsResource.d.ts +4307 -8780
  102. package/types/PaymentLinks.d.ts +0 -6
  103. package/types/PaymentLinksResource.d.ts +0 -12
  104. package/types/PaymentMethodConfigurations.d.ts +70 -70
  105. package/types/PaymentMethodConfigurationsResource.d.ts +164 -164
  106. package/types/PaymentMethodDomainsResource.d.ts +1 -1
  107. package/types/PaymentMethods.d.ts +4 -129
  108. package/types/PaymentMethodsResource.d.ts +10 -175
  109. package/types/Payouts.d.ts +2 -7
  110. package/types/PayoutsResource.d.ts +2 -7
  111. package/types/Persons.d.ts +10 -10
  112. package/types/PlansResource.d.ts +1 -1
  113. package/types/Prices.d.ts +0 -22
  114. package/types/PricesResource.d.ts +2 -24
  115. package/types/Products.d.ts +0 -39
  116. package/types/ProductsResource.d.ts +1 -37
  117. package/types/PromotionCodes.d.ts +0 -5
  118. package/types/PromotionCodesResource.d.ts +1 -11
  119. package/types/Quotes.d.ts +7 -609
  120. package/types/QuotesResource.d.ts +224 -2578
  121. package/types/Radar/EarlyFraudWarningsResource.d.ts +1 -1
  122. package/types/Refunds.d.ts +6 -15
  123. package/types/Reviews.d.ts +1 -1
  124. package/types/SetupAttempts.d.ts +2 -50
  125. package/types/SetupIntents.d.ts +4 -122
  126. package/types/SetupIntentsResource.d.ts +6 -733
  127. package/types/Sources.d.ts +0 -29
  128. package/types/SourcesResource.d.ts +1 -1
  129. package/types/SubscriptionItems.d.ts +8 -17
  130. package/types/SubscriptionItemsResource.d.ts +28 -109
  131. package/types/SubscriptionSchedules.d.ts +47 -213
  132. package/types/SubscriptionSchedulesResource.d.ts +104 -1243
  133. package/types/Subscriptions.d.ts +16 -102
  134. package/types/SubscriptionsResource.d.ts +80 -407
  135. package/types/Tax/CalculationLineItems.d.ts +5 -0
  136. package/types/Tax/CalculationsResource.d.ts +5 -0
  137. package/types/Tax/RegistrationsResource.d.ts +1 -1
  138. package/types/TaxIds.d.ts +0 -10
  139. package/types/TaxIdsResource.d.ts +0 -10
  140. package/types/TaxRates.d.ts +2 -2
  141. package/types/Terminal/LocationsResource.d.ts +1 -1
  142. package/types/Terminal/Readers.d.ts +7 -89
  143. package/types/Terminal/ReadersResource.d.ts +6 -82
  144. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
  145. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  146. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  147. package/types/Tokens.d.ts +3 -3
  148. package/types/TokensResource.d.ts +8 -8
  149. package/types/TransferReversals.d.ts +1 -1
  150. package/types/Transfers.d.ts +0 -5
  151. package/types/TransfersResource.d.ts +2 -7
  152. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  153. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  154. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  155. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  156. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  157. package/types/Treasury/ReceivedCredits.d.ts +2 -28
  158. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  159. package/types/V2/EventTypes.d.ts +1 -812
  160. package/types/WebhookEndpointsResource.d.ts +4 -83
  161. package/types/index.d.ts +5 -145
  162. package/types/lib.d.ts +1 -11
  163. package/types/test/typescriptTest.ts +3 -3
  164. package/cjs/resources/AccountNotices.js +0 -21
  165. package/cjs/resources/BalanceSettings.js +0 -10
  166. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  167. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  168. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  169. package/cjs/resources/ExternalAccounts.js +0 -23
  170. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  171. package/cjs/resources/FxQuotes.js +0 -15
  172. package/cjs/resources/GiftCards/Cards.js +0 -23
  173. package/cjs/resources/GiftCards/Transactions.js +0 -33
  174. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  175. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  176. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  177. package/cjs/resources/Margins.js +0 -22
  178. package/cjs/resources/Orders.js +0 -24
  179. package/cjs/resources/PaymentRecords.js +0 -29
  180. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  181. package/cjs/resources/Tax/Associations.js +0 -9
  182. package/cjs/resources/Tax/Forms.js +0 -20
  183. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  184. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  185. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  186. package/cjs/resources/V2/Core/Accounts.js +0 -25
  187. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  188. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  189. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  190. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -17
  191. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  192. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  193. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  194. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  195. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  196. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  197. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  198. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  199. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  200. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  201. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  202. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  203. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  204. package/esm/resources/AccountNotices.js +0 -18
  205. package/esm/resources/BalanceSettings.js +0 -7
  206. package/esm/resources/Capital/FinancingOffers.js +0 -18
  207. package/esm/resources/Capital/FinancingSummary.js +0 -9
  208. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  209. package/esm/resources/ExternalAccounts.js +0 -20
  210. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  211. package/esm/resources/FxQuotes.js +0 -12
  212. package/esm/resources/GiftCards/Cards.js +0 -20
  213. package/esm/resources/GiftCards/Transactions.js +0 -30
  214. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  215. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  216. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  217. package/esm/resources/Margins.js +0 -19
  218. package/esm/resources/Orders.js +0 -21
  219. package/esm/resources/PaymentRecords.js +0 -26
  220. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  221. package/esm/resources/Tax/Associations.js +0 -6
  222. package/esm/resources/Tax/Forms.js +0 -17
  223. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  224. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  225. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  226. package/esm/resources/V2/Core/Accounts.js +0 -22
  227. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  228. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  229. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  230. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -14
  231. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  232. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  233. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  234. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  235. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  236. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  237. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  238. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  239. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  240. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  241. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  242. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  243. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  244. package/types/AccountNotices.d.ts +0 -113
  245. package/types/AccountNoticesResource.d.ts +0 -98
  246. package/types/BalanceSettings.d.ts +0 -89
  247. package/types/BalanceSettingsResource.d.ts +0 -108
  248. package/types/Billing/MeterErrorReports.d.ts +0 -106
  249. package/types/Capital/FinancingOffers.d.ts +0 -188
  250. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  251. package/types/Capital/FinancingSummary.d.ts +0 -106
  252. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  253. package/types/Capital/FinancingTransactions.d.ts +0 -135
  254. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  255. package/types/ExternalAccountsResource.d.ts +0 -304
  256. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  257. package/types/FinancialConnections/Institutions.d.ts +0 -93
  258. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  259. package/types/FxQuotes.d.ts +0 -153
  260. package/types/FxQuotesResource.d.ts +0 -130
  261. package/types/GiftCards/Cards.d.ts +0 -118
  262. package/types/GiftCards/CardsResource.d.ts +0 -159
  263. package/types/GiftCards/Transactions.d.ts +0 -129
  264. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  265. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  266. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  267. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  268. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  269. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  270. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  271. package/types/Issuing/Settlements.d.ts +0 -113
  272. package/types/Margins.d.ts +0 -56
  273. package/types/MarginsResource.d.ts +0 -114
  274. package/types/Orders.d.ts +0 -1199
  275. package/types/OrdersResource.d.ts +0 -3001
  276. package/types/PaymentAttemptRecords.d.ts +0 -2112
  277. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  278. package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -110
  279. package/types/PaymentRecords.d.ts +0 -2105
  280. package/types/PaymentRecordsResource.d.ts +0 -455
  281. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -30
  282. package/types/Privacy/RedactionJobs.d.ts +0 -65
  283. package/types/Privacy/RedactionJobsResource.d.ts +0 -218
  284. package/types/QuoteLines.d.ts +0 -634
  285. package/types/QuotePreviewInvoices.d.ts +0 -1697
  286. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -785
  287. package/types/Tax/Associations.d.ts +0 -126
  288. package/types/Tax/AssociationsResource.d.ts +0 -29
  289. package/types/Tax/Forms.d.ts +0 -220
  290. package/types/Tax/FormsResource.d.ts +0 -107
  291. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  292. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  293. package/types/V2/Core/AccountLinks.d.ts +0 -106
  294. package/types/V2/Core/AccountLinksResource.d.ts +0 -90
  295. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3770
  296. package/types/V2/Core/Accounts.d.ts +0 -8169
  297. package/types/V2/Core/AccountsResource.d.ts +0 -10203
  298. package/types/V2/Core/Persons.d.ts +0 -1867
  299. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  300. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  301. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
  302. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  303. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  304. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  305. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  306. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  307. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -546
  308. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -52
  309. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
  310. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -288
  311. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  312. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  313. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -168
  314. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  315. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  316. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  317. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  318. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  319. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  320. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -207
  321. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -151
  322. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  323. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -87
  324. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  325. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -285
  326. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  327. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -224
  328. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  329. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -155
  330. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  331. package/types/V2/MoneyManagement/Transactions.d.ts +0 -170
  332. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  333. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -66
@@ -1,1867 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Core {
7
- /**
8
- * Person retrieval response schema.
9
- */
10
- interface Person {
11
- /**
12
- * Unique identifier for the Person.
13
- */
14
- id: string;
15
-
16
- /**
17
- * String representing the object's type. Objects of the same type share the same value of the object field.
18
- */
19
- object: 'v2.core.account_person';
20
-
21
- /**
22
- * The account ID which the individual belongs to.
23
- */
24
- account: string;
25
-
26
- /**
27
- * Additional addresses associated with the person.
28
- */
29
- additional_addresses: Array<Person.AdditionalAddress> | null;
30
-
31
- /**
32
- * Additional names (e.g. aliases) associated with the person.
33
- */
34
- additional_names: Array<Person.AdditionalName> | null;
35
-
36
- /**
37
- * Attestations of accepted terms of service agreements.
38
- */
39
- additional_terms_of_service: Person.AdditionalTermsOfService | null;
40
-
41
- /**
42
- * The person's residential address.
43
- */
44
- address: Person.Address | null;
45
-
46
- /**
47
- * Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
48
- */
49
- created: string;
50
-
51
- /**
52
- * The person's date of birth.
53
- */
54
- date_of_birth: Person.DateOfBirth | null;
55
-
56
- /**
57
- * Documents that may be submitted to satisfy various informational requests.
58
- */
59
- documents: Person.Documents | null;
60
-
61
- /**
62
- * The person's email address.
63
- */
64
- email: string | null;
65
-
66
- /**
67
- * The person's first name.
68
- */
69
- given_name: string | null;
70
-
71
- /**
72
- * The identification numbers (e.g., SSN) associated with the person.
73
- */
74
- id_numbers: Array<Person.IdNumber> | null;
75
-
76
- /**
77
- * The person's gender (International regulations require either "male" or "female").
78
- */
79
- legal_gender: Person.LegalGender | null;
80
-
81
- /**
82
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
83
- */
84
- livemode: boolean;
85
-
86
- /**
87
- * 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.
88
- */
89
- metadata: Stripe.Metadata | null;
90
-
91
- /**
92
- * The countries where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
93
- */
94
- nationalities: Array<Person.Nationality> | null;
95
-
96
- /**
97
- * The person's phone number.
98
- */
99
- phone: string | null;
100
-
101
- /**
102
- * The person's political exposure.
103
- */
104
- political_exposure: Person.PoliticalExposure | null;
105
-
106
- /**
107
- * The relationship that this person has with the Account's business or legal entity.
108
- */
109
- relationship: Person.Relationship | null;
110
-
111
- /**
112
- * The script addresses (e.g., non-Latin characters) associated with the person.
113
- */
114
- script_addresses: Person.ScriptAddresses | null;
115
-
116
- /**
117
- * The script names (e.g. non-Latin characters) associated with the person.
118
- */
119
- script_names: Person.ScriptNames | null;
120
-
121
- /**
122
- * The person's last name.
123
- */
124
- surname: string | null;
125
-
126
- /**
127
- * Time at which the object was last updated. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
128
- */
129
- updated: string;
130
- }
131
-
132
- namespace Person {
133
- interface AdditionalAddress {
134
- /**
135
- * City, district, suburb, town, or village.
136
- */
137
- city: string | null;
138
-
139
- /**
140
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
141
- */
142
- country: AdditionalAddress.Country | null;
143
-
144
- /**
145
- * Address line 1 (e.g., street, PO Box, or company name).
146
- */
147
- line1: string | null;
148
-
149
- /**
150
- * Address line 2 (e.g., apartment, suite, unit, or building).
151
- */
152
- line2: string | null;
153
-
154
- /**
155
- * ZIP or postal code.
156
- */
157
- postal_code: string | null;
158
-
159
- /**
160
- * Purpose of additional address.
161
- */
162
- purpose: 'registered';
163
-
164
- /**
165
- * State, county, province, or region.
166
- */
167
- state: string | null;
168
-
169
- /**
170
- * Town or cho-me.
171
- */
172
- town: string | null;
173
- }
174
-
175
- namespace AdditionalAddress {
176
- type Country =
177
- | 'ad'
178
- | 'ae'
179
- | 'af'
180
- | 'ag'
181
- | 'ai'
182
- | 'al'
183
- | 'am'
184
- | 'ao'
185
- | 'aq'
186
- | 'ar'
187
- | 'as'
188
- | 'at'
189
- | 'au'
190
- | 'aw'
191
- | 'ax'
192
- | 'az'
193
- | 'ba'
194
- | 'bb'
195
- | 'bd'
196
- | 'be'
197
- | 'bf'
198
- | 'bg'
199
- | 'bh'
200
- | 'bi'
201
- | 'bj'
202
- | 'bl'
203
- | 'bm'
204
- | 'bn'
205
- | 'bo'
206
- | 'bq'
207
- | 'br'
208
- | 'bs'
209
- | 'bt'
210
- | 'bv'
211
- | 'bw'
212
- | 'by'
213
- | 'bz'
214
- | 'ca'
215
- | 'cc'
216
- | 'cd'
217
- | 'cf'
218
- | 'cg'
219
- | 'ch'
220
- | 'ci'
221
- | 'ck'
222
- | 'cl'
223
- | 'cm'
224
- | 'cn'
225
- | 'co'
226
- | 'cr'
227
- | 'cu'
228
- | 'cv'
229
- | 'cw'
230
- | 'cx'
231
- | 'cy'
232
- | 'cz'
233
- | 'de'
234
- | 'dj'
235
- | 'dk'
236
- | 'dm'
237
- | 'do'
238
- | 'dz'
239
- | 'ec'
240
- | 'ee'
241
- | 'eg'
242
- | 'eh'
243
- | 'er'
244
- | 'es'
245
- | 'et'
246
- | 'fi'
247
- | 'fj'
248
- | 'fk'
249
- | 'fm'
250
- | 'fo'
251
- | 'fr'
252
- | 'ga'
253
- | 'gb'
254
- | 'gd'
255
- | 'ge'
256
- | 'gf'
257
- | 'gg'
258
- | 'gh'
259
- | 'gi'
260
- | 'gl'
261
- | 'gm'
262
- | 'gn'
263
- | 'gp'
264
- | 'gq'
265
- | 'gr'
266
- | 'gs'
267
- | 'gt'
268
- | 'gu'
269
- | 'gw'
270
- | 'gy'
271
- | 'hk'
272
- | 'hm'
273
- | 'hn'
274
- | 'hr'
275
- | 'ht'
276
- | 'hu'
277
- | 'id'
278
- | 'ie'
279
- | 'il'
280
- | 'im'
281
- | 'in'
282
- | 'io'
283
- | 'iq'
284
- | 'ir'
285
- | 'is'
286
- | 'it'
287
- | 'je'
288
- | 'jm'
289
- | 'jo'
290
- | 'jp'
291
- | 'ke'
292
- | 'kg'
293
- | 'kh'
294
- | 'ki'
295
- | 'km'
296
- | 'kn'
297
- | 'kp'
298
- | 'kr'
299
- | 'kw'
300
- | 'ky'
301
- | 'kz'
302
- | 'la'
303
- | 'lb'
304
- | 'lc'
305
- | 'li'
306
- | 'lk'
307
- | 'lr'
308
- | 'ls'
309
- | 'lt'
310
- | 'lu'
311
- | 'lv'
312
- | 'ly'
313
- | 'ma'
314
- | 'mc'
315
- | 'md'
316
- | 'me'
317
- | 'mf'
318
- | 'mg'
319
- | 'mh'
320
- | 'mk'
321
- | 'ml'
322
- | 'mm'
323
- | 'mn'
324
- | 'mo'
325
- | 'mp'
326
- | 'mq'
327
- | 'mr'
328
- | 'ms'
329
- | 'mt'
330
- | 'mu'
331
- | 'mv'
332
- | 'mw'
333
- | 'mx'
334
- | 'my'
335
- | 'mz'
336
- | 'na'
337
- | 'nc'
338
- | 'ne'
339
- | 'nf'
340
- | 'ng'
341
- | 'ni'
342
- | 'nl'
343
- | 'no'
344
- | 'np'
345
- | 'nr'
346
- | 'nu'
347
- | 'nz'
348
- | 'om'
349
- | 'pa'
350
- | 'pe'
351
- | 'pf'
352
- | 'pg'
353
- | 'ph'
354
- | 'pk'
355
- | 'pl'
356
- | 'pm'
357
- | 'pn'
358
- | 'pr'
359
- | 'ps'
360
- | 'pt'
361
- | 'pw'
362
- | 'py'
363
- | 'qa'
364
- | 'qz'
365
- | 're'
366
- | 'ro'
367
- | 'rs'
368
- | 'ru'
369
- | 'rw'
370
- | 'sa'
371
- | 'sb'
372
- | 'sc'
373
- | 'sd'
374
- | 'se'
375
- | 'sg'
376
- | 'sh'
377
- | 'si'
378
- | 'sj'
379
- | 'sk'
380
- | 'sl'
381
- | 'sm'
382
- | 'sn'
383
- | 'so'
384
- | 'sr'
385
- | 'ss'
386
- | 'st'
387
- | 'sv'
388
- | 'sx'
389
- | 'sy'
390
- | 'sz'
391
- | 'tc'
392
- | 'td'
393
- | 'tf'
394
- | 'tg'
395
- | 'th'
396
- | 'tj'
397
- | 'tk'
398
- | 'tl'
399
- | 'tm'
400
- | 'tn'
401
- | 'to'
402
- | 'tr'
403
- | 'tt'
404
- | 'tv'
405
- | 'tw'
406
- | 'tz'
407
- | 'ua'
408
- | 'ug'
409
- | 'um'
410
- | 'us'
411
- | 'uy'
412
- | 'uz'
413
- | 'va'
414
- | 'vc'
415
- | 've'
416
- | 'vg'
417
- | 'vi'
418
- | 'vn'
419
- | 'vu'
420
- | 'wf'
421
- | 'ws'
422
- | 'ye'
423
- | 'yt'
424
- | 'za'
425
- | 'zm'
426
- | 'zw';
427
- }
428
-
429
- interface AdditionalName {
430
- /**
431
- * The individual's full name.
432
- */
433
- full_name: string | null;
434
-
435
- /**
436
- * The individual's first or given name.
437
- */
438
- given_name: string | null;
439
-
440
- /**
441
- * The purpose or type of the additional name.
442
- */
443
- purpose: AdditionalName.Purpose;
444
-
445
- /**
446
- * The individual's last or family name.
447
- */
448
- surname: string | null;
449
- }
450
-
451
- namespace AdditionalName {
452
- type Purpose = 'alias' | 'maiden';
453
- }
454
-
455
- interface AdditionalTermsOfService {
456
- /**
457
- * Stripe terms of service agreement.
458
- */
459
- account: AdditionalTermsOfService.Account | null;
460
- }
461
-
462
- namespace AdditionalTermsOfService {
463
- interface Account {
464
- /**
465
- * The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
466
- */
467
- date: string | null;
468
-
469
- /**
470
- * The IP address from which the Account's representative accepted the terms of service.
471
- */
472
- ip: string | null;
473
-
474
- /**
475
- * The user agent of the browser from which the Account's representative accepted the terms of service.
476
- */
477
- user_agent: string | null;
478
- }
479
- }
480
-
481
- interface Address {
482
- /**
483
- * City, district, suburb, town, or village.
484
- */
485
- city: string | null;
486
-
487
- /**
488
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
489
- */
490
- country: Address.Country | null;
491
-
492
- /**
493
- * Address line 1 (e.g., street, PO Box, or company name).
494
- */
495
- line1: string | null;
496
-
497
- /**
498
- * Address line 2 (e.g., apartment, suite, unit, or building).
499
- */
500
- line2: string | null;
501
-
502
- /**
503
- * ZIP or postal code.
504
- */
505
- postal_code: string | null;
506
-
507
- /**
508
- * State, county, province, or region.
509
- */
510
- state: string | null;
511
-
512
- /**
513
- * Town or cho-me.
514
- */
515
- town: string | null;
516
- }
517
-
518
- namespace Address {
519
- type Country =
520
- | 'ad'
521
- | 'ae'
522
- | 'af'
523
- | 'ag'
524
- | 'ai'
525
- | 'al'
526
- | 'am'
527
- | 'ao'
528
- | 'aq'
529
- | 'ar'
530
- | 'as'
531
- | 'at'
532
- | 'au'
533
- | 'aw'
534
- | 'ax'
535
- | 'az'
536
- | 'ba'
537
- | 'bb'
538
- | 'bd'
539
- | 'be'
540
- | 'bf'
541
- | 'bg'
542
- | 'bh'
543
- | 'bi'
544
- | 'bj'
545
- | 'bl'
546
- | 'bm'
547
- | 'bn'
548
- | 'bo'
549
- | 'bq'
550
- | 'br'
551
- | 'bs'
552
- | 'bt'
553
- | 'bv'
554
- | 'bw'
555
- | 'by'
556
- | 'bz'
557
- | 'ca'
558
- | 'cc'
559
- | 'cd'
560
- | 'cf'
561
- | 'cg'
562
- | 'ch'
563
- | 'ci'
564
- | 'ck'
565
- | 'cl'
566
- | 'cm'
567
- | 'cn'
568
- | 'co'
569
- | 'cr'
570
- | 'cu'
571
- | 'cv'
572
- | 'cw'
573
- | 'cx'
574
- | 'cy'
575
- | 'cz'
576
- | 'de'
577
- | 'dj'
578
- | 'dk'
579
- | 'dm'
580
- | 'do'
581
- | 'dz'
582
- | 'ec'
583
- | 'ee'
584
- | 'eg'
585
- | 'eh'
586
- | 'er'
587
- | 'es'
588
- | 'et'
589
- | 'fi'
590
- | 'fj'
591
- | 'fk'
592
- | 'fm'
593
- | 'fo'
594
- | 'fr'
595
- | 'ga'
596
- | 'gb'
597
- | 'gd'
598
- | 'ge'
599
- | 'gf'
600
- | 'gg'
601
- | 'gh'
602
- | 'gi'
603
- | 'gl'
604
- | 'gm'
605
- | 'gn'
606
- | 'gp'
607
- | 'gq'
608
- | 'gr'
609
- | 'gs'
610
- | 'gt'
611
- | 'gu'
612
- | 'gw'
613
- | 'gy'
614
- | 'hk'
615
- | 'hm'
616
- | 'hn'
617
- | 'hr'
618
- | 'ht'
619
- | 'hu'
620
- | 'id'
621
- | 'ie'
622
- | 'il'
623
- | 'im'
624
- | 'in'
625
- | 'io'
626
- | 'iq'
627
- | 'ir'
628
- | 'is'
629
- | 'it'
630
- | 'je'
631
- | 'jm'
632
- | 'jo'
633
- | 'jp'
634
- | 'ke'
635
- | 'kg'
636
- | 'kh'
637
- | 'ki'
638
- | 'km'
639
- | 'kn'
640
- | 'kp'
641
- | 'kr'
642
- | 'kw'
643
- | 'ky'
644
- | 'kz'
645
- | 'la'
646
- | 'lb'
647
- | 'lc'
648
- | 'li'
649
- | 'lk'
650
- | 'lr'
651
- | 'ls'
652
- | 'lt'
653
- | 'lu'
654
- | 'lv'
655
- | 'ly'
656
- | 'ma'
657
- | 'mc'
658
- | 'md'
659
- | 'me'
660
- | 'mf'
661
- | 'mg'
662
- | 'mh'
663
- | 'mk'
664
- | 'ml'
665
- | 'mm'
666
- | 'mn'
667
- | 'mo'
668
- | 'mp'
669
- | 'mq'
670
- | 'mr'
671
- | 'ms'
672
- | 'mt'
673
- | 'mu'
674
- | 'mv'
675
- | 'mw'
676
- | 'mx'
677
- | 'my'
678
- | 'mz'
679
- | 'na'
680
- | 'nc'
681
- | 'ne'
682
- | 'nf'
683
- | 'ng'
684
- | 'ni'
685
- | 'nl'
686
- | 'no'
687
- | 'np'
688
- | 'nr'
689
- | 'nu'
690
- | 'nz'
691
- | 'om'
692
- | 'pa'
693
- | 'pe'
694
- | 'pf'
695
- | 'pg'
696
- | 'ph'
697
- | 'pk'
698
- | 'pl'
699
- | 'pm'
700
- | 'pn'
701
- | 'pr'
702
- | 'ps'
703
- | 'pt'
704
- | 'pw'
705
- | 'py'
706
- | 'qa'
707
- | 'qz'
708
- | 're'
709
- | 'ro'
710
- | 'rs'
711
- | 'ru'
712
- | 'rw'
713
- | 'sa'
714
- | 'sb'
715
- | 'sc'
716
- | 'sd'
717
- | 'se'
718
- | 'sg'
719
- | 'sh'
720
- | 'si'
721
- | 'sj'
722
- | 'sk'
723
- | 'sl'
724
- | 'sm'
725
- | 'sn'
726
- | 'so'
727
- | 'sr'
728
- | 'ss'
729
- | 'st'
730
- | 'sv'
731
- | 'sx'
732
- | 'sy'
733
- | 'sz'
734
- | 'tc'
735
- | 'td'
736
- | 'tf'
737
- | 'tg'
738
- | 'th'
739
- | 'tj'
740
- | 'tk'
741
- | 'tl'
742
- | 'tm'
743
- | 'tn'
744
- | 'to'
745
- | 'tr'
746
- | 'tt'
747
- | 'tv'
748
- | 'tw'
749
- | 'tz'
750
- | 'ua'
751
- | 'ug'
752
- | 'um'
753
- | 'us'
754
- | 'uy'
755
- | 'uz'
756
- | 'va'
757
- | 'vc'
758
- | 've'
759
- | 'vg'
760
- | 'vi'
761
- | 'vn'
762
- | 'vu'
763
- | 'wf'
764
- | 'ws'
765
- | 'ye'
766
- | 'yt'
767
- | 'za'
768
- | 'zm'
769
- | 'zw';
770
- }
771
-
772
- interface DateOfBirth {
773
- /**
774
- * The day of birth, between 1 and 31.
775
- */
776
- day: number;
777
-
778
- /**
779
- * The month of birth, between 1 and 12.
780
- */
781
- month: number;
782
-
783
- /**
784
- * The four-digit year of birth.
785
- */
786
- year: number;
787
- }
788
-
789
- interface Documents {
790
- /**
791
- * One or more documents that demonstrate proof that this person is authorized to represent the company.
792
- */
793
- company_authorization: Documents.CompanyAuthorization | null;
794
-
795
- /**
796
- * One or more documents showing the person's passport page with photo and personal data.
797
- */
798
- passport: Documents.Passport | null;
799
-
800
- /**
801
- * An identifying document showing the person's name, either a passport or local ID card.
802
- */
803
- primary_verification: Documents.PrimaryVerification | null;
804
-
805
- /**
806
- * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
807
- */
808
- secondary_verification: Documents.SecondaryVerification | null;
809
-
810
- /**
811
- * One or more documents showing the person's visa required for living in the country where they are residing.
812
- */
813
- visa: Documents.Visa | null;
814
- }
815
-
816
- namespace Documents {
817
- interface CompanyAuthorization {
818
- /**
819
- * 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`.
820
- */
821
- files: Array<string>;
822
-
823
- /**
824
- * The format of the document. Currently supports `files` only.
825
- */
826
- type: 'files';
827
- }
828
-
829
- interface Passport {
830
- /**
831
- * 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`.
832
- */
833
- files: Array<string>;
834
-
835
- /**
836
- * The format of the document. Currently supports `files` only.
837
- */
838
- type: 'files';
839
- }
840
-
841
- interface PrimaryVerification {
842
- /**
843
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document.
844
- */
845
- front_back: PrimaryVerification.FrontBack;
846
-
847
- /**
848
- * The format of the verification document. Currently supports `front_back` only.
849
- */
850
- type: 'front_back';
851
- }
852
-
853
- namespace PrimaryVerification {
854
- interface FrontBack {
855
- /**
856
- * 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.
857
- */
858
- back: string | null;
859
-
860
- /**
861
- * 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.
862
- */
863
- front: string;
864
- }
865
- }
866
-
867
- interface SecondaryVerification {
868
- /**
869
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document.
870
- */
871
- front_back: SecondaryVerification.FrontBack;
872
-
873
- /**
874
- * The format of the verification document. Currently supports `front_back` only.
875
- */
876
- type: 'front_back';
877
- }
878
-
879
- namespace SecondaryVerification {
880
- interface FrontBack {
881
- /**
882
- * 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.
883
- */
884
- back: string | null;
885
-
886
- /**
887
- * 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.
888
- */
889
- front: string;
890
- }
891
- }
892
-
893
- interface Visa {
894
- /**
895
- * 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`.
896
- */
897
- files: Array<string>;
898
-
899
- /**
900
- * The format of the document. Currently supports `files` only.
901
- */
902
- type: 'files';
903
- }
904
- }
905
-
906
- interface IdNumber {
907
- /**
908
- * The ID number type of an individual.
909
- */
910
- type: IdNumber.Type;
911
- }
912
-
913
- namespace IdNumber {
914
- type Type =
915
- | 'ae_eid'
916
- | 'br_cpf'
917
- | 'de_stn'
918
- | 'hk_id'
919
- | 'mx_rfc'
920
- | 'my_nric'
921
- | 'nl_bsn'
922
- | 'sg_fin'
923
- | 'sg_nric'
924
- | 'th_lc'
925
- | 'th_pin'
926
- | 'us_itin'
927
- | 'us_itin_last_4'
928
- | 'us_ssn'
929
- | 'us_ssn_last_4';
930
- }
931
-
932
- type LegalGender = 'female' | 'male';
933
-
934
- type Nationality =
935
- | 'ad'
936
- | 'ae'
937
- | 'af'
938
- | 'ag'
939
- | 'ai'
940
- | 'al'
941
- | 'am'
942
- | 'ao'
943
- | 'aq'
944
- | 'ar'
945
- | 'as'
946
- | 'at'
947
- | 'au'
948
- | 'aw'
949
- | 'ax'
950
- | 'az'
951
- | 'ba'
952
- | 'bb'
953
- | 'bd'
954
- | 'be'
955
- | 'bf'
956
- | 'bg'
957
- | 'bh'
958
- | 'bi'
959
- | 'bj'
960
- | 'bl'
961
- | 'bm'
962
- | 'bn'
963
- | 'bo'
964
- | 'bq'
965
- | 'br'
966
- | 'bs'
967
- | 'bt'
968
- | 'bv'
969
- | 'bw'
970
- | 'by'
971
- | 'bz'
972
- | 'ca'
973
- | 'cc'
974
- | 'cd'
975
- | 'cf'
976
- | 'cg'
977
- | 'ch'
978
- | 'ci'
979
- | 'ck'
980
- | 'cl'
981
- | 'cm'
982
- | 'cn'
983
- | 'co'
984
- | 'cr'
985
- | 'cu'
986
- | 'cv'
987
- | 'cw'
988
- | 'cx'
989
- | 'cy'
990
- | 'cz'
991
- | 'de'
992
- | 'dj'
993
- | 'dk'
994
- | 'dm'
995
- | 'do'
996
- | 'dz'
997
- | 'ec'
998
- | 'ee'
999
- | 'eg'
1000
- | 'eh'
1001
- | 'er'
1002
- | 'es'
1003
- | 'et'
1004
- | 'fi'
1005
- | 'fj'
1006
- | 'fk'
1007
- | 'fm'
1008
- | 'fo'
1009
- | 'fr'
1010
- | 'ga'
1011
- | 'gb'
1012
- | 'gd'
1013
- | 'ge'
1014
- | 'gf'
1015
- | 'gg'
1016
- | 'gh'
1017
- | 'gi'
1018
- | 'gl'
1019
- | 'gm'
1020
- | 'gn'
1021
- | 'gp'
1022
- | 'gq'
1023
- | 'gr'
1024
- | 'gs'
1025
- | 'gt'
1026
- | 'gu'
1027
- | 'gw'
1028
- | 'gy'
1029
- | 'hk'
1030
- | 'hm'
1031
- | 'hn'
1032
- | 'hr'
1033
- | 'ht'
1034
- | 'hu'
1035
- | 'id'
1036
- | 'ie'
1037
- | 'il'
1038
- | 'im'
1039
- | 'in'
1040
- | 'io'
1041
- | 'iq'
1042
- | 'ir'
1043
- | 'is'
1044
- | 'it'
1045
- | 'je'
1046
- | 'jm'
1047
- | 'jo'
1048
- | 'jp'
1049
- | 'ke'
1050
- | 'kg'
1051
- | 'kh'
1052
- | 'ki'
1053
- | 'km'
1054
- | 'kn'
1055
- | 'kp'
1056
- | 'kr'
1057
- | 'kw'
1058
- | 'ky'
1059
- | 'kz'
1060
- | 'la'
1061
- | 'lb'
1062
- | 'lc'
1063
- | 'li'
1064
- | 'lk'
1065
- | 'lr'
1066
- | 'ls'
1067
- | 'lt'
1068
- | 'lu'
1069
- | 'lv'
1070
- | 'ly'
1071
- | 'ma'
1072
- | 'mc'
1073
- | 'md'
1074
- | 'me'
1075
- | 'mf'
1076
- | 'mg'
1077
- | 'mh'
1078
- | 'mk'
1079
- | 'ml'
1080
- | 'mm'
1081
- | 'mn'
1082
- | 'mo'
1083
- | 'mp'
1084
- | 'mq'
1085
- | 'mr'
1086
- | 'ms'
1087
- | 'mt'
1088
- | 'mu'
1089
- | 'mv'
1090
- | 'mw'
1091
- | 'mx'
1092
- | 'my'
1093
- | 'mz'
1094
- | 'na'
1095
- | 'nc'
1096
- | 'ne'
1097
- | 'nf'
1098
- | 'ng'
1099
- | 'ni'
1100
- | 'nl'
1101
- | 'no'
1102
- | 'np'
1103
- | 'nr'
1104
- | 'nu'
1105
- | 'nz'
1106
- | 'om'
1107
- | 'pa'
1108
- | 'pe'
1109
- | 'pf'
1110
- | 'pg'
1111
- | 'ph'
1112
- | 'pk'
1113
- | 'pl'
1114
- | 'pm'
1115
- | 'pn'
1116
- | 'pr'
1117
- | 'ps'
1118
- | 'pt'
1119
- | 'pw'
1120
- | 'py'
1121
- | 'qa'
1122
- | 'qz'
1123
- | 're'
1124
- | 'ro'
1125
- | 'rs'
1126
- | 'ru'
1127
- | 'rw'
1128
- | 'sa'
1129
- | 'sb'
1130
- | 'sc'
1131
- | 'sd'
1132
- | 'se'
1133
- | 'sg'
1134
- | 'sh'
1135
- | 'si'
1136
- | 'sj'
1137
- | 'sk'
1138
- | 'sl'
1139
- | 'sm'
1140
- | 'sn'
1141
- | 'so'
1142
- | 'sr'
1143
- | 'ss'
1144
- | 'st'
1145
- | 'sv'
1146
- | 'sx'
1147
- | 'sy'
1148
- | 'sz'
1149
- | 'tc'
1150
- | 'td'
1151
- | 'tf'
1152
- | 'tg'
1153
- | 'th'
1154
- | 'tj'
1155
- | 'tk'
1156
- | 'tl'
1157
- | 'tm'
1158
- | 'tn'
1159
- | 'to'
1160
- | 'tr'
1161
- | 'tt'
1162
- | 'tv'
1163
- | 'tw'
1164
- | 'tz'
1165
- | 'ua'
1166
- | 'ug'
1167
- | 'um'
1168
- | 'us'
1169
- | 'uy'
1170
- | 'uz'
1171
- | 'va'
1172
- | 'vc'
1173
- | 've'
1174
- | 'vg'
1175
- | 'vi'
1176
- | 'vn'
1177
- | 'vu'
1178
- | 'wf'
1179
- | 'ws'
1180
- | 'ye'
1181
- | 'yt'
1182
- | 'za'
1183
- | 'zm'
1184
- | 'zw';
1185
-
1186
- type PoliticalExposure = 'existing' | 'none';
1187
-
1188
- interface Relationship {
1189
- /**
1190
- * Whether the individual is an authorizer of the Account's legal entity.
1191
- */
1192
- authorizer: boolean | null;
1193
-
1194
- /**
1195
- * Whether the individual is a director of the Account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
1196
- */
1197
- director: boolean | null;
1198
-
1199
- /**
1200
- * Whether the individual has significant responsibility to control, manage, or direct the organization.
1201
- */
1202
- executive: boolean | null;
1203
-
1204
- /**
1205
- * Whether the individual is the legal guardian of the Account's representative.
1206
- */
1207
- legal_guardian: boolean | null;
1208
-
1209
- /**
1210
- * Whether the individual is an owner of the Account's legal entity.
1211
- */
1212
- owner: boolean | null;
1213
-
1214
- /**
1215
- * The percent owned by the individual of the Account's legal entity.
1216
- */
1217
- percent_ownership: string | null;
1218
-
1219
- /**
1220
- * Whether the individual is authorized as the primary representative of the Account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
1221
- */
1222
- representative: boolean | null;
1223
-
1224
- /**
1225
- * The individual's title (e.g., CEO, Support Engineer).
1226
- */
1227
- title: string | null;
1228
- }
1229
-
1230
- interface ScriptAddresses {
1231
- /**
1232
- * Kana Address.
1233
- */
1234
- kana: ScriptAddresses.Kana | null;
1235
-
1236
- /**
1237
- * Kanji Address.
1238
- */
1239
- kanji: ScriptAddresses.Kanji | null;
1240
- }
1241
-
1242
- namespace ScriptAddresses {
1243
- interface Kana {
1244
- /**
1245
- * City, district, suburb, town, or village.
1246
- */
1247
- city: string | null;
1248
-
1249
- /**
1250
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1251
- */
1252
- country: Kana.Country | null;
1253
-
1254
- /**
1255
- * Address line 1 (e.g., street, PO Box, or company name).
1256
- */
1257
- line1: string | null;
1258
-
1259
- /**
1260
- * Address line 2 (e.g., apartment, suite, unit, or building).
1261
- */
1262
- line2: string | null;
1263
-
1264
- /**
1265
- * ZIP or postal code.
1266
- */
1267
- postal_code: string | null;
1268
-
1269
- /**
1270
- * State, county, province, or region.
1271
- */
1272
- state: string | null;
1273
-
1274
- /**
1275
- * Town or cho-me.
1276
- */
1277
- town: string | null;
1278
- }
1279
-
1280
- namespace Kana {
1281
- type Country =
1282
- | 'ad'
1283
- | 'ae'
1284
- | 'af'
1285
- | 'ag'
1286
- | 'ai'
1287
- | 'al'
1288
- | 'am'
1289
- | 'ao'
1290
- | 'aq'
1291
- | 'ar'
1292
- | 'as'
1293
- | 'at'
1294
- | 'au'
1295
- | 'aw'
1296
- | 'ax'
1297
- | 'az'
1298
- | 'ba'
1299
- | 'bb'
1300
- | 'bd'
1301
- | 'be'
1302
- | 'bf'
1303
- | 'bg'
1304
- | 'bh'
1305
- | 'bi'
1306
- | 'bj'
1307
- | 'bl'
1308
- | 'bm'
1309
- | 'bn'
1310
- | 'bo'
1311
- | 'bq'
1312
- | 'br'
1313
- | 'bs'
1314
- | 'bt'
1315
- | 'bv'
1316
- | 'bw'
1317
- | 'by'
1318
- | 'bz'
1319
- | 'ca'
1320
- | 'cc'
1321
- | 'cd'
1322
- | 'cf'
1323
- | 'cg'
1324
- | 'ch'
1325
- | 'ci'
1326
- | 'ck'
1327
- | 'cl'
1328
- | 'cm'
1329
- | 'cn'
1330
- | 'co'
1331
- | 'cr'
1332
- | 'cu'
1333
- | 'cv'
1334
- | 'cw'
1335
- | 'cx'
1336
- | 'cy'
1337
- | 'cz'
1338
- | 'de'
1339
- | 'dj'
1340
- | 'dk'
1341
- | 'dm'
1342
- | 'do'
1343
- | 'dz'
1344
- | 'ec'
1345
- | 'ee'
1346
- | 'eg'
1347
- | 'eh'
1348
- | 'er'
1349
- | 'es'
1350
- | 'et'
1351
- | 'fi'
1352
- | 'fj'
1353
- | 'fk'
1354
- | 'fm'
1355
- | 'fo'
1356
- | 'fr'
1357
- | 'ga'
1358
- | 'gb'
1359
- | 'gd'
1360
- | 'ge'
1361
- | 'gf'
1362
- | 'gg'
1363
- | 'gh'
1364
- | 'gi'
1365
- | 'gl'
1366
- | 'gm'
1367
- | 'gn'
1368
- | 'gp'
1369
- | 'gq'
1370
- | 'gr'
1371
- | 'gs'
1372
- | 'gt'
1373
- | 'gu'
1374
- | 'gw'
1375
- | 'gy'
1376
- | 'hk'
1377
- | 'hm'
1378
- | 'hn'
1379
- | 'hr'
1380
- | 'ht'
1381
- | 'hu'
1382
- | 'id'
1383
- | 'ie'
1384
- | 'il'
1385
- | 'im'
1386
- | 'in'
1387
- | 'io'
1388
- | 'iq'
1389
- | 'ir'
1390
- | 'is'
1391
- | 'it'
1392
- | 'je'
1393
- | 'jm'
1394
- | 'jo'
1395
- | 'jp'
1396
- | 'ke'
1397
- | 'kg'
1398
- | 'kh'
1399
- | 'ki'
1400
- | 'km'
1401
- | 'kn'
1402
- | 'kp'
1403
- | 'kr'
1404
- | 'kw'
1405
- | 'ky'
1406
- | 'kz'
1407
- | 'la'
1408
- | 'lb'
1409
- | 'lc'
1410
- | 'li'
1411
- | 'lk'
1412
- | 'lr'
1413
- | 'ls'
1414
- | 'lt'
1415
- | 'lu'
1416
- | 'lv'
1417
- | 'ly'
1418
- | 'ma'
1419
- | 'mc'
1420
- | 'md'
1421
- | 'me'
1422
- | 'mf'
1423
- | 'mg'
1424
- | 'mh'
1425
- | 'mk'
1426
- | 'ml'
1427
- | 'mm'
1428
- | 'mn'
1429
- | 'mo'
1430
- | 'mp'
1431
- | 'mq'
1432
- | 'mr'
1433
- | 'ms'
1434
- | 'mt'
1435
- | 'mu'
1436
- | 'mv'
1437
- | 'mw'
1438
- | 'mx'
1439
- | 'my'
1440
- | 'mz'
1441
- | 'na'
1442
- | 'nc'
1443
- | 'ne'
1444
- | 'nf'
1445
- | 'ng'
1446
- | 'ni'
1447
- | 'nl'
1448
- | 'no'
1449
- | 'np'
1450
- | 'nr'
1451
- | 'nu'
1452
- | 'nz'
1453
- | 'om'
1454
- | 'pa'
1455
- | 'pe'
1456
- | 'pf'
1457
- | 'pg'
1458
- | 'ph'
1459
- | 'pk'
1460
- | 'pl'
1461
- | 'pm'
1462
- | 'pn'
1463
- | 'pr'
1464
- | 'ps'
1465
- | 'pt'
1466
- | 'pw'
1467
- | 'py'
1468
- | 'qa'
1469
- | 'qz'
1470
- | 're'
1471
- | 'ro'
1472
- | 'rs'
1473
- | 'ru'
1474
- | 'rw'
1475
- | 'sa'
1476
- | 'sb'
1477
- | 'sc'
1478
- | 'sd'
1479
- | 'se'
1480
- | 'sg'
1481
- | 'sh'
1482
- | 'si'
1483
- | 'sj'
1484
- | 'sk'
1485
- | 'sl'
1486
- | 'sm'
1487
- | 'sn'
1488
- | 'so'
1489
- | 'sr'
1490
- | 'ss'
1491
- | 'st'
1492
- | 'sv'
1493
- | 'sx'
1494
- | 'sy'
1495
- | 'sz'
1496
- | 'tc'
1497
- | 'td'
1498
- | 'tf'
1499
- | 'tg'
1500
- | 'th'
1501
- | 'tj'
1502
- | 'tk'
1503
- | 'tl'
1504
- | 'tm'
1505
- | 'tn'
1506
- | 'to'
1507
- | 'tr'
1508
- | 'tt'
1509
- | 'tv'
1510
- | 'tw'
1511
- | 'tz'
1512
- | 'ua'
1513
- | 'ug'
1514
- | 'um'
1515
- | 'us'
1516
- | 'uy'
1517
- | 'uz'
1518
- | 'va'
1519
- | 'vc'
1520
- | 've'
1521
- | 'vg'
1522
- | 'vi'
1523
- | 'vn'
1524
- | 'vu'
1525
- | 'wf'
1526
- | 'ws'
1527
- | 'ye'
1528
- | 'yt'
1529
- | 'za'
1530
- | 'zm'
1531
- | 'zw';
1532
- }
1533
-
1534
- interface Kanji {
1535
- /**
1536
- * City, district, suburb, town, or village.
1537
- */
1538
- city: string | null;
1539
-
1540
- /**
1541
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1542
- */
1543
- country: Kanji.Country | null;
1544
-
1545
- /**
1546
- * Address line 1 (e.g., street, PO Box, or company name).
1547
- */
1548
- line1: string | null;
1549
-
1550
- /**
1551
- * Address line 2 (e.g., apartment, suite, unit, or building).
1552
- */
1553
- line2: string | null;
1554
-
1555
- /**
1556
- * ZIP or postal code.
1557
- */
1558
- postal_code: string | null;
1559
-
1560
- /**
1561
- * State, county, province, or region.
1562
- */
1563
- state: string | null;
1564
-
1565
- /**
1566
- * Town or cho-me.
1567
- */
1568
- town: string | null;
1569
- }
1570
-
1571
- namespace Kanji {
1572
- type Country =
1573
- | 'ad'
1574
- | 'ae'
1575
- | 'af'
1576
- | 'ag'
1577
- | 'ai'
1578
- | 'al'
1579
- | 'am'
1580
- | 'ao'
1581
- | 'aq'
1582
- | 'ar'
1583
- | 'as'
1584
- | 'at'
1585
- | 'au'
1586
- | 'aw'
1587
- | 'ax'
1588
- | 'az'
1589
- | 'ba'
1590
- | 'bb'
1591
- | 'bd'
1592
- | 'be'
1593
- | 'bf'
1594
- | 'bg'
1595
- | 'bh'
1596
- | 'bi'
1597
- | 'bj'
1598
- | 'bl'
1599
- | 'bm'
1600
- | 'bn'
1601
- | 'bo'
1602
- | 'bq'
1603
- | 'br'
1604
- | 'bs'
1605
- | 'bt'
1606
- | 'bv'
1607
- | 'bw'
1608
- | 'by'
1609
- | 'bz'
1610
- | 'ca'
1611
- | 'cc'
1612
- | 'cd'
1613
- | 'cf'
1614
- | 'cg'
1615
- | 'ch'
1616
- | 'ci'
1617
- | 'ck'
1618
- | 'cl'
1619
- | 'cm'
1620
- | 'cn'
1621
- | 'co'
1622
- | 'cr'
1623
- | 'cu'
1624
- | 'cv'
1625
- | 'cw'
1626
- | 'cx'
1627
- | 'cy'
1628
- | 'cz'
1629
- | 'de'
1630
- | 'dj'
1631
- | 'dk'
1632
- | 'dm'
1633
- | 'do'
1634
- | 'dz'
1635
- | 'ec'
1636
- | 'ee'
1637
- | 'eg'
1638
- | 'eh'
1639
- | 'er'
1640
- | 'es'
1641
- | 'et'
1642
- | 'fi'
1643
- | 'fj'
1644
- | 'fk'
1645
- | 'fm'
1646
- | 'fo'
1647
- | 'fr'
1648
- | 'ga'
1649
- | 'gb'
1650
- | 'gd'
1651
- | 'ge'
1652
- | 'gf'
1653
- | 'gg'
1654
- | 'gh'
1655
- | 'gi'
1656
- | 'gl'
1657
- | 'gm'
1658
- | 'gn'
1659
- | 'gp'
1660
- | 'gq'
1661
- | 'gr'
1662
- | 'gs'
1663
- | 'gt'
1664
- | 'gu'
1665
- | 'gw'
1666
- | 'gy'
1667
- | 'hk'
1668
- | 'hm'
1669
- | 'hn'
1670
- | 'hr'
1671
- | 'ht'
1672
- | 'hu'
1673
- | 'id'
1674
- | 'ie'
1675
- | 'il'
1676
- | 'im'
1677
- | 'in'
1678
- | 'io'
1679
- | 'iq'
1680
- | 'ir'
1681
- | 'is'
1682
- | 'it'
1683
- | 'je'
1684
- | 'jm'
1685
- | 'jo'
1686
- | 'jp'
1687
- | 'ke'
1688
- | 'kg'
1689
- | 'kh'
1690
- | 'ki'
1691
- | 'km'
1692
- | 'kn'
1693
- | 'kp'
1694
- | 'kr'
1695
- | 'kw'
1696
- | 'ky'
1697
- | 'kz'
1698
- | 'la'
1699
- | 'lb'
1700
- | 'lc'
1701
- | 'li'
1702
- | 'lk'
1703
- | 'lr'
1704
- | 'ls'
1705
- | 'lt'
1706
- | 'lu'
1707
- | 'lv'
1708
- | 'ly'
1709
- | 'ma'
1710
- | 'mc'
1711
- | 'md'
1712
- | 'me'
1713
- | 'mf'
1714
- | 'mg'
1715
- | 'mh'
1716
- | 'mk'
1717
- | 'ml'
1718
- | 'mm'
1719
- | 'mn'
1720
- | 'mo'
1721
- | 'mp'
1722
- | 'mq'
1723
- | 'mr'
1724
- | 'ms'
1725
- | 'mt'
1726
- | 'mu'
1727
- | 'mv'
1728
- | 'mw'
1729
- | 'mx'
1730
- | 'my'
1731
- | 'mz'
1732
- | 'na'
1733
- | 'nc'
1734
- | 'ne'
1735
- | 'nf'
1736
- | 'ng'
1737
- | 'ni'
1738
- | 'nl'
1739
- | 'no'
1740
- | 'np'
1741
- | 'nr'
1742
- | 'nu'
1743
- | 'nz'
1744
- | 'om'
1745
- | 'pa'
1746
- | 'pe'
1747
- | 'pf'
1748
- | 'pg'
1749
- | 'ph'
1750
- | 'pk'
1751
- | 'pl'
1752
- | 'pm'
1753
- | 'pn'
1754
- | 'pr'
1755
- | 'ps'
1756
- | 'pt'
1757
- | 'pw'
1758
- | 'py'
1759
- | 'qa'
1760
- | 'qz'
1761
- | 're'
1762
- | 'ro'
1763
- | 'rs'
1764
- | 'ru'
1765
- | 'rw'
1766
- | 'sa'
1767
- | 'sb'
1768
- | 'sc'
1769
- | 'sd'
1770
- | 'se'
1771
- | 'sg'
1772
- | 'sh'
1773
- | 'si'
1774
- | 'sj'
1775
- | 'sk'
1776
- | 'sl'
1777
- | 'sm'
1778
- | 'sn'
1779
- | 'so'
1780
- | 'sr'
1781
- | 'ss'
1782
- | 'st'
1783
- | 'sv'
1784
- | 'sx'
1785
- | 'sy'
1786
- | 'sz'
1787
- | 'tc'
1788
- | 'td'
1789
- | 'tf'
1790
- | 'tg'
1791
- | 'th'
1792
- | 'tj'
1793
- | 'tk'
1794
- | 'tl'
1795
- | 'tm'
1796
- | 'tn'
1797
- | 'to'
1798
- | 'tr'
1799
- | 'tt'
1800
- | 'tv'
1801
- | 'tw'
1802
- | 'tz'
1803
- | 'ua'
1804
- | 'ug'
1805
- | 'um'
1806
- | 'us'
1807
- | 'uy'
1808
- | 'uz'
1809
- | 'va'
1810
- | 'vc'
1811
- | 've'
1812
- | 'vg'
1813
- | 'vi'
1814
- | 'vn'
1815
- | 'vu'
1816
- | 'wf'
1817
- | 'ws'
1818
- | 'ye'
1819
- | 'yt'
1820
- | 'za'
1821
- | 'zm'
1822
- | 'zw';
1823
- }
1824
- }
1825
-
1826
- interface ScriptNames {
1827
- /**
1828
- * Persons name in kana script.
1829
- */
1830
- kana: ScriptNames.Kana | null;
1831
-
1832
- /**
1833
- * Persons name in kanji script.
1834
- */
1835
- kanji: ScriptNames.Kanji | null;
1836
- }
1837
-
1838
- namespace ScriptNames {
1839
- interface Kana {
1840
- /**
1841
- * The person's first or given name.
1842
- */
1843
- given_name: string | null;
1844
-
1845
- /**
1846
- * The person's last or family name.
1847
- */
1848
- surname: string | null;
1849
- }
1850
-
1851
- interface Kanji {
1852
- /**
1853
- * The person's first or given name.
1854
- */
1855
- given_name: string | null;
1856
-
1857
- /**
1858
- * The person's last or family name.
1859
- */
1860
- surname: string | null;
1861
- }
1862
- }
1863
- }
1864
- }
1865
- }
1866
- }
1867
- }