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