stripe 18.1.0-beta.3 → 18.1.0

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 (317) hide show
  1. package/CHANGELOG.md +140 -1208
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +0 -1
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +3 -93
  6. package/cjs/RequestSender.js +3 -7
  7. package/cjs/Webhooks.js +6 -2
  8. package/cjs/apiVersion.js +1 -1
  9. package/cjs/net/FetchHttpClient.js +3 -4
  10. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  11. package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
  12. package/cjs/resources/Invoices.js +0 -4
  13. package/cjs/resources/PaymentIntents.js +0 -13
  14. package/cjs/resources/Quotes.js +0 -32
  15. package/cjs/resources/SubscriptionSchedules.js +0 -4
  16. package/cjs/resources/Terminal/Readers.js +0 -12
  17. package/cjs/resources/TestHelpers/Terminal/Readers.js +0 -8
  18. package/cjs/resources.js +18 -108
  19. package/cjs/stripe.core.js +2 -4
  20. package/cjs/utils.js +28 -4
  21. package/esm/Error.js +2 -81
  22. package/esm/RequestSender.js +4 -8
  23. package/esm/Webhooks.js +6 -2
  24. package/esm/apiVersion.js +1 -1
  25. package/esm/net/FetchHttpClient.js +3 -4
  26. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  27. package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
  28. package/esm/resources/Invoices.js +0 -4
  29. package/esm/resources/PaymentIntents.js +0 -13
  30. package/esm/resources/Quotes.js +0 -32
  31. package/esm/resources/SubscriptionSchedules.js +0 -4
  32. package/esm/resources/Terminal/Readers.js +0 -12
  33. package/esm/resources/TestHelpers/Terminal/Readers.js +0 -8
  34. package/esm/resources.js +1 -84
  35. package/esm/stripe.core.js +2 -4
  36. package/esm/utils.js +24 -3
  37. package/package.json +12 -3
  38. package/types/AccountLinksResource.d.ts +1 -5
  39. package/types/AccountSessions.d.ts +0 -45
  40. package/types/AccountSessionsResource.d.ts +0 -300
  41. package/types/Accounts.d.ts +1 -212
  42. package/types/AccountsResource.d.ts +2 -546
  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 +0 -5
  49. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  50. package/types/Cards.d.ts +0 -5
  51. package/types/CashBalances.d.ts +0 -5
  52. package/types/Charges.d.ts +0 -166
  53. package/types/ChargesResource.d.ts +0 -1314
  54. package/types/Checkout/Sessions.d.ts +13 -306
  55. package/types/Checkout/SessionsResource.d.ts +1 -333
  56. package/types/ConfirmationTokens.d.ts +0 -120
  57. package/types/Coupons.d.ts +0 -33
  58. package/types/CouponsResource.d.ts +0 -21
  59. package/types/CreditNoteLineItems.d.ts +0 -17
  60. package/types/CreditNotes.d.ts +0 -9
  61. package/types/CreditNotesResource.d.ts +0 -5
  62. package/types/CustomerBalanceTransactions.d.ts +0 -2
  63. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  64. package/types/CustomerSessions.d.ts +0 -5
  65. package/types/CustomerSessionsResource.d.ts +1 -6
  66. package/types/Customers.d.ts +0 -2
  67. package/types/CustomersResource.d.ts +23 -11
  68. package/types/Discounts.d.ts +0 -10
  69. package/types/Errors.d.ts +2 -69
  70. package/types/EventTypes.d.ts +0 -698
  71. package/types/Events.d.ts +1 -100
  72. package/types/FinancialConnections/Accounts.d.ts +1 -31
  73. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  74. package/types/FinancialConnections/Sessions.d.ts +1 -51
  75. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  76. package/types/Identity/VerificationSessions.d.ts +0 -5
  77. package/types/Identity/VerificationSessionsResource.d.ts +0 -7
  78. package/types/InvoiceItems.d.ts +0 -10
  79. package/types/InvoiceItemsResource.d.ts +6 -117
  80. package/types/InvoiceLineItems.d.ts +2 -46
  81. package/types/InvoicePayments.d.ts +0 -5
  82. package/types/InvoicePaymentsResource.d.ts +74 -0
  83. package/types/Invoices.d.ts +15 -138
  84. package/types/InvoicesResource.d.ts +15 -1471
  85. package/types/Issuing/CardholdersResource.d.ts +1 -2
  86. package/types/Issuing/Transactions.d.ts +0 -5
  87. package/types/Issuing/TransactionsResource.d.ts +0 -5
  88. package/types/LineItems.d.ts +0 -49
  89. package/types/Mandates.d.ts +0 -77
  90. package/types/PaymentIntents.d.ts +2 -728
  91. package/types/PaymentIntentsResource.d.ts +3955 -8479
  92. package/types/PaymentLinks.d.ts +0 -6
  93. package/types/PaymentLinksResource.d.ts +0 -12
  94. package/types/PaymentMethodConfigurations.d.ts +0 -180
  95. package/types/PaymentMethodConfigurationsResource.d.ts +0 -250
  96. package/types/PaymentMethods.d.ts +0 -120
  97. package/types/PaymentMethodsResource.d.ts +2 -167
  98. package/types/Payouts.d.ts +0 -5
  99. package/types/PayoutsResource.d.ts +0 -5
  100. package/types/Prices.d.ts +0 -22
  101. package/types/PricesResource.d.ts +0 -22
  102. package/types/Products.d.ts +0 -39
  103. package/types/ProductsResource.d.ts +0 -36
  104. package/types/PromotionCodes.d.ts +0 -5
  105. package/types/PromotionCodesResource.d.ts +0 -10
  106. package/types/Quotes.d.ts +2 -597
  107. package/types/QuotesResource.d.ts +224 -2571
  108. package/types/Refunds.d.ts +0 -14
  109. package/types/SetupAttempts.d.ts +1 -50
  110. package/types/SetupIntents.d.ts +2 -121
  111. package/types/SetupIntentsResource.d.ts +3 -730
  112. package/types/Sources.d.ts +0 -29
  113. package/types/SubscriptionItems.d.ts +0 -23
  114. package/types/SubscriptionItemsResource.d.ts +0 -109
  115. package/types/SubscriptionSchedules.d.ts +0 -205
  116. package/types/SubscriptionSchedulesResource.d.ts +8 -1236
  117. package/types/Subscriptions.d.ts +1 -97
  118. package/types/SubscriptionsResource.d.ts +9 -391
  119. package/types/Tax/Calculations.d.ts +11 -1
  120. package/types/Tax/CalculationsResource.d.ts +11 -1
  121. package/types/Tax/Registrations.d.ts +27 -0
  122. package/types/Tax/RegistrationsResource.d.ts +36 -0
  123. package/types/Tax/Transactions.d.ts +11 -1
  124. package/types/TaxIds.d.ts +11 -11
  125. package/types/TaxIdsResource.d.ts +11 -11
  126. package/types/Terminal/Readers.d.ts +0 -300
  127. package/types/Terminal/ReadersResource.d.ts +0 -220
  128. package/types/TestHelpers/ConfirmationTokensResource.d.ts +7 -127
  129. package/types/TestHelpers/Terminal/ReadersResource.d.ts +0 -53
  130. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  131. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  132. package/types/Transfers.d.ts +0 -5
  133. package/types/TransfersResource.d.ts +0 -5
  134. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  135. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  136. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  137. package/types/Treasury/OutboundPaymentsResource.d.ts +0 -5
  138. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  139. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  140. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  141. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  142. package/types/V2/EventTypes.d.ts +7 -677
  143. package/types/WebhookEndpointsResource.d.ts +4 -85
  144. package/types/index.d.ts +5 -146
  145. package/types/lib.d.ts +1 -11
  146. package/types/test/typescriptTest.ts +3 -3
  147. package/cjs/resources/AccountNotices.js +0 -21
  148. package/cjs/resources/BalanceSettings.js +0 -10
  149. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  150. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  151. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  152. package/cjs/resources/ExternalAccounts.js +0 -23
  153. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  154. package/cjs/resources/FxQuotes.js +0 -15
  155. package/cjs/resources/GiftCards/Cards.js +0 -23
  156. package/cjs/resources/GiftCards/Transactions.js +0 -33
  157. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  158. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  159. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  160. package/cjs/resources/Margins.js +0 -22
  161. package/cjs/resources/Orders.js +0 -24
  162. package/cjs/resources/PaymentRecords.js +0 -29
  163. package/cjs/resources/Privacy/RedactionJobs.js +0 -46
  164. package/cjs/resources/Tax/Associations.js +0 -9
  165. package/cjs/resources/Tax/Forms.js +0 -20
  166. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  167. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  168. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  169. package/cjs/resources/V2/Core/Accounts.js +0 -25
  170. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  171. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  172. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  173. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -17
  174. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  175. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  176. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -12
  177. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  178. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  179. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  180. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  181. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  182. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  183. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  184. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  185. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  186. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  187. package/esm/resources/AccountNotices.js +0 -18
  188. package/esm/resources/BalanceSettings.js +0 -7
  189. package/esm/resources/Capital/FinancingOffers.js +0 -18
  190. package/esm/resources/Capital/FinancingSummary.js +0 -9
  191. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  192. package/esm/resources/ExternalAccounts.js +0 -20
  193. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  194. package/esm/resources/FxQuotes.js +0 -12
  195. package/esm/resources/GiftCards/Cards.js +0 -20
  196. package/esm/resources/GiftCards/Transactions.js +0 -30
  197. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  198. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  199. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  200. package/esm/resources/Margins.js +0 -19
  201. package/esm/resources/Orders.js +0 -21
  202. package/esm/resources/PaymentRecords.js +0 -26
  203. package/esm/resources/Privacy/RedactionJobs.js +0 -43
  204. package/esm/resources/Tax/Associations.js +0 -6
  205. package/esm/resources/Tax/Forms.js +0 -17
  206. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  207. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  208. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  209. package/esm/resources/V2/Core/Accounts.js +0 -22
  210. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  211. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  212. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  213. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -14
  214. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  215. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  216. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -9
  217. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  218. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  219. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  220. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  221. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  222. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  223. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  224. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  225. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  226. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  227. package/types/AccountNotices.d.ts +0 -113
  228. package/types/AccountNoticesResource.d.ts +0 -98
  229. package/types/BalanceSettings.d.ts +0 -89
  230. package/types/BalanceSettingsResource.d.ts +0 -108
  231. package/types/Billing/MeterErrorReports.d.ts +0 -106
  232. package/types/Capital/FinancingOffers.d.ts +0 -188
  233. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  234. package/types/Capital/FinancingSummary.d.ts +0 -106
  235. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  236. package/types/Capital/FinancingTransactions.d.ts +0 -135
  237. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  238. package/types/ExternalAccountsResource.d.ts +0 -304
  239. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  240. package/types/FinancialConnections/Institutions.d.ts +0 -93
  241. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  242. package/types/FxQuotes.d.ts +0 -153
  243. package/types/FxQuotesResource.d.ts +0 -130
  244. package/types/GiftCards/Cards.d.ts +0 -118
  245. package/types/GiftCards/CardsResource.d.ts +0 -159
  246. package/types/GiftCards/Transactions.d.ts +0 -129
  247. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  248. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  249. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  250. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  251. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  252. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  253. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  254. package/types/Issuing/Settlements.d.ts +0 -113
  255. package/types/Margins.d.ts +0 -56
  256. package/types/MarginsResource.d.ts +0 -114
  257. package/types/Orders.d.ts +0 -1189
  258. package/types/OrdersResource.d.ts +0 -2981
  259. package/types/PaymentAttemptRecords.d.ts +0 -2112
  260. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  261. package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -110
  262. package/types/PaymentRecords.d.ts +0 -2105
  263. package/types/PaymentRecordsResource.d.ts +0 -455
  264. package/types/Privacy/RedactionJobRootObjects.d.ts +0 -35
  265. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -30
  266. package/types/Privacy/RedactionJobs.d.ts +0 -43
  267. package/types/Privacy/RedactionJobsResource.d.ts +0 -240
  268. package/types/QuoteLines.d.ts +0 -634
  269. package/types/QuotePreviewInvoices.d.ts +0 -1687
  270. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -778
  271. package/types/Tax/Associations.d.ts +0 -126
  272. package/types/Tax/AssociationsResource.d.ts +0 -29
  273. package/types/Tax/Forms.d.ts +0 -220
  274. package/types/Tax/FormsResource.d.ts +0 -107
  275. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  276. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  277. package/types/V2/Core/AccountLinks.d.ts +0 -101
  278. package/types/V2/Core/AccountLinksResource.d.ts +0 -90
  279. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3760
  280. package/types/V2/Core/Accounts.d.ts +0 -8057
  281. package/types/V2/Core/AccountsResource.d.ts +0 -10184
  282. package/types/V2/Core/Persons.d.ts +0 -1857
  283. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -155
  284. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  285. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -65
  286. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  287. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -22
  288. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -27
  289. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -105
  290. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  291. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -540
  292. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -52
  293. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -308
  294. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -287
  295. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -201
  296. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  297. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -141
  298. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -93
  299. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -273
  300. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  301. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -92
  302. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  303. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -246
  304. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -207
  305. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -146
  306. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  307. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -82
  308. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  309. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -280
  310. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  311. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -219
  312. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  313. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -151
  314. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  315. package/types/V2/MoneyManagement/Transactions.d.ts +0 -166
  316. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  317. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -66
