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