@@ -1,3760 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Core {
7
- namespace Accounts {
8
- interface PersonCreateParams {
9
- /**
10
- * Additional addresses associated with the person.
11
- */
12
- additional_addresses?: Array<PersonCreateParams.AdditionalAddress>;
13
-
14
- /**
15
- * Additional names (e.g. aliases) associated with the person.
16
- */
17
- additional_names?: Array<PersonCreateParams.AdditionalName>;
18
-
19
- /**
20
- * Attestations of accepted terms of service agreements.
21
- */
22
- additional_terms_of_service?: PersonCreateParams.AdditionalTermsOfService;
23
-
24
- /**
25
- * The person's residential address.
26
- */
27
- address?: PersonCreateParams.Address;
28
-
29
- /**
30
- * The person's date of birth.
31
- */
32
- date_of_birth?: PersonCreateParams.DateOfBirth;
33
-
34
- /**
35
- * Documents that may be submitted to satisfy various informational requests.
36
- */
37
- documents?: PersonCreateParams.Documents;
38
-
39
- /**
40
- * Email.
41
- */
42
- email?: string;
43
-
44
- /**
45
- * The person's first name.
46
- */
47
- given_name?: string;
48
-
49
- /**
50
- * The identification numbers (e.g., SSN) associated with the person.
51
- */
52
- id_numbers?: Array<PersonCreateParams.IdNumber>;
53
-
54
- /**
55
- * The person's gender (International regulations require either "male" or "female").
56
- */
57
- legal_gender?: PersonCreateParams.LegalGender;
58
-
59
- /**
60
- * 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.
61
- */
62
- metadata?: Stripe.MetadataParam;
63
-
64
- /**
65
- * The nationalities (countries) this person is associated with.
66
- */
67
- nationalities?: Array<PersonCreateParams.Nationality>;
68
-
69
- /**
70
- * The phone number for this person.
71
- */
72
- phone?: string;
73
-
74
- /**
75
- * The person's political exposure.
76
- */
77
- political_exposure?: PersonCreateParams.PoliticalExposure;
78
-
79
- /**
80
- * The relationship that this person has with the Account's business or legal entity.
81
- */
82
- relationship?: PersonCreateParams.Relationship;
83
-
84
- /**
85
- * The script addresses (e.g., non-Latin characters) associated with the person.
86
- */
87
- script_addresses?: PersonCreateParams.ScriptAddresses;
88
-
89
- /**
90
- * The script names (e.g. non-Latin characters) associated with the person.
91
- */
92
- script_names?: PersonCreateParams.ScriptNames;
93
-
94
- /**
95
- * The person's last name.
96
- */
97
- surname?: string;
98
- }
99
-
100
- namespace PersonCreateParams {
101
- interface AdditionalAddress {
102
- /**
103
- * City, district, suburb, town, or village.
104
- */
105
- city?: string;
106
-
107
- /**
108
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
109
- */
110
- country: AdditionalAddress.Country;
111
-
112
- /**
113
- * Address line 1 (e.g., street, PO Box, or company name).
114
- */
115
- line1?: string;
116
-
117
- /**
118
- * Address line 2 (e.g., apartment, suite, unit, or building).
119
- */
120
- line2?: string;
121
-
122
- /**
123
- * ZIP or postal code.
124
- */
125
- postal_code?: string;
126
-
127
- /**
128
- * Purpose of additional address.
129
- */
130
- purpose: 'registered';
131
-
132
- /**
133
- * State, county, province, or region.
134
- */
135
- state?: string;
136
-
137
- /**
138
- * Town or cho-me.
139
- */
140
- town?: string;
141
- }
142
-
143
- namespace AdditionalAddress {
144
- type Country =
145
- | 'ad'
146
- | 'ae'
147
- | 'af'
148
- | 'ag'
149
- | 'ai'
150
- | 'al'
151
- | 'am'
152
- | 'ao'
153
- | 'aq'
154
- | 'ar'
155
- | 'as'
156
- | 'at'
157
- | 'au'
158
- | 'aw'
159
- | 'ax'
160
- | 'az'
161
- | 'ba'
162
- | 'bb'
163
- | 'bd'
164
- | 'be'
165
- | 'bf'
166
- | 'bg'
167
- | 'bh'
168
- | 'bi'
169
- | 'bj'
170
- | 'bl'
171
- | 'bm'
172
- | 'bn'
173
- | 'bo'
174
- | 'bq'
175
- | 'br'
176
- | 'bs'
177
- | 'bt'
178
- | 'bv'
179
- | 'bw'
180
- | 'by'
181
- | 'bz'
182
- | 'ca'
183
- | 'cc'
184
- | 'cd'
185
- | 'cf'
186
- | 'cg'
187
- | 'ch'
188
- | 'ci'
189
- | 'ck'
190
- | 'cl'
191
- | 'cm'
192
- | 'cn'
193
- | 'co'
194
- | 'cr'
195
- | 'cu'
196
- | 'cv'
197
- | 'cw'
198
- | 'cx'
199
- | 'cy'
200
- | 'cz'
201
- | 'de'
202
- | 'dj'
203
- | 'dk'
204
- | 'dm'
205
- | 'do'
206
- | 'dz'
207
- | 'ec'
208
- | 'ee'
209
- | 'eg'
210
- | 'eh'
211
- | 'er'
212
- | 'es'
213
- | 'et'
214
- | 'fi'
215
- | 'fj'
216
- | 'fk'
217
- | 'fm'
218
- | 'fo'
219
- | 'fr'
220
- | 'ga'
221
- | 'gb'
222
- | 'gd'
223
- | 'ge'
224
- | 'gf'
225
- | 'gg'
226
- | 'gh'
227
- | 'gi'
228
- | 'gl'
229
- | 'gm'
230
- | 'gn'
231
- | 'gp'
232
- | 'gq'
233
- | 'gr'
234
- | 'gs'
235
- | 'gt'
236
- | 'gu'
237
- | 'gw'
238
- | 'gy'
239
- | 'hk'
240
- | 'hm'
241
- | 'hn'
242
- | 'hr'
243
- | 'ht'
244
- | 'hu'
245
- | 'id'
246
- | 'ie'
247
- | 'il'
248
- | 'im'
249
- | 'in'
250
- | 'io'
251
- | 'iq'
252
- | 'ir'
253
- | 'is'
254
- | 'it'
255
- | 'je'
256
- | 'jm'
257
- | 'jo'
258
- | 'jp'
259
- | 'ke'
260
- | 'kg'
261
- | 'kh'
262
- | 'ki'
263
- | 'km'
264
- | 'kn'
265
- | 'kp'
266
- | 'kr'
267
- | 'kw'
268
- | 'ky'
269
- | 'kz'
270
- | 'la'
271
- | 'lb'
272
- | 'lc'
273
- | 'li'
274
- | 'lk'
275
- | 'lr'
276
- | 'ls'
277
- | 'lt'
278
- | 'lu'
279
- | 'lv'
280
- | 'ly'
281
- | 'ma'
282
- | 'mc'
283
- | 'md'
284
- | 'me'
285
- | 'mf'
286
- | 'mg'
287
- | 'mh'
288
- | 'mk'
289
- | 'ml'
290
- | 'mm'
291
- | 'mn'
292
- | 'mo'
293
- | 'mp'
294
- | 'mq'
295
- | 'mr'
296
- | 'ms'
297
- | 'mt'
298
- | 'mu'
299
- | 'mv'
300
- | 'mw'
301
- | 'mx'
302
- | 'my'
303
- | 'mz'
304
- | 'na'
305
- | 'nc'
306
- | 'ne'
307
- | 'nf'
308
- | 'ng'
309
- | 'ni'
310
- | 'nl'
311
- | 'no'
312
- | 'np'
313
- | 'nr'
314
- | 'nu'
315
- | 'nz'
316
- | 'om'
317
- | 'pa'
318
- | 'pe'
319
- | 'pf'
320
- | 'pg'
321
- | 'ph'
322
- | 'pk'
323
- | 'pl'
324
- | 'pm'
325
- | 'pn'
326
- | 'pr'
327
- | 'ps'
328
- | 'pt'
329
- | 'pw'
330
- | 'py'
331
- | 'qa'
332
- | 'qz'
333
- | 're'
334
- | 'ro'
335
- | 'rs'
336
- | 'ru'
337
- | 'rw'
338
- | 'sa'
339
- | 'sb'
340
- | 'sc'
341
- | 'sd'
342
- | 'se'
343
- | 'sg'
344
- | 'sh'
345
- | 'si'
346
- | 'sj'
347
- | 'sk'
348
- | 'sl'
349
- | 'sm'
350
- | 'sn'
351
- | 'so'
352
- | 'sr'
353
- | 'ss'
354
- | 'st'
355
- | 'sv'
356
- | 'sx'
357
- | 'sy'
358
- | 'sz'
359
- | 'tc'
360
- | 'td'
361
- | 'tf'
362
- | 'tg'
363
- | 'th'
364
- | 'tj'
365
- | 'tk'
366
- | 'tl'
367
- | 'tm'
368
- | 'tn'
369
- | 'to'
370
- | 'tr'
371
- | 'tt'
372
- | 'tv'
373
- | 'tw'
374
- | 'tz'
375
- | 'ua'
376
- | 'ug'
377
- | 'um'
378
- | 'us'
379
- | 'uy'
380
- | 'uz'
381
- | 'va'
382
- | 'vc'
383
- | 've'
384
- | 'vg'
385
- | 'vi'
386
- | 'vn'
387
- | 'vu'
388
- | 'wf'
389
- | 'ws'
390
- | 'ye'
391
- | 'yt'
392
- | 'za'
393
- | 'zm'
394
- | 'zw';
395
- }
396
-
397
- interface AdditionalName {
398
- /**
399
- * The person's full name.
400
- */
401
- full_name?: string;
402
-
403
- /**
404
- * The person's first or given name.
405
- */
406
- given_name?: string;
407
-
408
- /**
409
- * The purpose or type of the additional name.
410
- */
411
- purpose: AdditionalName.Purpose;
412
-
413
- /**
414
- * The person's last or family name.
415
- */
416
- surname?: string;
417
- }
418
-
419
- namespace AdditionalName {
420
- type Purpose = 'alias' | 'maiden';
421
- }
422
-
423
- interface AdditionalTermsOfService {
424
- /**
425
- * Stripe terms of service agreement.
426
- */
427
- account?: AdditionalTermsOfService.Account;
428
- }
429
-
430
- namespace AdditionalTermsOfService {
431
- interface Account {
432
- /**
433
- * 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.
434
- */
435
- date: string;
436
-
437
- /**
438
- * The IP address from which the Account's representative accepted the terms of service.
439
- */
440
- ip: string;
441
-
442
- /**
443
- * The user agent of the browser from which the Account's representative accepted the terms of service.
444
- */
445
- user_agent?: string;
446
- }
447
- }
448
-
449
- interface Address {
450
- /**
451
- * City, district, suburb, town, or village.
452
- */
453
- city?: string;
454
-
455
- /**
456
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
457
- */
458
- country: Address.Country;
459
-
460
- /**
461
- * Address line 1 (e.g., street, PO Box, or company name).
462
- */
463
- line1?: string;
464
-
465
- /**
466
- * Address line 2 (e.g., apartment, suite, unit, or building).
467
- */
468
- line2?: string;
469
-
470
- /**
471
- * ZIP or postal code.
472
- */
473
- postal_code?: string;
474
-
475
- /**
476
- * State, county, province, or region.
477
- */
478
- state?: string;
479
-
480
- /**
481
- * Town or cho-me.
482
- */
483
- town?: string;
484
- }
485
-
486
- namespace Address {
487
- type Country =
488
- | 'ad'
489
- | 'ae'
490
- | 'af'
491
- | 'ag'
492
- | 'ai'
493
- | 'al'
494
- | 'am'
495
- | 'ao'
496
- | 'aq'
497
- | 'ar'
498
- | 'as'
499
- | 'at'
500
- | 'au'
501
- | 'aw'
502
- | 'ax'
503
- | 'az'
504
- | 'ba'
505
- | 'bb'
506
- | 'bd'
507
- | 'be'
508
- | 'bf'
509
- | 'bg'
510
- | 'bh'
511
- | 'bi'
512
- | 'bj'
513
- | 'bl'
514
- | 'bm'
515
- | 'bn'
516
- | 'bo'
517
- | 'bq'
518
- | 'br'
519
- | 'bs'
520
- | 'bt'
521
- | 'bv'
522
- | 'bw'
523
- | 'by'
524
- | 'bz'
525
- | 'ca'
526
- | 'cc'
527
- | 'cd'
528
- | 'cf'
529
- | 'cg'
530
- | 'ch'
531
- | 'ci'
532
- | 'ck'
533
- | 'cl'
534
- | 'cm'
535
- | 'cn'
536
- | 'co'
537
- | 'cr'
538
- | 'cu'
539
- | 'cv'
540
- | 'cw'
541
- | 'cx'
542
- | 'cy'
543
- | 'cz'
544
- | 'de'
545
- | 'dj'
546
- | 'dk'
547
- | 'dm'
548
- | 'do'
549
- | 'dz'
550
- | 'ec'
551
- | 'ee'
552
- | 'eg'
553
- | 'eh'
554
- | 'er'
555
- | 'es'
556
- | 'et'
557
- | 'fi'
558
- | 'fj'
559
- | 'fk'
560
- | 'fm'
561
- | 'fo'
562
- | 'fr'
563
- | 'ga'
564
- | 'gb'
565
- | 'gd'
566
- | 'ge'
567
- | 'gf'
568
- | 'gg'
569
- | 'gh'
570
- | 'gi'
571
- | 'gl'
572
- | 'gm'
573
- | 'gn'
574
- | 'gp'
575
- | 'gq'
576
- | 'gr'
577
- | 'gs'
578
- | 'gt'
579
- | 'gu'
580
- | 'gw'
581
- | 'gy'
582
- | 'hk'
583
- | 'hm'
584
- | 'hn'
585
- | 'hr'
586
- | 'ht'
587
- | 'hu'
588
- | 'id'
589
- | 'ie'
590
- | 'il'
591
- | 'im'
592
- | 'in'
593
- | 'io'
594
- | 'iq'
595
- | 'ir'
596
- | 'is'
597
- | 'it'
598
- | 'je'
599
- | 'jm'
600
- | 'jo'
601
- | 'jp'
602
- | 'ke'
603
- | 'kg'
604
- | 'kh'
605
- | 'ki'
606
- | 'km'
607
- | 'kn'
608
- | 'kp'
609
- | 'kr'
610
- | 'kw'
611
- | 'ky'
612
- | 'kz'
613
- | 'la'
614
- | 'lb'
615
- | 'lc'
616
- | 'li'
617
- | 'lk'
618
- | 'lr'
619
- | 'ls'
620
- | 'lt'
621
- | 'lu'
622
- | 'lv'
623
- | 'ly'
624
- | 'ma'
625
- | 'mc'
626
- | 'md'
627
- | 'me'
628
- | 'mf'
629
- | 'mg'
630
- | 'mh'
631
- | 'mk'
632
- | 'ml'
633
- | 'mm'
634
- | 'mn'
635
- | 'mo'
636
- | 'mp'
637
- | 'mq'
638
- | 'mr'
639
- | 'ms'
640
- | 'mt'
641
- | 'mu'
642
- | 'mv'
643
- | 'mw'
644
- | 'mx'
645
- | 'my'
646
- | 'mz'
647
- | 'na'
648
- | 'nc'
649
- | 'ne'
650
- | 'nf'
651
- | 'ng'
652
- | 'ni'
653
- | 'nl'
654
- | 'no'
655
- | 'np'
656
- | 'nr'
657
- | 'nu'
658
- | 'nz'
659
- | 'om'
660
- | 'pa'
661
- | 'pe'
662
- | 'pf'
663
- | 'pg'
664
- | 'ph'
665
- | 'pk'
666
- | 'pl'
667
- | 'pm'
668
- | 'pn'
669
- | 'pr'
670
- | 'ps'
671
- | 'pt'
672
- | 'pw'
673
- | 'py'
674
- | 'qa'
675
- | 'qz'
676
- | 're'
677
- | 'ro'
678
- | 'rs'
679
- | 'ru'
680
- | 'rw'
681
- | 'sa'
682
- | 'sb'
683
- | 'sc'
684
- | 'sd'
685
- | 'se'
686
- | 'sg'
687
- | 'sh'
688
- | 'si'
689
- | 'sj'
690
- | 'sk'
691
- | 'sl'
692
- | 'sm'
693
- | 'sn'
694
- | 'so'
695
- | 'sr'
696
- | 'ss'
697
- | 'st'
698
- | 'sv'
699
- | 'sx'
700
- | 'sy'
701
- | 'sz'
702
- | 'tc'
703
- | 'td'
704
- | 'tf'
705
- | 'tg'
706
- | 'th'
707
- | 'tj'
708
- | 'tk'
709
- | 'tl'
710
- | 'tm'
711
- | 'tn'
712
- | 'to'
713
- | 'tr'
714
- | 'tt'
715
- | 'tv'
716
- | 'tw'
717
- | 'tz'
718
- | 'ua'
719
- | 'ug'
720
- | 'um'
721
- | 'us'
722
- | 'uy'
723
- | 'uz'
724
- | 'va'
725
- | 'vc'
726
- | 've'
727
- | 'vg'
728
- | 'vi'
729
- | 'vn'
730
- | 'vu'
731
- | 'wf'
732
- | 'ws'
733
- | 'ye'
734
- | 'yt'
735
- | 'za'
736
- | 'zm'
737
- | 'zw';
738
- }
739
-
740
- interface DateOfBirth {
741
- /**
742
- * The day of birth.
743
- */
744
- day: number;
745
-
746
- /**
747
- * The month of birth.
748
- */
749
- month: number;
750
-
751
- /**
752
- * The year of birth.
753
- */
754
- year: number;
755
- }
756
-
757
- interface Documents {
758
- /**
759
- * One or more documents that demonstrate proof that this person is authorized to represent the company.
760
- */
761
- company_authorization?: Documents.CompanyAuthorization;
762
-
763
- /**
764
- * One or more documents showing the person's passport page with photo and personal data.
765
- */
766
- passport?: Documents.Passport;
767
-
768
- /**
769
- * An identifying document showing the person's name, either a passport or local ID card.
770
- */
771
- primary_verification?: Documents.PrimaryVerification;
772
-
773
- /**
774
- * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
775
- */
776
- secondary_verification?: Documents.SecondaryVerification;
777
-
778
- /**
779
- * One or more documents showing the person's visa required for living in the country where they are residing.
780
- */
781
- visa?: Documents.Visa;
782
- }
783
-
784
- namespace Documents {
785
- interface CompanyAuthorization {
786
- /**
787
- * 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`.
788
- */
789
- files: Array<string>;
790
-
791
- /**
792
- * The format of the document. Currently supports `files` only.
793
- */
794
- type: 'files';
795
- }
796
-
797
- interface Passport {
798
- /**
799
- * 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`.
800
- */
801
- files: Array<string>;
802
-
803
- /**
804
- * The format of the document. Currently supports `files` only.
805
- */
806
- type: 'files';
807
- }
808
-
809
- interface PrimaryVerification {
810
- /**
811
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
812
- */
813
- front_back: PrimaryVerification.FrontBack;
814
-
815
- /**
816
- * The format of the verification document. Currently supports `front_back` only.
817
- */
818
- type: 'front_back';
819
- }
820
-
821
- namespace PrimaryVerification {
822
- interface FrontBack {
823
- /**
824
- * 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.
825
- */
826
- back?: string;
827
-
828
- /**
829
- * 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.
830
- */
831
- front: string;
832
- }
833
- }
834
-
835
- interface SecondaryVerification {
836
- /**
837
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
838
- */
839
- front_back: SecondaryVerification.FrontBack;
840
-
841
- /**
842
- * The format of the verification document. Currently supports `front_back` only.
843
- */
844
- type: 'front_back';
845
- }
846
-
847
- namespace SecondaryVerification {
848
- interface FrontBack {
849
- /**
850
- * 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.
851
- */
852
- back?: string;
853
-
854
- /**
855
- * 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.
856
- */
857
- front: string;
858
- }
859
- }
860
-
861
- interface Visa {
862
- /**
863
- * 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`.
864
- */
865
- files: Array<string>;
866
-
867
- /**
868
- * The format of the document. Currently supports `files` only.
869
- */
870
- type: 'files';
871
- }
872
- }
873
-
874
- interface IdNumber {
875
- /**
876
- * The ID number type of an individual.
877
- */
878
- type: IdNumber.Type;
879
-
880
- /**
881
- * The value of the ID number.
882
- */
883
- value: string;
884
- }
885
-
886
- namespace IdNumber {
887
- type Type =
888
- | 'ae_eid'
889
- | 'br_cpf'
890
- | 'de_stn'
891
- | 'hk_id'
892
- | 'mx_rfc'
893
- | 'my_nric'
894
- | 'nl_bsn'
895
- | 'sg_fin'
896
- | 'sg_nric'
897
- | 'th_lc'
898
- | 'th_pin'
899
- | 'us_itin'
900
- | 'us_itin_last_4'
901
- | 'us_ssn'
902
- | 'us_ssn_last_4';
903
- }
904
-
905
- type LegalGender = 'female' | 'male';
906
-
907
- type Nationality =
908
- | 'ad'
909
- | 'ae'
910
- | 'af'
911
- | 'ag'
912
- | 'ai'
913
- | 'al'
914
- | 'am'
915
- | 'ao'
916
- | 'aq'
917
- | 'ar'
918
- | 'as'
919
- | 'at'
920
- | 'au'
921
- | 'aw'
922
- | 'ax'
923
- | 'az'
924
- | 'ba'
925
- | 'bb'
926
- | 'bd'
927
- | 'be'
928
- | 'bf'
929
- | 'bg'
930
- | 'bh'
931
- | 'bi'
932
- | 'bj'
933
- | 'bl'
934
- | 'bm'
935
- | 'bn'
936
- | 'bo'
937
- | 'bq'
938
- | 'br'
939
- | 'bs'
940
- | 'bt'
941
- | 'bv'
942
- | 'bw'
943
- | 'by'
944
- | 'bz'
945
- | 'ca'
946
- | 'cc'
947
- | 'cd'
948
- | 'cf'
949
- | 'cg'
950
- | 'ch'
951
- | 'ci'
952
- | 'ck'
953
- | 'cl'
954
- | 'cm'
955
- | 'cn'
956
- | 'co'
957
- | 'cr'
958
- | 'cu'
959
- | 'cv'
960
- | 'cw'
961
- | 'cx'
962
- | 'cy'
963
- | 'cz'
964
- | 'de'
965
- | 'dj'
966
- | 'dk'
967
- | 'dm'
968
- | 'do'
969
- | 'dz'
970
- | 'ec'
971
- | 'ee'
972
- | 'eg'
973
- | 'eh'
974
- | 'er'
975
- | 'es'
976
- | 'et'
977
- | 'fi'
978
- | 'fj'
979
- | 'fk'
980
- | 'fm'
981
- | 'fo'
982
- | 'fr'
983
- | 'ga'
984
- | 'gb'
985
- | 'gd'
986
- | 'ge'
987
- | 'gf'
988
- | 'gg'
989
- | 'gh'
990
- | 'gi'
991
- | 'gl'
992
- | 'gm'
993
- | 'gn'
994
- | 'gp'
995
- | 'gq'
996
- | 'gr'
997
- | 'gs'
998
- | 'gt'
999
- | 'gu'
1000
- | 'gw'
1001
- | 'gy'
1002
- | 'hk'
1003
- | 'hm'
1004
- | 'hn'
1005
- | 'hr'
1006
- | 'ht'
1007
- | 'hu'
1008
- | 'id'
1009
- | 'ie'
1010
- | 'il'
1011
- | 'im'
1012
- | 'in'
1013
- | 'io'
1014
- | 'iq'
1015
- | 'ir'
1016
- | 'is'
1017
- | 'it'
1018
- | 'je'
1019
- | 'jm'
1020
- | 'jo'
1021
- | 'jp'
1022
- | 'ke'
1023
- | 'kg'
1024
- | 'kh'
1025
- | 'ki'
1026
- | 'km'
1027
- | 'kn'
1028
- | 'kp'
1029
- | 'kr'
1030
- | 'kw'
1031
- | 'ky'
1032
- | 'kz'
1033
- | 'la'
1034
- | 'lb'
1035
- | 'lc'
1036
- | 'li'
1037
- | 'lk'
1038
- | 'lr'
1039
- | 'ls'
1040
- | 'lt'
1041
- | 'lu'
1042
- | 'lv'
1043
- | 'ly'
1044
- | 'ma'
1045
- | 'mc'
1046
- | 'md'
1047
- | 'me'
1048
- | 'mf'
1049
- | 'mg'
1050
- | 'mh'
1051
- | 'mk'
1052
- | 'ml'
1053
- | 'mm'
1054
- | 'mn'
1055
- | 'mo'
1056
- | 'mp'
1057
- | 'mq'
1058
- | 'mr'
1059
- | 'ms'
1060
- | 'mt'
1061
- | 'mu'
1062
- | 'mv'
1063
- | 'mw'
1064
- | 'mx'
1065
- | 'my'
1066
- | 'mz'
1067
- | 'na'
1068
- | 'nc'
1069
- | 'ne'
1070
- | 'nf'
1071
- | 'ng'
1072
- | 'ni'
1073
- | 'nl'
1074
- | 'no'
1075
- | 'np'
1076
- | 'nr'
1077
- | 'nu'
1078
- | 'nz'
1079
- | 'om'
1080
- | 'pa'
1081
- | 'pe'
1082
- | 'pf'
1083
- | 'pg'
1084
- | 'ph'
1085
- | 'pk'
1086
- | 'pl'
1087
- | 'pm'
1088
- | 'pn'
1089
- | 'pr'
1090
- | 'ps'
1091
- | 'pt'
1092
- | 'pw'
1093
- | 'py'
1094
- | 'qa'
1095
- | 'qz'
1096
- | 're'
1097
- | 'ro'
1098
- | 'rs'
1099
- | 'ru'
1100
- | 'rw'
1101
- | 'sa'
1102
- | 'sb'
1103
- | 'sc'
1104
- | 'sd'
1105
- | 'se'
1106
- | 'sg'
1107
- | 'sh'
1108
- | 'si'
1109
- | 'sj'
1110
- | 'sk'
1111
- | 'sl'
1112
- | 'sm'
1113
- | 'sn'
1114
- | 'so'
1115
- | 'sr'
1116
- | 'ss'
1117
- | 'st'
1118
- | 'sv'
1119
- | 'sx'
1120
- | 'sy'
1121
- | 'sz'
1122
- | 'tc'
1123
- | 'td'
1124
- | 'tf'
1125
- | 'tg'
1126
- | 'th'
1127
- | 'tj'
1128
- | 'tk'
1129
- | 'tl'
1130
- | 'tm'
1131
- | 'tn'
1132
- | 'to'
1133
- | 'tr'
1134
- | 'tt'
1135
- | 'tv'
1136
- | 'tw'
1137
- | 'tz'
1138
- | 'ua'
1139
- | 'ug'
1140
- | 'um'
1141
- | 'us'
1142
- | 'uy'
1143
- | 'uz'
1144
- | 'va'
1145
- | 'vc'
1146
- | 've'
1147
- | 'vg'
1148
- | 'vi'
1149
- | 'vn'
1150
- | 'vu'
1151
- | 'wf'
1152
- | 'ws'
1153
- | 'ye'
1154
- | 'yt'
1155
- | 'za'
1156
- | 'zm'
1157
- | 'zw';
1158
-
1159
- type PoliticalExposure = 'existing' | 'none';
1160
-
1161
- interface Relationship {
1162
- /**
1163
- * Indicates whether the person is a director of the associated legal entity.
1164
- */
1165
- director?: boolean;
1166
-
1167
- /**
1168
- * Indicates whether the person is an executive of the associated legal entity.
1169
- */
1170
- executive?: boolean;
1171
-
1172
- /**
1173
- * Indicates whether the person is a legal guardian of the associated legal entity.
1174
- */
1175
- legal_guardian?: boolean;
1176
-
1177
- /**
1178
- * Indicates whether the person is an owner of the associated legal entity.
1179
- */
1180
- owner?: boolean;
1181
-
1182
- /**
1183
- * The percentage of ownership the person has in the associated legal entity.
1184
- */
1185
- percent_ownership?: string;
1186
-
1187
- /**
1188
- * Indicates whether the person is a representative of the associated legal entity.
1189
- */
1190
- representative?: boolean;
1191
-
1192
- /**
1193
- * The title or position the person holds in the associated legal entity.
1194
- */
1195
- title?: string;
1196
- }
1197
-
1198
- interface ScriptAddresses {
1199
- /**
1200
- * Kana Address.
1201
- */
1202
- kana?: ScriptAddresses.Kana;
1203
-
1204
- /**
1205
- * Kanji Address.
1206
- */
1207
- kanji?: ScriptAddresses.Kanji;
1208
- }
1209
-
1210
- namespace ScriptAddresses {
1211
- interface Kana {
1212
- /**
1213
- * City, district, suburb, town, or village.
1214
- */
1215
- city?: string;
1216
-
1217
- /**
1218
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1219
- */
1220
- country: Kana.Country;
1221
-
1222
- /**
1223
- * Address line 1 (e.g., street, PO Box, or company name).
1224
- */
1225
- line1?: string;
1226
-
1227
- /**
1228
- * Address line 2 (e.g., apartment, suite, unit, or building).
1229
- */
1230
- line2?: string;
1231
-
1232
- /**
1233
- * ZIP or postal code.
1234
- */
1235
- postal_code?: string;
1236
-
1237
- /**
1238
- * State, county, province, or region.
1239
- */
1240
- state?: string;
1241
-
1242
- /**
1243
- * Town or cho-me.
1244
- */
1245
- town?: string;
1246
- }
1247
-
1248
- namespace Kana {
1249
- type Country =
1250
- | 'ad'
1251
- | 'ae'
1252
- | 'af'
1253
- | 'ag'
1254
- | 'ai'
1255
- | 'al'
1256
- | 'am'
1257
- | 'ao'
1258
- | 'aq'
1259
- | 'ar'
1260
- | 'as'
1261
- | 'at'
1262
- | 'au'
1263
- | 'aw'
1264
- | 'ax'
1265
- | 'az'
1266
- | 'ba'
1267
- | 'bb'
1268
- | 'bd'
1269
- | 'be'
1270
- | 'bf'
1271
- | 'bg'
1272
- | 'bh'
1273
- | 'bi'
1274
- | 'bj'
1275
- | 'bl'
1276
- | 'bm'
1277
- | 'bn'
1278
- | 'bo'
1279
- | 'bq'
1280
- | 'br'
1281
- | 'bs'
1282
- | 'bt'
1283
- | 'bv'
1284
- | 'bw'
1285
- | 'by'
1286
- | 'bz'
1287
- | 'ca'
1288
- | 'cc'
1289
- | 'cd'
1290
- | 'cf'
1291
- | 'cg'
1292
- | 'ch'
1293
- | 'ci'
1294
- | 'ck'
1295
- | 'cl'
1296
- | 'cm'
1297
- | 'cn'
1298
- | 'co'
1299
- | 'cr'
1300
- | 'cu'
1301
- | 'cv'
1302
- | 'cw'
1303
- | 'cx'
1304
- | 'cy'
1305
- | 'cz'
1306
- | 'de'
1307
- | 'dj'
1308
- | 'dk'
1309
- | 'dm'
1310
- | 'do'
1311
- | 'dz'
1312
- | 'ec'
1313
- | 'ee'
1314
- | 'eg'
1315
- | 'eh'
1316
- | 'er'
1317
- | 'es'
1318
- | 'et'
1319
- | 'fi'
1320
- | 'fj'
1321
- | 'fk'
1322
- | 'fm'
1323
- | 'fo'
1324
- | 'fr'
1325
- | 'ga'
1326
- | 'gb'
1327
- | 'gd'
1328
- | 'ge'
1329
- | 'gf'
1330
- | 'gg'
1331
- | 'gh'
1332
- | 'gi'
1333
- | 'gl'
1334
- | 'gm'
1335
- | 'gn'
1336
- | 'gp'
1337
- | 'gq'
1338
- | 'gr'
1339
- | 'gs'
1340
- | 'gt'
1341
- | 'gu'
1342
- | 'gw'
1343
- | 'gy'
1344
- | 'hk'
1345
- | 'hm'
1346
- | 'hn'
1347
- | 'hr'
1348
- | 'ht'
1349
- | 'hu'
1350
- | 'id'
1351
- | 'ie'
1352
- | 'il'
1353
- | 'im'
1354
- | 'in'
1355
- | 'io'
1356
- | 'iq'
1357
- | 'ir'
1358
- | 'is'
1359
- | 'it'
1360
- | 'je'
1361
- | 'jm'
1362
- | 'jo'
1363
- | 'jp'
1364
- | 'ke'
1365
- | 'kg'
1366
- | 'kh'
1367
- | 'ki'
1368
- | 'km'
1369
- | 'kn'
1370
- | 'kp'
1371
- | 'kr'
1372
- | 'kw'
1373
- | 'ky'
1374
- | 'kz'
1375
- | 'la'
1376
- | 'lb'
1377
- | 'lc'
1378
- | 'li'
1379
- | 'lk'
1380
- | 'lr'
1381
- | 'ls'
1382
- | 'lt'
1383
- | 'lu'
1384
- | 'lv'
1385
- | 'ly'
1386
- | 'ma'
1387
- | 'mc'
1388
- | 'md'
1389
- | 'me'
1390
- | 'mf'
1391
- | 'mg'
1392
- | 'mh'
1393
- | 'mk'
1394
- | 'ml'
1395
- | 'mm'
1396
- | 'mn'
1397
- | 'mo'
1398
- | 'mp'
1399
- | 'mq'
1400
- | 'mr'
1401
- | 'ms'
1402
- | 'mt'
1403
- | 'mu'
1404
- | 'mv'
1405
- | 'mw'
1406
- | 'mx'
1407
- | 'my'
1408
- | 'mz'
1409
- | 'na'
1410
- | 'nc'
1411
- | 'ne'
1412
- | 'nf'
1413
- | 'ng'
1414
- | 'ni'
1415
- | 'nl'
1416
- | 'no'
1417
- | 'np'
1418
- | 'nr'
1419
- | 'nu'
1420
- | 'nz'
1421
- | 'om'
1422
- | 'pa'
1423
- | 'pe'
1424
- | 'pf'
1425
- | 'pg'
1426
- | 'ph'
1427
- | 'pk'
1428
- | 'pl'
1429
- | 'pm'
1430
- | 'pn'
1431
- | 'pr'
1432
- | 'ps'
1433
- | 'pt'
1434
- | 'pw'
1435
- | 'py'
1436
- | 'qa'
1437
- | 'qz'
1438
- | 're'
1439
- | 'ro'
1440
- | 'rs'
1441
- | 'ru'
1442
- | 'rw'
1443
- | 'sa'
1444
- | 'sb'
1445
- | 'sc'
1446
- | 'sd'
1447
- | 'se'
1448
- | 'sg'
1449
- | 'sh'
1450
- | 'si'
1451
- | 'sj'
1452
- | 'sk'
1453
- | 'sl'
1454
- | 'sm'
1455
- | 'sn'
1456
- | 'so'
1457
- | 'sr'
1458
- | 'ss'
1459
- | 'st'
1460
- | 'sv'
1461
- | 'sx'
1462
- | 'sy'
1463
- | 'sz'
1464
- | 'tc'
1465
- | 'td'
1466
- | 'tf'
1467
- | 'tg'
1468
- | 'th'
1469
- | 'tj'
1470
- | 'tk'
1471
- | 'tl'
1472
- | 'tm'
1473
- | 'tn'
1474
- | 'to'
1475
- | 'tr'
1476
- | 'tt'
1477
- | 'tv'
1478
- | 'tw'
1479
- | 'tz'
1480
- | 'ua'
1481
- | 'ug'
1482
- | 'um'
1483
- | 'us'
1484
- | 'uy'
1485
- | 'uz'
1486
- | 'va'
1487
- | 'vc'
1488
- | 've'
1489
- | 'vg'
1490
- | 'vi'
1491
- | 'vn'
1492
- | 'vu'
1493
- | 'wf'
1494
- | 'ws'
1495
- | 'ye'
1496
- | 'yt'
1497
- | 'za'
1498
- | 'zm'
1499
- | 'zw';
1500
- }
1501
-
1502
- interface Kanji {
1503
- /**
1504
- * City, district, suburb, town, or village.
1505
- */
1506
- city?: string;
1507
-
1508
- /**
1509
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1510
- */
1511
- country: Kanji.Country;
1512
-
1513
- /**
1514
- * Address line 1 (e.g., street, PO Box, or company name).
1515
- */
1516
- line1?: string;
1517
-
1518
- /**
1519
- * Address line 2 (e.g., apartment, suite, unit, or building).
1520
- */
1521
- line2?: string;
1522
-
1523
- /**
1524
- * ZIP or postal code.
1525
- */
1526
- postal_code?: string;
1527
-
1528
- /**
1529
- * State, county, province, or region.
1530
- */
1531
- state?: string;
1532
-
1533
- /**
1534
- * Town or cho-me.
1535
- */
1536
- town?: string;
1537
- }
1538
-
1539
- namespace Kanji {
1540
- type Country =
1541
- | 'ad'
1542
- | 'ae'
1543
- | 'af'
1544
- | 'ag'
1545
- | 'ai'
1546
- | 'al'
1547
- | 'am'
1548
- | 'ao'
1549
- | 'aq'
1550
- | 'ar'
1551
- | 'as'
1552
- | 'at'
1553
- | 'au'
1554
- | 'aw'
1555
- | 'ax'
1556
- | 'az'
1557
- | 'ba'
1558
- | 'bb'
1559
- | 'bd'
1560
- | 'be'
1561
- | 'bf'
1562
- | 'bg'
1563
- | 'bh'
1564
- | 'bi'
1565
- | 'bj'
1566
- | 'bl'
1567
- | 'bm'
1568
- | 'bn'
1569
- | 'bo'
1570
- | 'bq'
1571
- | 'br'
1572
- | 'bs'
1573
- | 'bt'
1574
- | 'bv'
1575
- | 'bw'
1576
- | 'by'
1577
- | 'bz'
1578
- | 'ca'
1579
- | 'cc'
1580
- | 'cd'
1581
- | 'cf'
1582
- | 'cg'
1583
- | 'ch'
1584
- | 'ci'
1585
- | 'ck'
1586
- | 'cl'
1587
- | 'cm'
1588
- | 'cn'
1589
- | 'co'
1590
- | 'cr'
1591
- | 'cu'
1592
- | 'cv'
1593
- | 'cw'
1594
- | 'cx'
1595
- | 'cy'
1596
- | 'cz'
1597
- | 'de'
1598
- | 'dj'
1599
- | 'dk'
1600
- | 'dm'
1601
- | 'do'
1602
- | 'dz'
1603
- | 'ec'
1604
- | 'ee'
1605
- | 'eg'
1606
- | 'eh'
1607
- | 'er'
1608
- | 'es'
1609
- | 'et'
1610
- | 'fi'
1611
- | 'fj'
1612
- | 'fk'
1613
- | 'fm'
1614
- | 'fo'
1615
- | 'fr'
1616
- | 'ga'
1617
- | 'gb'
1618
- | 'gd'
1619
- | 'ge'
1620
- | 'gf'
1621
- | 'gg'
1622
- | 'gh'
1623
- | 'gi'
1624
- | 'gl'
1625
- | 'gm'
1626
- | 'gn'
1627
- | 'gp'
1628
- | 'gq'
1629
- | 'gr'
1630
- | 'gs'
1631
- | 'gt'
1632
- | 'gu'
1633
- | 'gw'
1634
- | 'gy'
1635
- | 'hk'
1636
- | 'hm'
1637
- | 'hn'
1638
- | 'hr'
1639
- | 'ht'
1640
- | 'hu'
1641
- | 'id'
1642
- | 'ie'
1643
- | 'il'
1644
- | 'im'
1645
- | 'in'
1646
- | 'io'
1647
- | 'iq'
1648
- | 'ir'
1649
- | 'is'
1650
- | 'it'
1651
- | 'je'
1652
- | 'jm'
1653
- | 'jo'
1654
- | 'jp'
1655
- | 'ke'
1656
- | 'kg'
1657
- | 'kh'
1658
- | 'ki'
1659
- | 'km'
1660
- | 'kn'
1661
- | 'kp'
1662
- | 'kr'
1663
- | 'kw'
1664
- | 'ky'
1665
- | 'kz'
1666
- | 'la'
1667
- | 'lb'
1668
- | 'lc'
1669
- | 'li'
1670
- | 'lk'
1671
- | 'lr'
1672
- | 'ls'
1673
- | 'lt'
1674
- | 'lu'
1675
- | 'lv'
1676
- | 'ly'
1677
- | 'ma'
1678
- | 'mc'
1679
- | 'md'
1680
- | 'me'
1681
- | 'mf'
1682
- | 'mg'
1683
- | 'mh'
1684
- | 'mk'
1685
- | 'ml'
1686
- | 'mm'
1687
- | 'mn'
1688
- | 'mo'
1689
- | 'mp'
1690
- | 'mq'
1691
- | 'mr'
1692
- | 'ms'
1693
- | 'mt'
1694
- | 'mu'
1695
- | 'mv'
1696
- | 'mw'
1697
- | 'mx'
1698
- | 'my'
1699
- | 'mz'
1700
- | 'na'
1701
- | 'nc'
1702
- | 'ne'
1703
- | 'nf'
1704
- | 'ng'
1705
- | 'ni'
1706
- | 'nl'
1707
- | 'no'
1708
- | 'np'
1709
- | 'nr'
1710
- | 'nu'
1711
- | 'nz'
1712
- | 'om'
1713
- | 'pa'
1714
- | 'pe'
1715
- | 'pf'
1716
- | 'pg'
1717
- | 'ph'
1718
- | 'pk'
1719
- | 'pl'
1720
- | 'pm'
1721
- | 'pn'
1722
- | 'pr'
1723
- | 'ps'
1724
- | 'pt'
1725
- | 'pw'
1726
- | 'py'
1727
- | 'qa'
1728
- | 'qz'
1729
- | 're'
1730
- | 'ro'
1731
- | 'rs'
1732
- | 'ru'
1733
- | 'rw'
1734
- | 'sa'
1735
- | 'sb'
1736
- | 'sc'
1737
- | 'sd'
1738
- | 'se'
1739
- | 'sg'
1740
- | 'sh'
1741
- | 'si'
1742
- | 'sj'
1743
- | 'sk'
1744
- | 'sl'
1745
- | 'sm'
1746
- | 'sn'
1747
- | 'so'
1748
- | 'sr'
1749
- | 'ss'
1750
- | 'st'
1751
- | 'sv'
1752
- | 'sx'
1753
- | 'sy'
1754
- | 'sz'
1755
- | 'tc'
1756
- | 'td'
1757
- | 'tf'
1758
- | 'tg'
1759
- | 'th'
1760
- | 'tj'
1761
- | 'tk'
1762
- | 'tl'
1763
- | 'tm'
1764
- | 'tn'
1765
- | 'to'
1766
- | 'tr'
1767
- | 'tt'
1768
- | 'tv'
1769
- | 'tw'
1770
- | 'tz'
1771
- | 'ua'
1772
- | 'ug'
1773
- | 'um'
1774
- | 'us'
1775
- | 'uy'
1776
- | 'uz'
1777
- | 'va'
1778
- | 'vc'
1779
- | 've'
1780
- | 'vg'
1781
- | 'vi'
1782
- | 'vn'
1783
- | 'vu'
1784
- | 'wf'
1785
- | 'ws'
1786
- | 'ye'
1787
- | 'yt'
1788
- | 'za'
1789
- | 'zm'
1790
- | 'zw';
1791
- }
1792
- }
1793
-
1794
- interface ScriptNames {
1795
- /**
1796
- * Persons name in kana script.
1797
- */
1798
- kana?: ScriptNames.Kana;
1799
-
1800
- /**
1801
- * Persons name in kanji script.
1802
- */
1803
- kanji?: ScriptNames.Kanji;
1804
- }
1805
-
1806
- namespace ScriptNames {
1807
- interface Kana {
1808
- /**
1809
- * The person's first or given name.
1810
- */
1811
- given_name?: string;
1812
-
1813
- /**
1814
- * The person's last or family name.
1815
- */
1816
- surname?: string;
1817
- }
1818
-
1819
- interface Kanji {
1820
- /**
1821
- * The person's first or given name.
1822
- */
1823
- given_name?: string;
1824
-
1825
- /**
1826
- * The person's last or family name.
1827
- */
1828
- surname?: string;
1829
- }
1830
- }
1831
- }
1832
- }
1833
- }
1834
-
1835
- namespace Core {
1836
- namespace Accounts {
1837
- interface PersonRetrieveParams {}
1838
- }
1839
- }
1840
-
1841
- namespace Core {
1842
- namespace Accounts {
1843
- interface PersonUpdateParams {
1844
- /**
1845
- * Additional addresses associated with the person.
1846
- */
1847
- additional_addresses?: Array<PersonUpdateParams.AdditionalAddress>;
1848
-
1849
- /**
1850
- * Additional names (e.g. aliases) associated with the person.
1851
- */
1852
- additional_names?: Array<PersonUpdateParams.AdditionalName>;
1853
-
1854
- /**
1855
- * Attestations of accepted terms of service agreements.
1856
- */
1857
- additional_terms_of_service?: PersonUpdateParams.AdditionalTermsOfService;
1858
-
1859
- /**
1860
- * The primary address associated with the person.
1861
- */
1862
- address?: PersonUpdateParams.Address;
1863
-
1864
- /**
1865
- * The person's date of birth.
1866
- */
1867
- date_of_birth?: PersonUpdateParams.DateOfBirth;
1868
-
1869
- /**
1870
- * Documents that may be submitted to satisfy various informational requests.
1871
- */
1872
- documents?: PersonUpdateParams.Documents;
1873
-
1874
- /**
1875
- * Email.
1876
- */
1877
- email?: string;
1878
-
1879
- /**
1880
- * The person's first name.
1881
- */
1882
- given_name?: string;
1883
-
1884
- /**
1885
- * The identification numbers (e.g., SSN) associated with the person.
1886
- */
1887
- id_numbers?: Array<PersonUpdateParams.IdNumber>;
1888
-
1889
- /**
1890
- * The person's gender (International regulations require either "male" or "female").
1891
- */
1892
- legal_gender?: PersonUpdateParams.LegalGender;
1893
-
1894
- /**
1895
- * 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.
1896
- */
1897
- metadata?: Stripe.MetadataParam;
1898
-
1899
- /**
1900
- * The nationalities (countries) this person is associated with.
1901
- */
1902
- nationalities?: Array<PersonUpdateParams.Nationality>;
1903
-
1904
- /**
1905
- * The phone number for this person.
1906
- */
1907
- phone?: string;
1908
-
1909
- /**
1910
- * The person's political exposure.
1911
- */
1912
- political_exposure?: PersonUpdateParams.PoliticalExposure;
1913
-
1914
- /**
1915
- * The relationship that this person has with the Account's business or legal entity.
1916
- */
1917
- relationship?: PersonUpdateParams.Relationship;
1918
-
1919
- /**
1920
- * The script addresses (e.g., non-Latin characters) associated with the person.
1921
- */
1922
- script_addresses?: PersonUpdateParams.ScriptAddresses | null;
1923
-
1924
- /**
1925
- * The script names (e.g. non-Latin characters) associated with the person.
1926
- */
1927
- script_names?: PersonUpdateParams.ScriptNames | null;
1928
-
1929
- /**
1930
- * The person's last name.
1931
- */
1932
- surname?: string;
1933
- }
1934
-
1935
- namespace PersonUpdateParams {
1936
- interface AdditionalAddress {
1937
- /**
1938
- * City, district, suburb, town, or village.
1939
- */
1940
- city?: string | null;
1941
-
1942
- /**
1943
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1944
- */
1945
- country?: AdditionalAddress.Country | null;
1946
-
1947
- /**
1948
- * Address line 1 (e.g., street, PO Box, or company name).
1949
- */
1950
- line1?: string | null;
1951
-
1952
- /**
1953
- * Address line 2 (e.g., apartment, suite, unit, or building).
1954
- */
1955
- line2?: string | null;
1956
-
1957
- /**
1958
- * ZIP or postal code.
1959
- */
1960
- postal_code?: string | null;
1961
-
1962
- /**
1963
- * Purpose of additional address.
1964
- */
1965
- purpose: 'registered';
1966
-
1967
- /**
1968
- * State, county, province, or region.
1969
- */
1970
- state?: string | null;
1971
-
1972
- /**
1973
- * Town or cho-me.
1974
- */
1975
- town?: string | null;
1976
- }
1977
-
1978
- namespace AdditionalAddress {
1979
- type Country =
1980
- | 'ad'
1981
- | 'ae'
1982
- | 'af'
1983
- | 'ag'
1984
- | 'ai'
1985
- | 'al'
1986
- | 'am'
1987
- | 'ao'
1988
- | 'aq'
1989
- | 'ar'
1990
- | 'as'
1991
- | 'at'
1992
- | 'au'
1993
- | 'aw'
1994
- | 'ax'
1995
- | 'az'
1996
- | 'ba'
1997
- | 'bb'
1998
- | 'bd'
1999
- | 'be'
2000
- | 'bf'
2001
- | 'bg'
2002
- | 'bh'
2003
- | 'bi'
2004
- | 'bj'
2005
- | 'bl'
2006
- | 'bm'
2007
- | 'bn'
2008
- | 'bo'
2009
- | 'bq'
2010
- | 'br'
2011
- | 'bs'
2012
- | 'bt'
2013
- | 'bv'
2014
- | 'bw'
2015
- | 'by'
2016
- | 'bz'
2017
- | 'ca'
2018
- | 'cc'
2019
- | 'cd'
2020
- | 'cf'
2021
- | 'cg'
2022
- | 'ch'
2023
- | 'ci'
2024
- | 'ck'
2025
- | 'cl'
2026
- | 'cm'
2027
- | 'cn'
2028
- | 'co'
2029
- | 'cr'
2030
- | 'cu'
2031
- | 'cv'
2032
- | 'cw'
2033
- | 'cx'
2034
- | 'cy'
2035
- | 'cz'
2036
- | 'de'
2037
- | 'dj'
2038
- | 'dk'
2039
- | 'dm'
2040
- | 'do'
2041
- | 'dz'
2042
- | 'ec'
2043
- | 'ee'
2044
- | 'eg'
2045
- | 'eh'
2046
- | 'er'
2047
- | 'es'
2048
- | 'et'
2049
- | 'fi'
2050
- | 'fj'
2051
- | 'fk'
2052
- | 'fm'
2053
- | 'fo'
2054
- | 'fr'
2055
- | 'ga'
2056
- | 'gb'
2057
- | 'gd'
2058
- | 'ge'
2059
- | 'gf'
2060
- | 'gg'
2061
- | 'gh'
2062
- | 'gi'
2063
- | 'gl'
2064
- | 'gm'
2065
- | 'gn'
2066
- | 'gp'
2067
- | 'gq'
2068
- | 'gr'
2069
- | 'gs'
2070
- | 'gt'
2071
- | 'gu'
2072
- | 'gw'
2073
- | 'gy'
2074
- | 'hk'
2075
- | 'hm'
2076
- | 'hn'
2077
- | 'hr'
2078
- | 'ht'
2079
- | 'hu'
2080
- | 'id'
2081
- | 'ie'
2082
- | 'il'
2083
- | 'im'
2084
- | 'in'
2085
- | 'io'
2086
- | 'iq'
2087
- | 'ir'
2088
- | 'is'
2089
- | 'it'
2090
- | 'je'
2091
- | 'jm'
2092
- | 'jo'
2093
- | 'jp'
2094
- | 'ke'
2095
- | 'kg'
2096
- | 'kh'
2097
- | 'ki'
2098
- | 'km'
2099
- | 'kn'
2100
- | 'kp'
2101
- | 'kr'
2102
- | 'kw'
2103
- | 'ky'
2104
- | 'kz'
2105
- | 'la'
2106
- | 'lb'
2107
- | 'lc'
2108
- | 'li'
2109
- | 'lk'
2110
- | 'lr'
2111
- | 'ls'
2112
- | 'lt'
2113
- | 'lu'
2114
- | 'lv'
2115
- | 'ly'
2116
- | 'ma'
2117
- | 'mc'
2118
- | 'md'
2119
- | 'me'
2120
- | 'mf'
2121
- | 'mg'
2122
- | 'mh'
2123
- | 'mk'
2124
- | 'ml'
2125
- | 'mm'
2126
- | 'mn'
2127
- | 'mo'
2128
- | 'mp'
2129
- | 'mq'
2130
- | 'mr'
2131
- | 'ms'
2132
- | 'mt'
2133
- | 'mu'
2134
- | 'mv'
2135
- | 'mw'
2136
- | 'mx'
2137
- | 'my'
2138
- | 'mz'
2139
- | 'na'
2140
- | 'nc'
2141
- | 'ne'
2142
- | 'nf'
2143
- | 'ng'
2144
- | 'ni'
2145
- | 'nl'
2146
- | 'no'
2147
- | 'np'
2148
- | 'nr'
2149
- | 'nu'
2150
- | 'nz'
2151
- | 'om'
2152
- | 'pa'
2153
- | 'pe'
2154
- | 'pf'
2155
- | 'pg'
2156
- | 'ph'
2157
- | 'pk'
2158
- | 'pl'
2159
- | 'pm'
2160
- | 'pn'
2161
- | 'pr'
2162
- | 'ps'
2163
- | 'pt'
2164
- | 'pw'
2165
- | 'py'
2166
- | 'qa'
2167
- | 'qz'
2168
- | 're'
2169
- | 'ro'
2170
- | 'rs'
2171
- | 'ru'
2172
- | 'rw'
2173
- | 'sa'
2174
- | 'sb'
2175
- | 'sc'
2176
- | 'sd'
2177
- | 'se'
2178
- | 'sg'
2179
- | 'sh'
2180
- | 'si'
2181
- | 'sj'
2182
- | 'sk'
2183
- | 'sl'
2184
- | 'sm'
2185
- | 'sn'
2186
- | 'so'
2187
- | 'sr'
2188
- | 'ss'
2189
- | 'st'
2190
- | 'sv'
2191
- | 'sx'
2192
- | 'sy'
2193
- | 'sz'
2194
- | 'tc'
2195
- | 'td'
2196
- | 'tf'
2197
- | 'tg'
2198
- | 'th'
2199
- | 'tj'
2200
- | 'tk'
2201
- | 'tl'
2202
- | 'tm'
2203
- | 'tn'
2204
- | 'to'
2205
- | 'tr'
2206
- | 'tt'
2207
- | 'tv'
2208
- | 'tw'
2209
- | 'tz'
2210
- | 'ua'
2211
- | 'ug'
2212
- | 'um'
2213
- | 'us'
2214
- | 'uy'
2215
- | 'uz'
2216
- | 'va'
2217
- | 'vc'
2218
- | 've'
2219
- | 'vg'
2220
- | 'vi'
2221
- | 'vn'
2222
- | 'vu'
2223
- | 'wf'
2224
- | 'ws'
2225
- | 'ye'
2226
- | 'yt'
2227
- | 'za'
2228
- | 'zm'
2229
- | 'zw';
2230
- }
2231
-
2232
- interface AdditionalName {
2233
- /**
2234
- * The person's full name.
2235
- */
2236
- full_name?: string;
2237
-
2238
- /**
2239
- * The person's first or given name.
2240
- */
2241
- given_name?: string;
2242
-
2243
- /**
2244
- * The purpose or type of the additional name.
2245
- */
2246
- purpose: AdditionalName.Purpose;
2247
-
2248
- /**
2249
- * The person's last or family name.
2250
- */
2251
- surname?: string;
2252
- }
2253
-
2254
- namespace AdditionalName {
2255
- type Purpose = 'alias' | 'maiden';
2256
- }
2257
-
2258
- interface AdditionalTermsOfService {
2259
- /**
2260
- * Stripe terms of service agreement.
2261
- */
2262
- account?: AdditionalTermsOfService.Account;
2263
- }
2264
-
2265
- namespace AdditionalTermsOfService {
2266
- interface Account {
2267
- /**
2268
- * 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.
2269
- */
2270
- date?: string;
2271
-
2272
- /**
2273
- * The IP address from which the Account's representative accepted the terms of service.
2274
- */
2275
- ip?: string;
2276
-
2277
- /**
2278
- * The user agent of the browser from which the Account's representative accepted the terms of service.
2279
- */
2280
- user_agent?: string;
2281
- }
2282
- }
2283
-
2284
- interface Address {
2285
- /**
2286
- * City, district, suburb, town, or village.
2287
- */
2288
- city?: string | null;
2289
-
2290
- /**
2291
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2292
- */
2293
- country?: Address.Country | null;
2294
-
2295
- /**
2296
- * Address line 1 (e.g., street, PO Box, or company name).
2297
- */
2298
- line1?: string | null;
2299
-
2300
- /**
2301
- * Address line 2 (e.g., apartment, suite, unit, or building).
2302
- */
2303
- line2?: string | null;
2304
-
2305
- /**
2306
- * ZIP or postal code.
2307
- */
2308
- postal_code?: string | null;
2309
-
2310
- /**
2311
- * State, county, province, or region.
2312
- */
2313
- state?: string | null;
2314
-
2315
- /**
2316
- * Town or cho-me.
2317
- */
2318
- town?: string | null;
2319
- }
2320
-
2321
- namespace Address {
2322
- type Country =
2323
- | 'ad'
2324
- | 'ae'
2325
- | 'af'
2326
- | 'ag'
2327
- | 'ai'
2328
- | 'al'
2329
- | 'am'
2330
- | 'ao'
2331
- | 'aq'
2332
- | 'ar'
2333
- | 'as'
2334
- | 'at'
2335
- | 'au'
2336
- | 'aw'
2337
- | 'ax'
2338
- | 'az'
2339
- | 'ba'
2340
- | 'bb'
2341
- | 'bd'
2342
- | 'be'
2343
- | 'bf'
2344
- | 'bg'
2345
- | 'bh'
2346
- | 'bi'
2347
- | 'bj'
2348
- | 'bl'
2349
- | 'bm'
2350
- | 'bn'
2351
- | 'bo'
2352
- | 'bq'
2353
- | 'br'
2354
- | 'bs'
2355
- | 'bt'
2356
- | 'bv'
2357
- | 'bw'
2358
- | 'by'
2359
- | 'bz'
2360
- | 'ca'
2361
- | 'cc'
2362
- | 'cd'
2363
- | 'cf'
2364
- | 'cg'
2365
- | 'ch'
2366
- | 'ci'
2367
- | 'ck'
2368
- | 'cl'
2369
- | 'cm'
2370
- | 'cn'
2371
- | 'co'
2372
- | 'cr'
2373
- | 'cu'
2374
- | 'cv'
2375
- | 'cw'
2376
- | 'cx'
2377
- | 'cy'
2378
- | 'cz'
2379
- | 'de'
2380
- | 'dj'
2381
- | 'dk'
2382
- | 'dm'
2383
- | 'do'
2384
- | 'dz'
2385
- | 'ec'
2386
- | 'ee'
2387
- | 'eg'
2388
- | 'eh'
2389
- | 'er'
2390
- | 'es'
2391
- | 'et'
2392
- | 'fi'
2393
- | 'fj'
2394
- | 'fk'
2395
- | 'fm'
2396
- | 'fo'
2397
- | 'fr'
2398
- | 'ga'
2399
- | 'gb'
2400
- | 'gd'
2401
- | 'ge'
2402
- | 'gf'
2403
- | 'gg'
2404
- | 'gh'
2405
- | 'gi'
2406
- | 'gl'
2407
- | 'gm'
2408
- | 'gn'
2409
- | 'gp'
2410
- | 'gq'
2411
- | 'gr'
2412
- | 'gs'
2413
- | 'gt'
2414
- | 'gu'
2415
- | 'gw'
2416
- | 'gy'
2417
- | 'hk'
2418
- | 'hm'
2419
- | 'hn'
2420
- | 'hr'
2421
- | 'ht'
2422
- | 'hu'
2423
- | 'id'
2424
- | 'ie'
2425
- | 'il'
2426
- | 'im'
2427
- | 'in'
2428
- | 'io'
2429
- | 'iq'
2430
- | 'ir'
2431
- | 'is'
2432
- | 'it'
2433
- | 'je'
2434
- | 'jm'
2435
- | 'jo'
2436
- | 'jp'
2437
- | 'ke'
2438
- | 'kg'
2439
- | 'kh'
2440
- | 'ki'
2441
- | 'km'
2442
- | 'kn'
2443
- | 'kp'
2444
- | 'kr'
2445
- | 'kw'
2446
- | 'ky'
2447
- | 'kz'
2448
- | 'la'
2449
- | 'lb'
2450
- | 'lc'
2451
- | 'li'
2452
- | 'lk'
2453
- | 'lr'
2454
- | 'ls'
2455
- | 'lt'
2456
- | 'lu'
2457
- | 'lv'
2458
- | 'ly'
2459
- | 'ma'
2460
- | 'mc'
2461
- | 'md'
2462
- | 'me'
2463
- | 'mf'
2464
- | 'mg'
2465
- | 'mh'
2466
- | 'mk'
2467
- | 'ml'
2468
- | 'mm'
2469
- | 'mn'
2470
- | 'mo'
2471
- | 'mp'
2472
- | 'mq'
2473
- | 'mr'
2474
- | 'ms'
2475
- | 'mt'
2476
- | 'mu'
2477
- | 'mv'
2478
- | 'mw'
2479
- | 'mx'
2480
- | 'my'
2481
- | 'mz'
2482
- | 'na'
2483
- | 'nc'
2484
- | 'ne'
2485
- | 'nf'
2486
- | 'ng'
2487
- | 'ni'
2488
- | 'nl'
2489
- | 'no'
2490
- | 'np'
2491
- | 'nr'
2492
- | 'nu'
2493
- | 'nz'
2494
- | 'om'
2495
- | 'pa'
2496
- | 'pe'
2497
- | 'pf'
2498
- | 'pg'
2499
- | 'ph'
2500
- | 'pk'
2501
- | 'pl'
2502
- | 'pm'
2503
- | 'pn'
2504
- | 'pr'
2505
- | 'ps'
2506
- | 'pt'
2507
- | 'pw'
2508
- | 'py'
2509
- | 'qa'
2510
- | 'qz'
2511
- | 're'
2512
- | 'ro'
2513
- | 'rs'
2514
- | 'ru'
2515
- | 'rw'
2516
- | 'sa'
2517
- | 'sb'
2518
- | 'sc'
2519
- | 'sd'
2520
- | 'se'
2521
- | 'sg'
2522
- | 'sh'
2523
- | 'si'
2524
- | 'sj'
2525
- | 'sk'
2526
- | 'sl'
2527
- | 'sm'
2528
- | 'sn'
2529
- | 'so'
2530
- | 'sr'
2531
- | 'ss'
2532
- | 'st'
2533
- | 'sv'
2534
- | 'sx'
2535
- | 'sy'
2536
- | 'sz'
2537
- | 'tc'
2538
- | 'td'
2539
- | 'tf'
2540
- | 'tg'
2541
- | 'th'
2542
- | 'tj'
2543
- | 'tk'
2544
- | 'tl'
2545
- | 'tm'
2546
- | 'tn'
2547
- | 'to'
2548
- | 'tr'
2549
- | 'tt'
2550
- | 'tv'
2551
- | 'tw'
2552
- | 'tz'
2553
- | 'ua'
2554
- | 'ug'
2555
- | 'um'
2556
- | 'us'
2557
- | 'uy'
2558
- | 'uz'
2559
- | 'va'
2560
- | 'vc'
2561
- | 've'
2562
- | 'vg'
2563
- | 'vi'
2564
- | 'vn'
2565
- | 'vu'
2566
- | 'wf'
2567
- | 'ws'
2568
- | 'ye'
2569
- | 'yt'
2570
- | 'za'
2571
- | 'zm'
2572
- | 'zw';
2573
- }
2574
-
2575
- interface DateOfBirth {
2576
- /**
2577
- * The day of the birth.
2578
- */
2579
- day: number;
2580
-
2581
- /**
2582
- * The month of birth.
2583
- */
2584
- month: number;
2585
-
2586
- /**
2587
- * The year of birth.
2588
- */
2589
- year: number;
2590
- }
2591
-
2592
- interface Documents {
2593
- /**
2594
- * One or more documents that demonstrate proof that this person is authorized to represent the company.
2595
- */
2596
- company_authorization?: Documents.CompanyAuthorization;
2597
-
2598
- /**
2599
- * One or more documents showing the person's passport page with photo and personal data.
2600
- */
2601
- passport?: Documents.Passport;
2602
-
2603
- /**
2604
- * An identifying document showing the person's name, either a passport or local ID card.
2605
- */
2606
- primary_verification?: Documents.PrimaryVerification | null;
2607
-
2608
- /**
2609
- * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
2610
- */
2611
- secondary_verification?: Documents.SecondaryVerification | null;
2612
-
2613
- /**
2614
- * One or more documents showing the person's visa required for living in the country where they are residing.
2615
- */
2616
- visa?: Documents.Visa;
2617
- }
2618
-
2619
- namespace Documents {
2620
- interface CompanyAuthorization {
2621
- /**
2622
- * 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`.
2623
- */
2624
- files: Array<string>;
2625
-
2626
- /**
2627
- * The format of the document. Currently supports `files` only.
2628
- */
2629
- type: 'files';
2630
- }
2631
-
2632
- interface Passport {
2633
- /**
2634
- * 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`.
2635
- */
2636
- files: Array<string>;
2637
-
2638
- /**
2639
- * The format of the document. Currently supports `files` only.
2640
- */
2641
- type: 'files';
2642
- }
2643
-
2644
- interface PrimaryVerification {
2645
- /**
2646
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
2647
- */
2648
- front_back: PrimaryVerification.FrontBack;
2649
-
2650
- /**
2651
- * The format of the verification document. Currently supports `front_back` only.
2652
- */
2653
- type: 'front_back';
2654
- }
2655
-
2656
- namespace PrimaryVerification {
2657
- interface FrontBack {
2658
- /**
2659
- * 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.
2660
- */
2661
- back?: string | null;
2662
-
2663
- /**
2664
- * 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.
2665
- */
2666
- front?: string;
2667
- }
2668
- }
2669
-
2670
- interface SecondaryVerification {
2671
- /**
2672
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
2673
- */
2674
- front_back: SecondaryVerification.FrontBack;
2675
-
2676
- /**
2677
- * The format of the verification document. Currently supports `front_back` only.
2678
- */
2679
- type: 'front_back';
2680
- }
2681
-
2682
- namespace SecondaryVerification {
2683
- interface FrontBack {
2684
- /**
2685
- * 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.
2686
- */
2687
- back?: string | null;
2688
-
2689
- /**
2690
- * 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.
2691
- */
2692
- front?: string;
2693
- }
2694
- }
2695
-
2696
- interface Visa {
2697
- /**
2698
- * 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`.
2699
- */
2700
- files: Array<string>;
2701
-
2702
- /**
2703
- * The format of the document. Currently supports `files` only.
2704
- */
2705
- type: 'files';
2706
- }
2707
- }
2708
-
2709
- interface IdNumber {
2710
- /**
2711
- * The ID number type of an individual.
2712
- */
2713
- type: IdNumber.Type;
2714
-
2715
- /**
2716
- * The value of the ID number.
2717
- */
2718
- value: string;
2719
- }
2720
-
2721
- namespace IdNumber {
2722
- type Type =
2723
- | 'ae_eid'
2724
- | 'br_cpf'
2725
- | 'de_stn'
2726
- | 'hk_id'
2727
- | 'mx_rfc'
2728
- | 'my_nric'
2729
- | 'nl_bsn'
2730
- | 'sg_fin'
2731
- | 'sg_nric'
2732
- | 'th_lc'
2733
- | 'th_pin'
2734
- | 'us_itin'
2735
- | 'us_itin_last_4'
2736
- | 'us_ssn'
2737
- | 'us_ssn_last_4';
2738
- }
2739
-
2740
- type LegalGender = 'female' | 'male';
2741
-
2742
- type Nationality =
2743
- | 'ad'
2744
- | 'ae'
2745
- | 'af'
2746
- | 'ag'
2747
- | 'ai'
2748
- | 'al'
2749
- | 'am'
2750
- | 'ao'
2751
- | 'aq'
2752
- | 'ar'
2753
- | 'as'
2754
- | 'at'
2755
- | 'au'
2756
- | 'aw'
2757
- | 'ax'
2758
- | 'az'
2759
- | 'ba'
2760
- | 'bb'
2761
- | 'bd'
2762
- | 'be'
2763
- | 'bf'
2764
- | 'bg'
2765
- | 'bh'
2766
- | 'bi'
2767
- | 'bj'
2768
- | 'bl'
2769
- | 'bm'
2770
- | 'bn'
2771
- | 'bo'
2772
- | 'bq'
2773
- | 'br'
2774
- | 'bs'
2775
- | 'bt'
2776
- | 'bv'
2777
- | 'bw'
2778
- | 'by'
2779
- | 'bz'
2780
- | 'ca'
2781
- | 'cc'
2782
- | 'cd'
2783
- | 'cf'
2784
- | 'cg'
2785
- | 'ch'
2786
- | 'ci'
2787
- | 'ck'
2788
- | 'cl'
2789
- | 'cm'
2790
- | 'cn'
2791
- | 'co'
2792
- | 'cr'
2793
- | 'cu'
2794
- | 'cv'
2795
- | 'cw'
2796
- | 'cx'
2797
- | 'cy'
2798
- | 'cz'
2799
- | 'de'
2800
- | 'dj'
2801
- | 'dk'
2802
- | 'dm'
2803
- | 'do'
2804
- | 'dz'
2805
- | 'ec'
2806
- | 'ee'
2807
- | 'eg'
2808
- | 'eh'
2809
- | 'er'
2810
- | 'es'
2811
- | 'et'
2812
- | 'fi'
2813
- | 'fj'
2814
- | 'fk'
2815
- | 'fm'
2816
- | 'fo'
2817
- | 'fr'
2818
- | 'ga'
2819
- | 'gb'
2820
- | 'gd'
2821
- | 'ge'
2822
- | 'gf'
2823
- | 'gg'
2824
- | 'gh'
2825
- | 'gi'
2826
- | 'gl'
2827
- | 'gm'
2828
- | 'gn'
2829
- | 'gp'
2830
- | 'gq'
2831
- | 'gr'
2832
- | 'gs'
2833
- | 'gt'
2834
- | 'gu'
2835
- | 'gw'
2836
- | 'gy'
2837
- | 'hk'
2838
- | 'hm'
2839
- | 'hn'
2840
- | 'hr'
2841
- | 'ht'
2842
- | 'hu'
2843
- | 'id'
2844
- | 'ie'
2845
- | 'il'
2846
- | 'im'
2847
- | 'in'
2848
- | 'io'
2849
- | 'iq'
2850
- | 'ir'
2851
- | 'is'
2852
- | 'it'
2853
- | 'je'
2854
- | 'jm'
2855
- | 'jo'
2856
- | 'jp'
2857
- | 'ke'
2858
- | 'kg'
2859
- | 'kh'
2860
- | 'ki'
2861
- | 'km'
2862
- | 'kn'
2863
- | 'kp'
2864
- | 'kr'
2865
- | 'kw'
2866
- | 'ky'
2867
- | 'kz'
2868
- | 'la'
2869
- | 'lb'
2870
- | 'lc'
2871
- | 'li'
2872
- | 'lk'
2873
- | 'lr'
2874
- | 'ls'
2875
- | 'lt'
2876
- | 'lu'
2877
- | 'lv'
2878
- | 'ly'
2879
- | 'ma'
2880
- | 'mc'
2881
- | 'md'
2882
- | 'me'
2883
- | 'mf'
2884
- | 'mg'
2885
- | 'mh'
2886
- | 'mk'
2887
- | 'ml'
2888
- | 'mm'
2889
- | 'mn'
2890
- | 'mo'
2891
- | 'mp'
2892
- | 'mq'
2893
- | 'mr'
2894
- | 'ms'
2895
- | 'mt'
2896
- | 'mu'
2897
- | 'mv'
2898
- | 'mw'
2899
- | 'mx'
2900
- | 'my'
2901
- | 'mz'
2902
- | 'na'
2903
- | 'nc'
2904
- | 'ne'
2905
- | 'nf'
2906
- | 'ng'
2907
- | 'ni'
2908
- | 'nl'
2909
- | 'no'
2910
- | 'np'
2911
- | 'nr'
2912
- | 'nu'
2913
- | 'nz'
2914
- | 'om'
2915
- | 'pa'
2916
- | 'pe'
2917
- | 'pf'
2918
- | 'pg'
2919
- | 'ph'
2920
- | 'pk'
2921
- | 'pl'
2922
- | 'pm'
2923
- | 'pn'
2924
- | 'pr'
2925
- | 'ps'
2926
- | 'pt'
2927
- | 'pw'
2928
- | 'py'
2929
- | 'qa'
2930
- | 'qz'
2931
- | 're'
2932
- | 'ro'
2933
- | 'rs'
2934
- | 'ru'
2935
- | 'rw'
2936
- | 'sa'
2937
- | 'sb'
2938
- | 'sc'
2939
- | 'sd'
2940
- | 'se'
2941
- | 'sg'
2942
- | 'sh'
2943
- | 'si'
2944
- | 'sj'
2945
- | 'sk'
2946
- | 'sl'
2947
- | 'sm'
2948
- | 'sn'
2949
- | 'so'
2950
- | 'sr'
2951
- | 'ss'
2952
- | 'st'
2953
- | 'sv'
2954
- | 'sx'
2955
- | 'sy'
2956
- | 'sz'
2957
- | 'tc'
2958
- | 'td'
2959
- | 'tf'
2960
- | 'tg'
2961
- | 'th'
2962
- | 'tj'
2963
- | 'tk'
2964
- | 'tl'
2965
- | 'tm'
2966
- | 'tn'
2967
- | 'to'
2968
- | 'tr'
2969
- | 'tt'
2970
- | 'tv'
2971
- | 'tw'
2972
- | 'tz'
2973
- | 'ua'
2974
- | 'ug'
2975
- | 'um'
2976
- | 'us'
2977
- | 'uy'
2978
- | 'uz'
2979
- | 'va'
2980
- | 'vc'
2981
- | 've'
2982
- | 'vg'
2983
- | 'vi'
2984
- | 'vn'
2985
- | 'vu'
2986
- | 'wf'
2987
- | 'ws'
2988
- | 'ye'
2989
- | 'yt'
2990
- | 'za'
2991
- | 'zm'
2992
- | 'zw';
2993
-
2994
- type PoliticalExposure = 'existing' | 'none';
2995
-
2996
- interface Relationship {
2997
- /**
2998
- * Indicates whether the person is a director of the associated legal entity.
2999
- */
3000
- director?: boolean;
3001
-
3002
- /**
3003
- * Indicates whether the person is an executive of the associated legal entity.
3004
- */
3005
- executive?: boolean;
3006
-
3007
- /**
3008
- * Indicates whether the person is a legal guardian of the associated legal entity.
3009
- */
3010
- legal_guardian?: boolean;
3011
-
3012
- /**
3013
- * Indicates whether the person is an owner of the associated legal entity.
3014
- */
3015
- owner?: boolean;
3016
-
3017
- /**
3018
- * The percentage of ownership the person has in the associated legal entity.
3019
- */
3020
- percent_ownership?: string;
3021
-
3022
- /**
3023
- * Indicates whether the person is a representative of the associated legal entity.
3024
- */
3025
- representative?: boolean;
3026
-
3027
- /**
3028
- * The title or position the person holds in the associated legal entity.
3029
- */
3030
- title?: string;
3031
- }
3032
-
3033
- interface ScriptAddresses {
3034
- /**
3035
- * Kana Address.
3036
- */
3037
- kana?: ScriptAddresses.Kana | null;
3038
-
3039
- /**
3040
- * Kanji Address.
3041
- */
3042
- kanji?: ScriptAddresses.Kanji | null;
3043
- }
3044
-
3045
- namespace ScriptAddresses {
3046
- interface Kana {
3047
- /**
3048
- * City, district, suburb, town, or village.
3049
- */
3050
- city?: string | null;
3051
-
3052
- /**
3053
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3054
- */
3055
- country?: Kana.Country | null;
3056
-
3057
- /**
3058
- * Address line 1 (e.g., street, PO Box, or company name).
3059
- */
3060
- line1?: string | null;
3061
-
3062
- /**
3063
- * Address line 2 (e.g., apartment, suite, unit, or building).
3064
- */
3065
- line2?: string | null;
3066
-
3067
- /**
3068
- * ZIP or postal code.
3069
- */
3070
- postal_code?: string | null;
3071
-
3072
- /**
3073
- * State, county, province, or region.
3074
- */
3075
- state?: string | null;
3076
-
3077
- /**
3078
- * Town or cho-me.
3079
- */
3080
- town?: string | null;
3081
- }
3082
-
3083
- namespace Kana {
3084
- type Country =
3085
- | 'ad'
3086
- | 'ae'
3087
- | 'af'
3088
- | 'ag'
3089
- | 'ai'
3090
- | 'al'
3091
- | 'am'
3092
- | 'ao'
3093
- | 'aq'
3094
- | 'ar'
3095
- | 'as'
3096
- | 'at'
3097
- | 'au'
3098
- | 'aw'
3099
- | 'ax'
3100
- | 'az'
3101
- | 'ba'
3102
- | 'bb'
3103
- | 'bd'
3104
- | 'be'
3105
- | 'bf'
3106
- | 'bg'
3107
- | 'bh'
3108
- | 'bi'
3109
- | 'bj'
3110
- | 'bl'
3111
- | 'bm'
3112
- | 'bn'
3113
- | 'bo'
3114
- | 'bq'
3115
- | 'br'
3116
- | 'bs'
3117
- | 'bt'
3118
- | 'bv'
3119
- | 'bw'
3120
- | 'by'
3121
- | 'bz'
3122
- | 'ca'
3123
- | 'cc'
3124
- | 'cd'
3125
- | 'cf'
3126
- | 'cg'
3127
- | 'ch'
3128
- | 'ci'
3129
- | 'ck'
3130
- | 'cl'
3131
- | 'cm'
3132
- | 'cn'
3133
- | 'co'
3134
- | 'cr'
3135
- | 'cu'
3136
- | 'cv'
3137
- | 'cw'
3138
- | 'cx'
3139
- | 'cy'
3140
- | 'cz'
3141
- | 'de'
3142
- | 'dj'
3143
- | 'dk'
3144
- | 'dm'
3145
- | 'do'
3146
- | 'dz'
3147
- | 'ec'
3148
- | 'ee'
3149
- | 'eg'
3150
- | 'eh'
3151
- | 'er'
3152
- | 'es'
3153
- | 'et'
3154
- | 'fi'
3155
- | 'fj'
3156
- | 'fk'
3157
- | 'fm'
3158
- | 'fo'
3159
- | 'fr'
3160
- | 'ga'
3161
- | 'gb'
3162
- | 'gd'
3163
- | 'ge'
3164
- | 'gf'
3165
- | 'gg'
3166
- | 'gh'
3167
- | 'gi'
3168
- | 'gl'
3169
- | 'gm'
3170
- | 'gn'
3171
- | 'gp'
3172
- | 'gq'
3173
- | 'gr'
3174
- | 'gs'
3175
- | 'gt'
3176
- | 'gu'
3177
- | 'gw'
3178
- | 'gy'
3179
- | 'hk'
3180
- | 'hm'
3181
- | 'hn'
3182
- | 'hr'
3183
- | 'ht'
3184
- | 'hu'
3185
- | 'id'
3186
- | 'ie'
3187
- | 'il'
3188
- | 'im'
3189
- | 'in'
3190
- | 'io'
3191
- | 'iq'
3192
- | 'ir'
3193
- | 'is'
3194
- | 'it'
3195
- | 'je'
3196
- | 'jm'
3197
- | 'jo'
3198
- | 'jp'
3199
- | 'ke'
3200
- | 'kg'
3201
- | 'kh'
3202
- | 'ki'
3203
- | 'km'
3204
- | 'kn'
3205
- | 'kp'
3206
- | 'kr'
3207
- | 'kw'
3208
- | 'ky'
3209
- | 'kz'
3210
- | 'la'
3211
- | 'lb'
3212
- | 'lc'
3213
- | 'li'
3214
- | 'lk'
3215
- | 'lr'
3216
- | 'ls'
3217
- | 'lt'
3218
- | 'lu'
3219
- | 'lv'
3220
- | 'ly'
3221
- | 'ma'
3222
- | 'mc'
3223
- | 'md'
3224
- | 'me'
3225
- | 'mf'
3226
- | 'mg'
3227
- | 'mh'
3228
- | 'mk'
3229
- | 'ml'
3230
- | 'mm'
3231
- | 'mn'
3232
- | 'mo'
3233
- | 'mp'
3234
- | 'mq'
3235
- | 'mr'
3236
- | 'ms'
3237
- | 'mt'
3238
- | 'mu'
3239
- | 'mv'
3240
- | 'mw'
3241
- | 'mx'
3242
- | 'my'
3243
- | 'mz'
3244
- | 'na'
3245
- | 'nc'
3246
- | 'ne'
3247
- | 'nf'
3248
- | 'ng'
3249
- | 'ni'
3250
- | 'nl'
3251
- | 'no'
3252
- | 'np'
3253
- | 'nr'
3254
- | 'nu'
3255
- | 'nz'
3256
- | 'om'
3257
- | 'pa'
3258
- | 'pe'
3259
- | 'pf'
3260
- | 'pg'
3261
- | 'ph'
3262
- | 'pk'
3263
- | 'pl'
3264
- | 'pm'
3265
- | 'pn'
3266
- | 'pr'
3267
- | 'ps'
3268
- | 'pt'
3269
- | 'pw'
3270
- | 'py'
3271
- | 'qa'
3272
- | 'qz'
3273
- | 're'
3274
- | 'ro'
3275
- | 'rs'
3276
- | 'ru'
3277
- | 'rw'
3278
- | 'sa'
3279
- | 'sb'
3280
- | 'sc'
3281
- | 'sd'
3282
- | 'se'
3283
- | 'sg'
3284
- | 'sh'
3285
- | 'si'
3286
- | 'sj'
3287
- | 'sk'
3288
- | 'sl'
3289
- | 'sm'
3290
- | 'sn'
3291
- | 'so'
3292
- | 'sr'
3293
- | 'ss'
3294
- | 'st'
3295
- | 'sv'
3296
- | 'sx'
3297
- | 'sy'
3298
- | 'sz'
3299
- | 'tc'
3300
- | 'td'
3301
- | 'tf'
3302
- | 'tg'
3303
- | 'th'
3304
- | 'tj'
3305
- | 'tk'
3306
- | 'tl'
3307
- | 'tm'
3308
- | 'tn'
3309
- | 'to'
3310
- | 'tr'
3311
- | 'tt'
3312
- | 'tv'
3313
- | 'tw'
3314
- | 'tz'
3315
- | 'ua'
3316
- | 'ug'
3317
- | 'um'
3318
- | 'us'
3319
- | 'uy'
3320
- | 'uz'
3321
- | 'va'
3322
- | 'vc'
3323
- | 've'
3324
- | 'vg'
3325
- | 'vi'
3326
- | 'vn'
3327
- | 'vu'
3328
- | 'wf'
3329
- | 'ws'
3330
- | 'ye'
3331
- | 'yt'
3332
- | 'za'
3333
- | 'zm'
3334
- | 'zw';
3335
- }
3336
-
3337
- interface Kanji {
3338
- /**
3339
- * City, district, suburb, town, or village.
3340
- */
3341
- city?: string | null;
3342
-
3343
- /**
3344
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3345
- */
3346
- country?: Kanji.Country | null;
3347
-
3348
- /**
3349
- * Address line 1 (e.g., street, PO Box, or company name).
3350
- */
3351
- line1?: string | null;
3352
-
3353
- /**
3354
- * Address line 2 (e.g., apartment, suite, unit, or building).
3355
- */
3356
- line2?: string | null;
3357
-
3358
- /**
3359
- * ZIP or postal code.
3360
- */
3361
- postal_code?: string | null;
3362
-
3363
- /**
3364
- * State, county, province, or region.
3365
- */
3366
- state?: string | null;
3367
-
3368
- /**
3369
- * Town or cho-me.
3370
- */
3371
- town?: string | null;
3372
- }
3373
-
3374
- namespace Kanji {
3375
- type Country =
3376
- | 'ad'
3377
- | 'ae'
3378
- | 'af'
3379
- | 'ag'
3380
- | 'ai'
3381
- | 'al'
3382
- | 'am'
3383
- | 'ao'
3384
- | 'aq'
3385
- | 'ar'
3386
- | 'as'
3387
- | 'at'
3388
- | 'au'
3389
- | 'aw'
3390
- | 'ax'
3391
- | 'az'
3392
- | 'ba'
3393
- | 'bb'
3394
- | 'bd'
3395
- | 'be'
3396
- | 'bf'
3397
- | 'bg'
3398
- | 'bh'
3399
- | 'bi'
3400
- | 'bj'
3401
- | 'bl'
3402
- | 'bm'
3403
- | 'bn'
3404
- | 'bo'
3405
- | 'bq'
3406
- | 'br'
3407
- | 'bs'
3408
- | 'bt'
3409
- | 'bv'
3410
- | 'bw'
3411
- | 'by'
3412
- | 'bz'
3413
- | 'ca'
3414
- | 'cc'
3415
- | 'cd'
3416
- | 'cf'
3417
- | 'cg'
3418
- | 'ch'
3419
- | 'ci'
3420
- | 'ck'
3421
- | 'cl'
3422
- | 'cm'
3423
- | 'cn'
3424
- | 'co'
3425
- | 'cr'
3426
- | 'cu'
3427
- | 'cv'
3428
- | 'cw'
3429
- | 'cx'
3430
- | 'cy'
3431
- | 'cz'
3432
- | 'de'
3433
- | 'dj'
3434
- | 'dk'
3435
- | 'dm'
3436
- | 'do'
3437
- | 'dz'
3438
- | 'ec'
3439
- | 'ee'
3440
- | 'eg'
3441
- | 'eh'
3442
- | 'er'
3443
- | 'es'
3444
- | 'et'
3445
- | 'fi'
3446
- | 'fj'
3447
- | 'fk'
3448
- | 'fm'
3449
- | 'fo'
3450
- | 'fr'
3451
- | 'ga'
3452
- | 'gb'
3453
- | 'gd'
3454
- | 'ge'
3455
- | 'gf'
3456
- | 'gg'
3457
- | 'gh'
3458
- | 'gi'
3459
- | 'gl'
3460
- | 'gm'
3461
- | 'gn'
3462
- | 'gp'
3463
- | 'gq'
3464
- | 'gr'
3465
- | 'gs'
3466
- | 'gt'
3467
- | 'gu'
3468
- | 'gw'
3469
- | 'gy'
3470
- | 'hk'
3471
- | 'hm'
3472
- | 'hn'
3473
- | 'hr'
3474
- | 'ht'
3475
- | 'hu'
3476
- | 'id'
3477
- | 'ie'
3478
- | 'il'
3479
- | 'im'
3480
- | 'in'
3481
- | 'io'
3482
- | 'iq'
3483
- | 'ir'
3484
- | 'is'
3485
- | 'it'
3486
- | 'je'
3487
- | 'jm'
3488
- | 'jo'
3489
- | 'jp'
3490
- | 'ke'
3491
- | 'kg'
3492
- | 'kh'
3493
- | 'ki'
3494
- | 'km'
3495
- | 'kn'
3496
- | 'kp'
3497
- | 'kr'
3498
- | 'kw'
3499
- | 'ky'
3500
- | 'kz'
3501
- | 'la'
3502
- | 'lb'
3503
- | 'lc'
3504
- | 'li'
3505
- | 'lk'
3506
- | 'lr'
3507
- | 'ls'
3508
- | 'lt'
3509
- | 'lu'
3510
- | 'lv'
3511
- | 'ly'
3512
- | 'ma'
3513
- | 'mc'
3514
- | 'md'
3515
- | 'me'
3516
- | 'mf'
3517
- | 'mg'
3518
- | 'mh'
3519
- | 'mk'
3520
- | 'ml'
3521
- | 'mm'
3522
- | 'mn'
3523
- | 'mo'
3524
- | 'mp'
3525
- | 'mq'
3526
- | 'mr'
3527
- | 'ms'
3528
- | 'mt'
3529
- | 'mu'
3530
- | 'mv'
3531
- | 'mw'
3532
- | 'mx'
3533
- | 'my'
3534
- | 'mz'
3535
- | 'na'
3536
- | 'nc'
3537
- | 'ne'
3538
- | 'nf'
3539
- | 'ng'
3540
- | 'ni'
3541
- | 'nl'
3542
- | 'no'
3543
- | 'np'
3544
- | 'nr'
3545
- | 'nu'
3546
- | 'nz'
3547
- | 'om'
3548
- | 'pa'
3549
- | 'pe'
3550
- | 'pf'
3551
- | 'pg'
3552
- | 'ph'
3553
- | 'pk'
3554
- | 'pl'
3555
- | 'pm'
3556
- | 'pn'
3557
- | 'pr'
3558
- | 'ps'
3559
- | 'pt'
3560
- | 'pw'
3561
- | 'py'
3562
- | 'qa'
3563
- | 'qz'
3564
- | 're'
3565
- | 'ro'
3566
- | 'rs'
3567
- | 'ru'
3568
- | 'rw'
3569
- | 'sa'
3570
- | 'sb'
3571
- | 'sc'
3572
- | 'sd'
3573
- | 'se'
3574
- | 'sg'
3575
- | 'sh'
3576
- | 'si'
3577
- | 'sj'
3578
- | 'sk'
3579
- | 'sl'
3580
- | 'sm'
3581
- | 'sn'
3582
- | 'so'
3583
- | 'sr'
3584
- | 'ss'
3585
- | 'st'
3586
- | 'sv'
3587
- | 'sx'
3588
- | 'sy'
3589
- | 'sz'
3590
- | 'tc'
3591
- | 'td'
3592
- | 'tf'
3593
- | 'tg'
3594
- | 'th'
3595
- | 'tj'
3596
- | 'tk'
3597
- | 'tl'
3598
- | 'tm'
3599
- | 'tn'
3600
- | 'to'
3601
- | 'tr'
3602
- | 'tt'
3603
- | 'tv'
3604
- | 'tw'
3605
- | 'tz'
3606
- | 'ua'
3607
- | 'ug'
3608
- | 'um'
3609
- | 'us'
3610
- | 'uy'
3611
- | 'uz'
3612
- | 'va'
3613
- | 'vc'
3614
- | 've'
3615
- | 'vg'
3616
- | 'vi'
3617
- | 'vn'
3618
- | 'vu'
3619
- | 'wf'
3620
- | 'ws'
3621
- | 'ye'
3622
- | 'yt'
3623
- | 'za'
3624
- | 'zm'
3625
- | 'zw';
3626
- }
3627
- }
3628
-
3629
- interface ScriptNames {
3630
- /**
3631
- * Persons name in kana script.
3632
- */
3633
- kana?: ScriptNames.Kana | null;
3634
-
3635
- /**
3636
- * Persons name in kanji script.
3637
- */
3638
- kanji?: ScriptNames.Kanji | null;
3639
- }
3640
-
3641
- namespace ScriptNames {
3642
- interface Kana {
3643
- /**
3644
- * The person's first or given name.
3645
- */
3646
- given_name?: string | null;
3647
-
3648
- /**
3649
- * The person's last or family name.
3650
- */
3651
- surname?: string | null;
3652
- }
3653
-
3654
- interface Kanji {
3655
- /**
3656
- * The person's first or given name.
3657
- */
3658
- given_name?: string | null;
3659
-
3660
- /**
3661
- * The person's last or family name.
3662
- */
3663
- surname?: string | null;
3664
- }
3665
- }
3666
- }
3667
- }
3668
- }
3669
-
3670
- namespace Core {
3671
- namespace Accounts {
3672
- interface PersonListParams {
3673
- /**
3674
- * The upper limit on the number of accounts returned by the List Account request.
3675
- */
3676
- limit?: number;
3677
- }
3678
- }
3679
- }
3680
-
3681
- namespace Core {
3682
- namespace Accounts {
3683
- interface PersonDeleteParams {}
3684
- }
3685
- }
3686
-
3687
- namespace Core {
3688
- namespace Accounts {
3689
- class PersonsResource {
3690
- /**
3691
- * Create a Person associated with an Account.
3692
- */
3693
- create(
3694
- id: string,
3695
- params?: PersonCreateParams,
3696
- options?: RequestOptions
3697
- ): Promise<Stripe.Response<Stripe.V2.Core.Person>>;
3698
- create(
3699
- id: string,
3700
- options?: RequestOptions
3701
- ): Promise<Stripe.Response<Stripe.V2.Core.Person>>;
3702
-
3703
- /**
3704
- * Retrieves a Person associated with an Account.
3705
- */
3706
- retrieve(
3707
- accountId: string,
3708
- id: string,
3709
- params?: PersonRetrieveParams,
3710
- options?: RequestOptions
3711
- ): Promise<Stripe.Response<Stripe.V2.Core.Person>>;
3712
- retrieve(
3713
- accountId: string,
3714
- id: string,
3715
- options?: RequestOptions
3716
- ): Promise<Stripe.Response<Stripe.V2.Core.Person>>;
3717
-
3718
- /**
3719
- * Updates a Person associated with an Account.
3720
- */
3721
- update(
3722
- accountId: string,
3723
- id: string,
3724
- params?: PersonUpdateParams,
3725
- options?: RequestOptions
3726
- ): Promise<Stripe.Response<Stripe.V2.Core.Person>>;
3727
-
3728
- /**
3729
- * Returns a list of Persons associated with an Account.
3730
- */
3731
- list(
3732
- id: string,
3733
- params?: PersonListParams,
3734
- options?: RequestOptions
3735
- ): ApiListPromise<Stripe.V2.Core.Person>;
3736
- list(
3737
- id: string,
3738
- options?: RequestOptions
3739
- ): ApiListPromise<Stripe.V2.Core.Person>;
3740
-
3741
- /**
3742
- * Delete a Person associated with an Account.
3743
- */
3744
- del(
3745
- accountId: string,
3746
- id: string,
3747
- params?: PersonDeleteParams,
3748
- options?: RequestOptions
3749
- ): Promise<Stripe.Response<Stripe.V2.Core.Person>>;
3750
- del(
3751
- accountId: string,
3752
- id: string,
3753
- options?: RequestOptions
3754
- ): Promise<Stripe.Response<Stripe.V2.Core.Person>>;
3755
- }
3756
- }
3757
- }
3758
- }
3759
- }
3760
- }