increase 0.11.1 → 0.11.2

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 (506) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/README.md +5 -1
  3. package/_shims/MultipartBody.d.ts +9 -0
  4. package/_shims/MultipartBody.d.ts.map +1 -0
  5. package/_shims/MultipartBody.js +16 -0
  6. package/_shims/MultipartBody.js.map +1 -0
  7. package/_shims/MultipartBody.mjs +12 -0
  8. package/_shims/MultipartBody.mjs.map +1 -0
  9. package/_shims/README.md +46 -0
  10. package/{src/_shims/ReadableStream-node.ts → _shims/auto/runtime-bun.d.ts} +2 -3
  11. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  12. package/_shims/auto/runtime-bun.js +21 -0
  13. package/_shims/auto/runtime-bun.js.map +1 -0
  14. package/_shims/auto/runtime-bun.mjs +2 -0
  15. package/_shims/auto/runtime-bun.mjs.map +1 -0
  16. package/_shims/auto/runtime-node.d.ts +5 -0
  17. package/_shims/auto/runtime-node.d.ts.map +1 -0
  18. package/_shims/auto/runtime-node.js +21 -0
  19. package/_shims/auto/runtime-node.js.map +1 -0
  20. package/_shims/auto/runtime-node.mjs +2 -0
  21. package/_shims/auto/runtime-node.mjs.map +1 -0
  22. package/_shims/auto/runtime.d.ts +5 -0
  23. package/_shims/auto/runtime.d.ts.map +1 -0
  24. package/_shims/auto/runtime.js +21 -0
  25. package/_shims/auto/runtime.js.map +1 -0
  26. package/_shims/auto/runtime.mjs +2 -0
  27. package/_shims/auto/runtime.mjs.map +1 -0
  28. package/_shims/auto/types-node.d.ts +5 -0
  29. package/_shims/auto/types-node.d.ts.map +1 -0
  30. package/_shims/auto/types-node.js +21 -0
  31. package/_shims/auto/types-node.js.map +1 -0
  32. package/_shims/auto/types-node.mjs +2 -0
  33. package/_shims/auto/types-node.mjs.map +1 -0
  34. package/_shims/auto/types.d.ts +99 -0
  35. package/_shims/{ReadableStream.js → auto/types.js} +0 -2
  36. package/{src/_shims/ReadableStream.js → _shims/auto/types.mjs} +0 -2
  37. package/_shims/bun-runtime.d.ts +6 -0
  38. package/_shims/bun-runtime.d.ts.map +1 -0
  39. package/_shims/bun-runtime.js +14 -0
  40. package/_shims/bun-runtime.js.map +1 -0
  41. package/_shims/bun-runtime.mjs +10 -0
  42. package/_shims/bun-runtime.mjs.map +1 -0
  43. package/_shims/index.d.ts +79 -0
  44. package/_shims/index.js +13 -0
  45. package/_shims/index.mjs +7 -0
  46. package/_shims/manual-types.d.ts +12 -0
  47. package/_shims/manual-types.js +3 -0
  48. package/_shims/manual-types.mjs +3 -0
  49. package/_shims/node-runtime.d.ts +3 -0
  50. package/_shims/node-runtime.d.ts.map +1 -0
  51. package/_shims/node-runtime.js +87 -0
  52. package/_shims/node-runtime.js.map +1 -0
  53. package/_shims/node-runtime.mjs +54 -0
  54. package/_shims/node-runtime.mjs.map +1 -0
  55. package/_shims/node-types.d.ts +42 -0
  56. package/_shims/node-types.js +3 -0
  57. package/_shims/node-types.mjs +3 -0
  58. package/_shims/registry.d.ts +35 -0
  59. package/_shims/registry.d.ts.map +1 -0
  60. package/_shims/registry.js +39 -0
  61. package/_shims/registry.js.map +1 -0
  62. package/_shims/registry.mjs +35 -0
  63. package/_shims/registry.mjs.map +1 -0
  64. package/_shims/web-runtime.d.ts +5 -0
  65. package/_shims/web-runtime.d.ts.map +1 -0
  66. package/_shims/web-runtime.js +70 -0
  67. package/_shims/web-runtime.js.map +1 -0
  68. package/_shims/web-runtime.mjs +63 -0
  69. package/_shims/web-runtime.mjs.map +1 -0
  70. package/_shims/web-types.d.ts +82 -0
  71. package/_shims/web-types.js +3 -0
  72. package/_shims/web-types.mjs +3 -0
  73. package/core.d.ts +170 -218
  74. package/core.d.ts.map +1 -1
  75. package/core.js +673 -731
  76. package/core.js.map +1 -1
  77. package/core.mjs +667 -682
  78. package/core.mjs.map +1 -1
  79. package/error.d.ts +104 -177
  80. package/error.js +247 -280
  81. package/error.mjs +244 -252
  82. package/index.d.mts +332 -356
  83. package/index.d.ts +332 -356
  84. package/index.d.ts.map +1 -1
  85. package/index.js +193 -264
  86. package/index.mjs +170 -198
  87. package/package.json +31 -58
  88. package/pagination.d.ts +25 -25
  89. package/pagination.js +29 -25
  90. package/pagination.mjs +27 -23
  91. package/resource.d.ts +10 -10
  92. package/resource.js +12 -12
  93. package/resource.mjs +10 -10
  94. package/resources/account-numbers.d.ts +162 -168
  95. package/resources/account-numbers.js +33 -31
  96. package/resources/account-numbers.mjs +28 -26
  97. package/resources/account-statements.d.ts +79 -81
  98. package/resources/account-statements.js +21 -21
  99. package/resources/account-statements.mjs +16 -14
  100. package/resources/account-transfers.d.ts +192 -194
  101. package/resources/account-transfers.js +39 -39
  102. package/resources/account-transfers.mjs +34 -32
  103. package/resources/accounts.d.ts +148 -151
  104. package/resources/accounts.js +39 -37
  105. package/resources/accounts.mjs +34 -32
  106. package/resources/ach-prenotifications.d.ts +370 -438
  107. package/resources/ach-prenotifications.d.ts.map +1 -1
  108. package/resources/ach-prenotifications.js +27 -27
  109. package/resources/ach-prenotifications.js.map +1 -1
  110. package/resources/ach-prenotifications.mjs +22 -20
  111. package/resources/ach-prenotifications.mjs.map +1 -1
  112. package/resources/ach-transfers.d.ts +604 -679
  113. package/resources/ach-transfers.d.ts.map +1 -1
  114. package/resources/ach-transfers.js +39 -37
  115. package/resources/ach-transfers.js.map +1 -1
  116. package/resources/ach-transfers.mjs +34 -32
  117. package/resources/ach-transfers.mjs.map +1 -1
  118. package/resources/balance-lookups.d.ts +35 -38
  119. package/resources/balance-lookups.js +12 -11
  120. package/resources/balance-lookups.mjs +9 -8
  121. package/resources/bookkeeping-accounts.d.ts +66 -70
  122. package/resources/bookkeeping-accounts.js +21 -21
  123. package/resources/bookkeeping-accounts.mjs +16 -14
  124. package/resources/bookkeeping-entries.d.ts +36 -37
  125. package/resources/bookkeeping-entries.js +15 -15
  126. package/resources/bookkeeping-entries.mjs +10 -8
  127. package/resources/bookkeeping-entry-sets.d.ts +61 -64
  128. package/resources/bookkeeping-entry-sets.js +12 -13
  129. package/resources/bookkeeping-entry-sets.mjs +9 -8
  130. package/resources/card-disputes.d.ts +127 -129
  131. package/resources/card-disputes.js +27 -25
  132. package/resources/card-disputes.mjs +22 -20
  133. package/resources/card-profiles.d.ts +235 -245
  134. package/resources/card-profiles.js +33 -31
  135. package/resources/card-profiles.mjs +28 -26
  136. package/resources/card-purchase-supplements.d.ts +219 -238
  137. package/resources/card-purchase-supplements.js +21 -21
  138. package/resources/card-purchase-supplements.mjs +16 -14
  139. package/resources/cards.d.ts +288 -279
  140. package/resources/cards.d.ts.map +1 -1
  141. package/resources/cards.js +39 -37
  142. package/resources/cards.js.map +1 -1
  143. package/resources/cards.mjs +34 -32
  144. package/resources/cards.mjs.map +1 -1
  145. package/resources/check-deposits.d.ts +238 -260
  146. package/resources/check-deposits.js +27 -25
  147. package/resources/check-deposits.mjs +22 -20
  148. package/resources/check-transfers.d.ts +487 -503
  149. package/resources/check-transfers.js +45 -43
  150. package/resources/check-transfers.mjs +40 -38
  151. package/resources/declined-transactions.d.ts +806 -926
  152. package/resources/declined-transactions.js +21 -21
  153. package/resources/declined-transactions.mjs +16 -14
  154. package/resources/digital-wallet-tokens.d.ts +75 -77
  155. package/resources/digital-wallet-tokens.js +21 -21
  156. package/resources/digital-wallet-tokens.mjs +16 -14
  157. package/resources/documents.d.ts +78 -77
  158. package/resources/documents.js +21 -19
  159. package/resources/documents.mjs +16 -14
  160. package/resources/entities/beneficial-owners.d.ts +233 -244
  161. package/resources/entities/beneficial-owners.js +24 -25
  162. package/resources/entities/beneficial-owners.mjs +21 -20
  163. package/resources/entities/entities.d.ts +1532 -1585
  164. package/resources/entities/entities.d.ts.map +1 -1
  165. package/resources/entities/entities.js +67 -83
  166. package/resources/entities/entities.mjs +43 -42
  167. package/resources/entities/index.d.ts +4 -22
  168. package/resources/entities/index.js +12 -42
  169. package/resources/entities/index.mjs +4 -4
  170. package/resources/entities/supplemental-documents.d.ts +38 -44
  171. package/resources/entities/supplemental-documents.js +24 -24
  172. package/resources/entities/supplemental-documents.mjs +20 -18
  173. package/resources/event-subscriptions.d.ts +242 -355
  174. package/resources/event-subscriptions.js +33 -33
  175. package/resources/event-subscriptions.mjs +28 -26
  176. package/resources/events.d.ts +150 -254
  177. package/resources/events.js +21 -19
  178. package/resources/events.mjs +16 -14
  179. package/resources/exports.d.ts +210 -158
  180. package/resources/exports.d.ts.map +1 -1
  181. package/resources/exports.js +27 -25
  182. package/resources/exports.js.map +1 -1
  183. package/resources/exports.mjs +22 -20
  184. package/resources/exports.mjs.map +1 -1
  185. package/resources/external-accounts.d.ts +122 -128
  186. package/resources/external-accounts.js +33 -33
  187. package/resources/external-accounts.mjs +28 -26
  188. package/resources/files.d.ts +149 -196
  189. package/resources/files.js +30 -28
  190. package/resources/files.mjs +24 -22
  191. package/resources/groups.d.ts +35 -35
  192. package/resources/groups.js +12 -11
  193. package/resources/groups.mjs +9 -8
  194. package/resources/inbound-ach-transfers.d.ts +265 -305
  195. package/resources/inbound-ach-transfers.js +42 -42
  196. package/resources/inbound-ach-transfers.mjs +37 -35
  197. package/resources/inbound-wire-drawdown-requests.d.ts +113 -119
  198. package/resources/inbound-wire-drawdown-requests.js +24 -25
  199. package/resources/inbound-wire-drawdown-requests.mjs +19 -19
  200. package/resources/index.d.ts +39 -205
  201. package/resources/index.js +114 -540
  202. package/resources/index.mjs +39 -42
  203. package/resources/oauth-connections.d.ts +43 -44
  204. package/resources/oauth-connections.js +21 -21
  205. package/resources/oauth-connections.mjs +16 -14
  206. package/resources/pending-transactions.d.ts +560 -601
  207. package/resources/pending-transactions.js +21 -21
  208. package/resources/pending-transactions.mjs +16 -14
  209. package/resources/programs.d.ts +41 -39
  210. package/resources/programs.js +21 -19
  211. package/resources/programs.mjs +16 -14
  212. package/resources/real-time-decisions.d.ts +384 -411
  213. package/resources/real-time-decisions.js +18 -19
  214. package/resources/real-time-decisions.mjs +15 -14
  215. package/resources/real-time-payments-transfers.d.ts +304 -342
  216. package/resources/real-time-payments-transfers.js +30 -30
  217. package/resources/real-time-payments-transfers.mjs +25 -23
  218. package/resources/routing-numbers.d.ts +52 -54
  219. package/resources/routing-numbers.js +18 -16
  220. package/resources/routing-numbers.mjs +14 -12
  221. package/resources/simulations/account-statements.d.ts +12 -15
  222. package/resources/simulations/account-statements.js +13 -14
  223. package/resources/simulations/account-statements.mjs +10 -9
  224. package/resources/simulations/account-transfers.d.ts +8 -11
  225. package/resources/simulations/account-transfers.js +13 -13
  226. package/resources/simulations/account-transfers.mjs +10 -10
  227. package/resources/simulations/ach-transfers.d.ts +3609 -3848
  228. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  229. package/resources/simulations/ach-transfers.js +40 -35
  230. package/resources/simulations/ach-transfers.js.map +1 -1
  231. package/resources/simulations/ach-transfers.mjs +37 -32
  232. package/resources/simulations/ach-transfers.mjs.map +1 -1
  233. package/resources/simulations/card-disputes.d.ts +22 -26
  234. package/resources/simulations/card-disputes.js +15 -14
  235. package/resources/simulations/card-disputes.mjs +12 -11
  236. package/resources/simulations/card-profiles.d.ts +9 -9
  237. package/resources/simulations/card-profiles.js +14 -14
  238. package/resources/simulations/card-profiles.mjs +11 -11
  239. package/resources/simulations/card-refunds.d.ts +13 -16
  240. package/resources/simulations/card-refunds.js +13 -12
  241. package/resources/simulations/card-refunds.mjs +10 -9
  242. package/resources/simulations/cards.d.ts +1306 -1448
  243. package/resources/simulations/cards.js +28 -27
  244. package/resources/simulations/cards.mjs +25 -24
  245. package/resources/simulations/check-deposits.d.ts +17 -17
  246. package/resources/simulations/check-deposits.js +26 -26
  247. package/resources/simulations/check-deposits.mjs +23 -23
  248. package/resources/simulations/check-transfers.d.ts +12 -18
  249. package/resources/simulations/check-transfers.js +19 -19
  250. package/resources/simulations/check-transfers.mjs +16 -16
  251. package/resources/simulations/digital-wallet-token-requests.d.ts +35 -43
  252. package/resources/simulations/digital-wallet-token-requests.js +13 -15
  253. package/resources/simulations/digital-wallet-token-requests.mjs +10 -9
  254. package/resources/simulations/documents.d.ts +11 -11
  255. package/resources/simulations/documents.js +12 -11
  256. package/resources/simulations/documents.mjs +9 -8
  257. package/resources/simulations/inbound-funds-holds.d.ts +63 -66
  258. package/resources/simulations/inbound-funds-holds.js +13 -14
  259. package/resources/simulations/inbound-funds-holds.mjs +10 -9
  260. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +94 -97
  261. package/resources/simulations/inbound-wire-drawdown-requests.js +13 -15
  262. package/resources/simulations/inbound-wire-drawdown-requests.mjs +10 -11
  263. package/resources/simulations/index.d.ts +19 -40
  264. package/resources/simulations/index.js +40 -148
  265. package/resources/simulations/index.mjs +19 -19
  266. package/resources/simulations/interest-payments.d.ts +2483 -2752
  267. package/resources/simulations/interest-payments.d.ts.map +1 -1
  268. package/resources/simulations/interest-payments.js +13 -14
  269. package/resources/simulations/interest-payments.js.map +1 -1
  270. package/resources/simulations/interest-payments.mjs +10 -9
  271. package/resources/simulations/interest-payments.mjs.map +1 -1
  272. package/resources/simulations/programs.d.ts +13 -13
  273. package/resources/simulations/programs.js +14 -13
  274. package/resources/simulations/programs.mjs +11 -10
  275. package/resources/simulations/real-time-payments-transfers.d.ts +3343 -3744
  276. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  277. package/resources/simulations/real-time-payments-transfers.js +24 -25
  278. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  279. package/resources/simulations/real-time-payments-transfers.mjs +21 -20
  280. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  281. package/resources/simulations/simulations.d.ts +75 -75
  282. package/resources/simulations/simulations.js +78 -101
  283. package/resources/simulations/simulations.mjs +56 -56
  284. package/resources/simulations/wire-transfers.d.ts +2541 -2810
  285. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  286. package/resources/simulations/wire-transfers.js +12 -11
  287. package/resources/simulations/wire-transfers.js.map +1 -1
  288. package/resources/simulations/wire-transfers.mjs +9 -8
  289. package/resources/simulations/wire-transfers.mjs.map +1 -1
  290. package/resources/transactions.d.ts +2539 -2838
  291. package/resources/transactions.d.ts.map +1 -1
  292. package/resources/transactions.js +21 -19
  293. package/resources/transactions.js.map +1 -1
  294. package/resources/transactions.mjs +16 -14
  295. package/resources/transactions.mjs.map +1 -1
  296. package/resources/wire-drawdown-requests.d.ts +140 -147
  297. package/resources/wire-drawdown-requests.js +27 -27
  298. package/resources/wire-drawdown-requests.mjs +22 -20
  299. package/resources/wire-transfers.d.ts +315 -324
  300. package/resources/wire-transfers.js +56 -54
  301. package/resources/wire-transfers.mjs +51 -49
  302. package/shims/node.d.ts +29 -0
  303. package/shims/node.d.ts.map +1 -0
  304. package/shims/node.js +31 -0
  305. package/shims/node.js.map +1 -0
  306. package/shims/node.mjs +5 -0
  307. package/shims/node.mjs.map +1 -0
  308. package/shims/web.d.ts +26 -0
  309. package/shims/web.d.ts.map +1 -0
  310. package/shims/web.js +31 -0
  311. package/shims/web.js.map +1 -0
  312. package/shims/web.mjs +5 -0
  313. package/shims/web.mjs.map +1 -0
  314. package/src/_shims/MultipartBody.ts +9 -0
  315. package/src/_shims/README.md +46 -0
  316. package/src/_shims/auto/runtime-bun.ts +4 -0
  317. package/src/_shims/auto/runtime-node.ts +4 -0
  318. package/src/_shims/auto/runtime.ts +4 -0
  319. package/src/_shims/auto/types-node.ts +4 -0
  320. package/src/_shims/auto/types.d.ts +99 -0
  321. package/src/_shims/auto/types.js +3 -0
  322. package/src/_shims/auto/types.mjs +3 -0
  323. package/src/_shims/bun-runtime.ts +14 -0
  324. package/src/_shims/index.d.ts +79 -0
  325. package/src/_shims/index.js +13 -0
  326. package/src/_shims/index.mjs +7 -0
  327. package/src/_shims/manual-types.d.ts +12 -0
  328. package/src/_shims/manual-types.js +3 -0
  329. package/src/_shims/manual-types.mjs +3 -0
  330. package/src/_shims/node-runtime.ts +79 -0
  331. package/src/_shims/node-types.d.ts +42 -0
  332. package/src/_shims/node-types.js +3 -0
  333. package/src/_shims/node-types.mjs +3 -0
  334. package/src/_shims/registry.ts +64 -0
  335. package/src/_shims/web-runtime.ts +91 -0
  336. package/src/_shims/web-types.d.ts +82 -0
  337. package/src/_shims/web-types.js +3 -0
  338. package/src/_shims/web-types.mjs +3 -0
  339. package/src/core.ts +33 -16
  340. package/src/error.ts +1 -1
  341. package/src/index.ts +6 -6
  342. package/src/pagination.ts +1 -1
  343. package/src/resource.ts +1 -1
  344. package/src/resources/account-numbers.ts +5 -5
  345. package/src/resources/account-statements.ts +5 -5
  346. package/src/resources/account-transfers.ts +5 -5
  347. package/src/resources/accounts.ts +5 -5
  348. package/src/resources/ach-prenotifications.ts +45 -16
  349. package/src/resources/ach-transfers.ts +47 -17
  350. package/src/resources/balance-lookups.ts +3 -3
  351. package/src/resources/bookkeeping-accounts.ts +5 -5
  352. package/src/resources/bookkeeping-entries.ts +5 -5
  353. package/src/resources/bookkeeping-entry-sets.ts +3 -3
  354. package/src/resources/card-disputes.ts +5 -5
  355. package/src/resources/card-profiles.ts +5 -5
  356. package/src/resources/card-purchase-supplements.ts +5 -5
  357. package/src/resources/cards.ts +15 -5
  358. package/src/resources/check-deposits.ts +5 -5
  359. package/src/resources/check-transfers.ts +5 -5
  360. package/src/resources/declined-transactions.ts +5 -5
  361. package/src/resources/digital-wallet-tokens.ts +5 -5
  362. package/src/resources/documents.ts +5 -5
  363. package/src/resources/entities/beneficial-owners.ts +5 -5
  364. package/src/resources/entities/entities.ts +18 -18
  365. package/src/resources/entities/index.ts +3 -3
  366. package/src/resources/entities/supplemental-documents.ts +5 -5
  367. package/src/resources/event-subscriptions.ts +5 -5
  368. package/src/resources/events.ts +5 -5
  369. package/src/resources/exports.ts +64 -7
  370. package/src/resources/external-accounts.ts +5 -5
  371. package/src/resources/files.ts +6 -6
  372. package/src/resources/groups.ts +3 -3
  373. package/src/resources/inbound-ach-transfers.ts +5 -5
  374. package/src/resources/inbound-wire-drawdown-requests.ts +5 -5
  375. package/src/resources/index.ts +38 -38
  376. package/src/resources/oauth-connections.ts +5 -5
  377. package/src/resources/pending-transactions.ts +5 -5
  378. package/src/resources/programs.ts +5 -5
  379. package/src/resources/real-time-decisions.ts +3 -3
  380. package/src/resources/real-time-payments-transfers.ts +5 -5
  381. package/src/resources/routing-numbers.ts +4 -4
  382. package/src/resources/simulations/account-statements.ts +4 -4
  383. package/src/resources/simulations/account-transfers.ts +3 -3
  384. package/src/resources/simulations/ach-transfers.ts +297 -29
  385. package/src/resources/simulations/card-disputes.ts +4 -4
  386. package/src/resources/simulations/card-profiles.ts +3 -3
  387. package/src/resources/simulations/card-refunds.ts +4 -4
  388. package/src/resources/simulations/cards.ts +4 -4
  389. package/src/resources/simulations/check-deposits.ts +3 -3
  390. package/src/resources/simulations/check-transfers.ts +3 -3
  391. package/src/resources/simulations/digital-wallet-token-requests.ts +3 -3
  392. package/src/resources/simulations/documents.ts +4 -4
  393. package/src/resources/simulations/inbound-funds-holds.ts +3 -3
  394. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +4 -4
  395. package/src/resources/simulations/index.ts +18 -18
  396. package/src/resources/simulations/interest-payments.ts +18 -14
  397. package/src/resources/simulations/programs.ts +4 -4
  398. package/src/resources/simulations/real-time-payments-transfers.ts +19 -15
  399. package/src/resources/simulations/simulations.ts +19 -19
  400. package/src/resources/simulations/wire-transfers.ts +18 -14
  401. package/src/resources/transactions.ts +20 -16
  402. package/src/resources/wire-drawdown-requests.ts +5 -5
  403. package/src/resources/wire-transfers.ts +5 -5
  404. package/src/shims/node.ts +50 -0
  405. package/src/shims/web.ts +50 -0
  406. package/src/uploads.ts +12 -16
  407. package/src/version.ts +1 -1
  408. package/uploads.d.ts +23 -39
  409. package/uploads.d.ts.map +1 -1
  410. package/uploads.js +115 -157
  411. package/uploads.js.map +1 -1
  412. package/uploads.mjs +111 -133
  413. package/uploads.mjs.map +1 -1
  414. package/version.d.ts +2 -2
  415. package/version.js +4 -4
  416. package/version.mjs +2 -2
  417. package/_shims/ReadableStream-node.d.ts +0 -6
  418. package/_shims/ReadableStream-node.d.ts.map +0 -1
  419. package/_shims/ReadableStream-node.js +0 -14
  420. package/_shims/ReadableStream-node.js.map +0 -1
  421. package/_shims/ReadableStream-node.mjs +0 -3
  422. package/_shims/ReadableStream-node.mjs.map +0 -1
  423. package/_shims/ReadableStream.d.ts +0 -38
  424. package/_shims/ReadableStream.mjs +0 -7
  425. package/_shims/agent-node.d.ts +0 -7
  426. package/_shims/agent-node.d.ts.map +0 -1
  427. package/_shims/agent-node.js +0 -28
  428. package/_shims/agent-node.js.map +0 -1
  429. package/_shims/agent-node.mjs +0 -16
  430. package/_shims/agent-node.mjs.map +0 -1
  431. package/_shims/agent.d.ts +0 -9
  432. package/_shims/agent.d.ts.map +0 -1
  433. package/_shims/agent.js +0 -14
  434. package/_shims/agent.js.map +0 -1
  435. package/_shims/agent.mjs +0 -10
  436. package/_shims/agent.mjs.map +0 -1
  437. package/_shims/fetch-node.d.ts +0 -64
  438. package/_shims/fetch-node.js +0 -12
  439. package/_shims/fetch-node.mjs +0 -14
  440. package/_shims/fetch.d.ts +0 -60
  441. package/_shims/fetch.js +0 -13
  442. package/_shims/fetch.mjs +0 -15
  443. package/_shims/fileFromPath-node.d.ts +0 -17
  444. package/_shims/fileFromPath-node.d.ts.map +0 -1
  445. package/_shims/fileFromPath-node.js +0 -17
  446. package/_shims/fileFromPath-node.js.map +0 -1
  447. package/_shims/fileFromPath-node.mjs +0 -13
  448. package/_shims/fileFromPath-node.mjs.map +0 -1
  449. package/_shims/fileFromPath.d.ts +0 -22
  450. package/_shims/fileFromPath.d.ts.map +0 -1
  451. package/_shims/fileFromPath.js +0 -16
  452. package/_shims/fileFromPath.js.map +0 -1
  453. package/_shims/fileFromPath.mjs +0 -12
  454. package/_shims/fileFromPath.mjs.map +0 -1
  455. package/_shims/form-data-node.d.ts +0 -45
  456. package/_shims/form-data-node.js +0 -11
  457. package/_shims/form-data-node.mjs +0 -9
  458. package/_shims/form-data.d.ts +0 -43
  459. package/_shims/form-data.js +0 -17
  460. package/_shims/form-data.mjs +0 -20
  461. package/_shims/getMultipartRequestOptions-node.d.ts +0 -10
  462. package/_shims/getMultipartRequestOptions-node.d.ts.map +0 -1
  463. package/_shims/getMultipartRequestOptions-node.js +0 -22
  464. package/_shims/getMultipartRequestOptions-node.js.map +0 -1
  465. package/_shims/getMultipartRequestOptions-node.mjs +0 -18
  466. package/_shims/getMultipartRequestOptions-node.mjs.map +0 -1
  467. package/_shims/getMultipartRequestOptions.d.ts +0 -10
  468. package/_shims/getMultipartRequestOptions.d.ts.map +0 -1
  469. package/_shims/getMultipartRequestOptions.js +0 -12
  470. package/_shims/getMultipartRequestOptions.js.map +0 -1
  471. package/_shims/getMultipartRequestOptions.mjs +0 -8
  472. package/_shims/getMultipartRequestOptions.mjs.map +0 -1
  473. package/_shims/node-readable-node.d.ts +0 -8
  474. package/_shims/node-readable-node.d.ts.map +0 -1
  475. package/_shims/node-readable-node.js +0 -9
  476. package/_shims/node-readable-node.js.map +0 -1
  477. package/_shims/node-readable-node.mjs +0 -5
  478. package/_shims/node-readable-node.mjs.map +0 -1
  479. package/_shims/node-readable.d.ts +0 -23
  480. package/_shims/node-readable.d.ts.map +0 -1
  481. package/_shims/node-readable.js +0 -11
  482. package/_shims/node-readable.js.map +0 -1
  483. package/_shims/node-readable.mjs +0 -7
  484. package/_shims/node-readable.mjs.map +0 -1
  485. package/src/_shims/ReadableStream.d.ts +0 -38
  486. package/src/_shims/ReadableStream.mjs +0 -7
  487. package/src/_shims/agent-node.ts +0 -22
  488. package/src/_shims/agent.ts +0 -12
  489. package/src/_shims/fetch-node.d.ts +0 -64
  490. package/src/_shims/fetch-node.js +0 -12
  491. package/src/_shims/fetch-node.mjs +0 -14
  492. package/src/_shims/fetch.d.ts +0 -60
  493. package/src/_shims/fetch.js +0 -13
  494. package/src/_shims/fetch.mjs +0 -15
  495. package/src/_shims/fileFromPath-node.ts +0 -29
  496. package/src/_shims/fileFromPath.ts +0 -29
  497. package/src/_shims/form-data-node.d.ts +0 -45
  498. package/src/_shims/form-data-node.js +0 -11
  499. package/src/_shims/form-data-node.mjs +0 -9
  500. package/src/_shims/form-data.d.ts +0 -43
  501. package/src/_shims/form-data.js +0 -17
  502. package/src/_shims/form-data.mjs +0 -20
  503. package/src/_shims/getMultipartRequestOptions-node.ts +0 -25
  504. package/src/_shims/getMultipartRequestOptions.ts +0 -14
  505. package/src/_shims/node-readable-node.ts +0 -10
  506. package/src/_shims/node-readable.ts +0 -30
@@ -1,611 +1,345 @@
1
1
  import * as Core from 'increase/core';
2
2
  import { APIResource } from 'increase/resource';
3
- import { BeneficialOwners } from './beneficial-owners.js';
4
- import { SupplementalDocuments } from './supplemental-documents.js';
5
- import * as API from './index.js';
3
+ import { BeneficialOwners } from "./beneficial-owners.js";
4
+ import { SupplementalDocuments } from "./supplemental-documents.js";
5
+ import * as API from "./index.js";
6
6
  import { Page, PageParams } from 'increase/pagination';
7
7
  export declare class Entities extends APIResource {
8
- beneficialOwners: BeneficialOwners;
9
- supplementalDocuments: SupplementalDocuments;
10
- /**
11
- * Create an Entity
12
- */
13
- create(body: EntityCreateParams, options?: Core.RequestOptions): Core.APIPromise<Entity>;
14
- /**
15
- * Retrieve an Entity
16
- */
17
- retrieve(entityId: string, options?: Core.RequestOptions): Core.APIPromise<Entity>;
18
- /**
19
- * List Entities
20
- */
21
- list(query?: EntityListParams, options?: Core.RequestOptions): Core.PagePromise<EntitiesPage, Entity>;
22
- list(options?: Core.RequestOptions): Core.PagePromise<EntitiesPage, Entity>;
23
- /**
24
- * Archive an Entity
25
- */
26
- archive(entityId: string, options?: Core.RequestOptions): Core.APIPromise<Entity>;
27
- /**
28
- * Update a Natural Person or Corporation's address
29
- */
30
- updateAddress(
31
- entityId: string,
32
- body: EntityUpdateAddressParams,
33
- options?: Core.RequestOptions,
34
- ): Core.APIPromise<Entity>;
35
- }
36
- export declare class EntitiesPage extends Page<Entity> {}
37
- type _EntitiesPage = EntitiesPage;
38
- /**
39
- * Entities are the legal entities that own accounts. They can be people,
40
- * corporations, partnerships, or trusts.
41
- */
42
- export interface Entity {
43
- /**
44
- * The entity's identifier.
45
- */
46
- id: string;
47
- /**
48
- * Details of the corporation entity. Will be present if `structure` is equal to
49
- * `corporation`.
50
- */
51
- corporation: Entity.Corporation | null;
52
- /**
53
- * The entity's description for display purposes.
54
- */
55
- description: string | null;
56
- /**
57
- * Details of the joint entity. Will be present if `structure` is equal to `joint`.
58
- */
59
- joint: Entity.Joint | null;
60
- /**
61
- * Details of the natural person entity. Will be present if `structure` is equal to
62
- * `natural_person`.
63
- */
64
- natural_person: Entity.NaturalPerson | null;
65
- /**
66
- * The relationship between your group and the entity.
67
- *
68
- * - `affiliated` - The entity is controlled by your group.
69
- * - `informational` - The entity is for informational purposes only.
70
- * - `unaffiliated` - The entity is not controlled by your group, but can still
71
- * directly open accounts.
72
- */
73
- relationship: 'affiliated' | 'informational' | 'unaffiliated';
74
- /**
75
- * The entity's legal structure.
76
- *
77
- * - `corporation` - A corporation.
78
- * - `natural_person` - An individual person.
79
- * - `joint` - Multiple individual people.
80
- * - `trust` - A trust.
81
- */
82
- structure: 'corporation' | 'natural_person' | 'joint' | 'trust';
83
- /**
84
- * Additional documentation associated with the entity. This is limited to the
85
- * first 10 documents for an entity. If an entity has more than 10 documents, use
86
- * the GET /entity_supplemental_documents list endpoint to retrieve them.
87
- */
88
- supplemental_documents: Array<Entity.SupplementalDocument>;
89
- /**
90
- * Details of the trust entity. Will be present if `structure` is equal to `trust`.
91
- */
92
- trust: Entity.Trust | null;
93
- /**
94
- * A constant representing the object's type. For this resource it will always be
95
- * `entity`.
96
- */
97
- type: 'entity';
98
- }
99
- export declare namespace Entity {
100
- /**
101
- * Details of the corporation entity. Will be present if `structure` is equal to
102
- * `corporation`.
103
- */
104
- interface Corporation {
105
- /**
106
- * The corporation's address.
107
- */
108
- address: Corporation.Address;
109
- /**
110
- * The identifying details of anyone controlling or owning 25% or more of the
111
- * corporation.
112
- */
113
- beneficial_owners: Array<Corporation.BeneficialOwner>;
114
- /**
115
- * The two-letter United States Postal Service (USPS) abbreviation for the
116
- * corporation's state of incorporation.
117
- */
118
- incorporation_state: string | null;
119
- /**
120
- * The legal name of the corporation.
121
- */
122
- name: string;
123
- /**
124
- * The Employer Identification Number (EIN) for the corporation.
125
- */
126
- tax_identifier: string | null;
127
- /**
128
- * The website of the corporation.
129
- */
130
- website: string | null;
131
- }
132
- namespace Corporation {
133
- /**
134
- * The corporation's address.
135
- */
136
- interface Address {
137
- /**
138
- * The city of the address.
139
- */
140
- city: string;
141
- /**
142
- * The first line of the address.
143
- */
144
- line1: string;
145
- /**
146
- * The second line of the address.
147
- */
148
- line2: string | null;
149
- /**
150
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
151
- * the address.
152
- */
153
- state: string;
154
- /**
155
- * The ZIP code of the address.
156
- */
157
- zip: string;
158
- }
159
- interface BeneficialOwner {
160
- /**
161
- * The identifier of this beneficial owner.
162
- */
163
- beneficial_owner_id: string;
164
- /**
165
- * This person's role or title within the entity.
166
- */
167
- company_title: string | null;
168
- /**
169
- * Personal details for the beneficial owner.
170
- */
171
- individual: BeneficialOwner.Individual;
172
- /**
173
- * Why this person is considered a beneficial owner of the entity.
174
- *
175
- * - `ownership` - A person with 25% or greater direct or indirect ownership of the
176
- * entity.
177
- * - `control` - A person who manages, directs, or has significant control of the
178
- * entity.
179
- */
180
- prong: 'ownership' | 'control';
181
- }
182
- namespace BeneficialOwner {
183
- /**
184
- * Personal details for the beneficial owner.
185
- */
186
- interface Individual {
187
- /**
188
- * The person's address.
189
- */
190
- address: Individual.Address;
191
- /**
192
- * The person's date of birth in YYYY-MM-DD format.
193
- */
194
- date_of_birth: string;
195
- /**
196
- * A means of verifying the person's identity.
197
- */
198
- identification: Individual.Identification;
199
- /**
200
- * The person's legal name.
201
- */
202
- name: string;
203
- }
204
- namespace Individual {
205
- /**
206
- * The person's address.
207
- */
208
- interface Address {
209
- /**
210
- * The city of the address.
211
- */
212
- city: string;
213
- /**
214
- * The first line of the address.
215
- */
216
- line1: string;
217
- /**
218
- * The second line of the address.
219
- */
220
- line2: string | null;
221
- /**
222
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
223
- * the address.
224
- */
225
- state: string;
226
- /**
227
- * The ZIP code of the address.
228
- */
229
- zip: string;
230
- }
231
- /**
232
- * A means of verifying the person's identity.
233
- */
234
- interface Identification {
235
- /**
236
- * A method that can be used to verify the individual's identity.
237
- *
238
- * - `social_security_number` - A social security number.
239
- * - `individual_taxpayer_identification_number` - An individual taxpayer
240
- * identification number (ITIN).
241
- * - `passport` - A passport number.
242
- * - `drivers_license` - A driver's license number.
243
- * - `other` - Another identifying document.
244
- */
245
- method:
246
- | 'social_security_number'
247
- | 'individual_taxpayer_identification_number'
248
- | 'passport'
249
- | 'drivers_license'
250
- | 'other';
251
- /**
252
- * The last 4 digits of the identification number that can be used to verify the
253
- * individual's identity.
254
- */
255
- number_last4: string;
256
- }
257
- }
258
- }
259
- }
260
- /**
261
- * Details of the joint entity. Will be present if `structure` is equal to `joint`.
262
- */
263
- interface Joint {
264
- /**
265
- * The two individuals that share control of the entity.
266
- */
267
- individuals: Array<Joint.Individual>;
268
- /**
269
- * The entity's name.
270
- */
271
- name: string;
272
- }
273
- namespace Joint {
274
- interface Individual {
275
- /**
276
- * The person's address.
277
- */
278
- address: Individual.Address;
279
- /**
280
- * The person's date of birth in YYYY-MM-DD format.
281
- */
282
- date_of_birth: string;
283
- /**
284
- * A means of verifying the person's identity.
285
- */
286
- identification: Individual.Identification;
287
- /**
288
- * The person's legal name.
289
- */
290
- name: string;
291
- }
292
- namespace Individual {
293
- /**
294
- * The person's address.
295
- */
296
- interface Address {
297
- /**
298
- * The city of the address.
299
- */
300
- city: string;
301
- /**
302
- * The first line of the address.
303
- */
304
- line1: string;
305
- /**
306
- * The second line of the address.
307
- */
308
- line2: string | null;
309
- /**
310
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
311
- * the address.
312
- */
313
- state: string;
314
- /**
315
- * The ZIP code of the address.
316
- */
317
- zip: string;
318
- }
319
- /**
320
- * A means of verifying the person's identity.
321
- */
322
- interface Identification {
323
- /**
324
- * A method that can be used to verify the individual's identity.
325
- *
326
- * - `social_security_number` - A social security number.
327
- * - `individual_taxpayer_identification_number` - An individual taxpayer
328
- * identification number (ITIN).
329
- * - `passport` - A passport number.
330
- * - `drivers_license` - A driver's license number.
331
- * - `other` - Another identifying document.
332
- */
333
- method:
334
- | 'social_security_number'
335
- | 'individual_taxpayer_identification_number'
336
- | 'passport'
337
- | 'drivers_license'
338
- | 'other';
339
- /**
340
- * The last 4 digits of the identification number that can be used to verify the
341
- * individual's identity.
342
- */
343
- number_last4: string;
344
- }
345
- }
346
- }
347
- /**
348
- * Details of the natural person entity. Will be present if `structure` is equal to
349
- * `natural_person`.
350
- */
351
- interface NaturalPerson {
8
+ beneficialOwners: BeneficialOwners;
9
+ supplementalDocuments: SupplementalDocuments;
352
10
  /**
353
- * The person's address.
11
+ * Create an Entity
354
12
  */
355
- address: NaturalPerson.Address;
13
+ create(body: EntityCreateParams, options?: Core.RequestOptions): Core.APIPromise<Entity>;
356
14
  /**
357
- * The person's date of birth in YYYY-MM-DD format.
15
+ * Retrieve an Entity
358
16
  */
359
- date_of_birth: string;
17
+ retrieve(entityId: string, options?: Core.RequestOptions): Core.APIPromise<Entity>;
360
18
  /**
361
- * A means of verifying the person's identity.
19
+ * List Entities
362
20
  */
363
- identification: NaturalPerson.Identification;
21
+ list(query?: EntityListParams, options?: Core.RequestOptions): Core.PagePromise<EntitiesPage, Entity>;
22
+ list(options?: Core.RequestOptions): Core.PagePromise<EntitiesPage, Entity>;
364
23
  /**
365
- * The person's legal name.
24
+ * Archive an Entity
366
25
  */
367
- name: string;
368
- }
369
- namespace NaturalPerson {
26
+ archive(entityId: string, options?: Core.RequestOptions): Core.APIPromise<Entity>;
370
27
  /**
371
- * The person's address.
28
+ * Update a Natural Person or Corporation's address
372
29
  */
373
- interface Address {
374
- /**
375
- * The city of the address.
376
- */
377
- city: string;
378
- /**
379
- * The first line of the address.
380
- */
381
- line1: string;
382
- /**
383
- * The second line of the address.
384
- */
385
- line2: string | null;
386
- /**
387
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
388
- * the address.
389
- */
390
- state: string;
391
- /**
392
- * The ZIP code of the address.
393
- */
394
- zip: string;
395
- }
30
+ updateAddress(entityId: string, body: EntityUpdateAddressParams, options?: Core.RequestOptions): Core.APIPromise<Entity>;
31
+ }
32
+ export declare class EntitiesPage extends Page<Entity> {
33
+ }
34
+ type _EntitiesPage = EntitiesPage;
35
+ /**
36
+ * Entities are the legal entities that own accounts. They can be people,
37
+ * corporations, partnerships, or trusts.
38
+ */
39
+ export interface Entity {
396
40
  /**
397
- * A means of verifying the person's identity.
41
+ * The entity's identifier.
398
42
  */
399
- interface Identification {
400
- /**
401
- * A method that can be used to verify the individual's identity.
402
- *
403
- * - `social_security_number` - A social security number.
404
- * - `individual_taxpayer_identification_number` - An individual taxpayer
405
- * identification number (ITIN).
406
- * - `passport` - A passport number.
407
- * - `drivers_license` - A driver's license number.
408
- * - `other` - Another identifying document.
409
- */
410
- method:
411
- | 'social_security_number'
412
- | 'individual_taxpayer_identification_number'
413
- | 'passport'
414
- | 'drivers_license'
415
- | 'other';
416
- /**
417
- * The last 4 digits of the identification number that can be used to verify the
418
- * individual's identity.
419
- */
420
- number_last4: string;
421
- }
422
- }
423
- /**
424
- * Supplemental Documents are uploaded files connected to an Entity during
425
- * onboarding.
426
- */
427
- interface SupplementalDocument {
43
+ id: string;
428
44
  /**
429
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
430
- * Supplemental Document was created.
45
+ * Details of the corporation entity. Will be present if `structure` is equal to
46
+ * `corporation`.
431
47
  */
432
- created_at: string;
48
+ corporation: Entity.Corporation | null;
433
49
  /**
434
- * The File containing the document.
50
+ * The entity's description for display purposes.
435
51
  */
436
- file_id: string;
52
+ description: string | null;
437
53
  /**
438
- * A constant representing the object's type. For this resource it will always be
439
- * `entity_supplemental_document`.
54
+ * Details of the joint entity. Will be present if `structure` is equal to `joint`.
440
55
  */
441
- type: 'entity_supplemental_document';
442
- }
443
- /**
444
- * Details of the trust entity. Will be present if `structure` is equal to `trust`.
445
- */
446
- interface Trust {
56
+ joint: Entity.Joint | null;
447
57
  /**
448
- * The trust's address.
58
+ * Details of the natural person entity. Will be present if `structure` is equal to
59
+ * `natural_person`.
449
60
  */
450
- address: Trust.Address;
61
+ natural_person: Entity.NaturalPerson | null;
451
62
  /**
452
- * Whether the trust is `revocable` or `irrevocable`.
63
+ * The relationship between your group and the entity.
453
64
  *
454
- * - `revocable` - The trust is revocable by the grantor.
455
- * - `irrevocable` - The trust cannot be revoked.
456
- */
457
- category: 'revocable' | 'irrevocable';
458
- /**
459
- * The ID for the File containing the formation document of the trust.
460
- */
461
- formation_document_file_id: string | null;
462
- /**
463
- * The two-letter United States Postal Service (USPS) abbreviation for the state in
464
- * which the trust was formed.
465
- */
466
- formation_state: string | null;
467
- /**
468
- * The grantor of the trust. Will be present if the `category` is `revocable`.
65
+ * - `affiliated` - The entity is controlled by your group.
66
+ * - `informational` - The entity is for informational purposes only.
67
+ * - `unaffiliated` - The entity is not controlled by your group, but can still
68
+ * directly open accounts.
469
69
  */
470
- grantor: Trust.Grantor | null;
70
+ relationship: 'affiliated' | 'informational' | 'unaffiliated' | null;
471
71
  /**
472
- * The trust's name.
72
+ * The entity's legal structure.
73
+ *
74
+ * - `corporation` - A corporation.
75
+ * - `natural_person` - An individual person.
76
+ * - `joint` - Multiple individual people.
77
+ * - `trust` - A trust.
473
78
  */
474
- name: string;
79
+ structure: 'corporation' | 'natural_person' | 'joint' | 'trust';
475
80
  /**
476
- * The Employer Identification Number (EIN) of the trust itself.
81
+ * Additional documentation associated with the entity. This is limited to the
82
+ * first 10 documents for an entity. If an entity has more than 10 documents, use
83
+ * the GET /entity_supplemental_documents list endpoint to retrieve them.
477
84
  */
478
- tax_identifier: string | null;
85
+ supplemental_documents: Array<Entity.SupplementalDocument>;
479
86
  /**
480
- * The trustees of the trust.
87
+ * Details of the trust entity. Will be present if `structure` is equal to `trust`.
481
88
  */
482
- trustees: Array<Trust.Trustee>;
483
- }
484
- namespace Trust {
89
+ trust: Entity.Trust | null;
485
90
  /**
486
- * The trust's address.
91
+ * A constant representing the object's type. For this resource it will always be
92
+ * `entity`.
487
93
  */
488
- interface Address {
489
- /**
490
- * The city of the address.
491
- */
492
- city: string;
493
- /**
494
- * The first line of the address.
495
- */
496
- line1: string;
497
- /**
498
- * The second line of the address.
499
- */
500
- line2: string | null;
501
- /**
502
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
503
- * the address.
504
- */
505
- state: string;
506
- /**
507
- * The ZIP code of the address.
508
- */
509
- zip: string;
510
- }
94
+ type: 'entity';
95
+ }
96
+ export declare namespace Entity {
511
97
  /**
512
- * The grantor of the trust. Will be present if the `category` is `revocable`.
98
+ * Details of the corporation entity. Will be present if `structure` is equal to
99
+ * `corporation`.
513
100
  */
514
- interface Grantor {
515
- /**
516
- * The person's address.
517
- */
518
- address: Grantor.Address;
519
- /**
520
- * The person's date of birth in YYYY-MM-DD format.
521
- */
522
- date_of_birth: string;
523
- /**
524
- * A means of verifying the person's identity.
525
- */
526
- identification: Grantor.Identification;
527
- /**
528
- * The person's legal name.
529
- */
530
- name: string;
531
- }
532
- namespace Grantor {
533
- /**
534
- * The person's address.
535
- */
536
- interface Address {
101
+ interface Corporation {
537
102
  /**
538
- * The city of the address.
103
+ * The corporation's address.
539
104
  */
540
- city: string;
105
+ address: Corporation.Address;
541
106
  /**
542
- * The first line of the address.
107
+ * The identifying details of anyone controlling or owning 25% or more of the
108
+ * corporation.
543
109
  */
544
- line1: string;
110
+ beneficial_owners: Array<Corporation.BeneficialOwner>;
545
111
  /**
546
- * The second line of the address.
112
+ * The two-letter United States Postal Service (USPS) abbreviation for the
113
+ * corporation's state of incorporation.
547
114
  */
548
- line2: string | null;
115
+ incorporation_state: string | null;
549
116
  /**
550
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
551
- * the address.
117
+ * The legal name of the corporation.
552
118
  */
553
- state: string;
119
+ name: string;
554
120
  /**
555
- * The ZIP code of the address.
121
+ * The Employer Identification Number (EIN) for the corporation.
556
122
  */
557
- zip: string;
558
- }
559
- /**
560
- * A means of verifying the person's identity.
561
- */
562
- interface Identification {
123
+ tax_identifier: string | null;
563
124
  /**
564
- * A method that can be used to verify the individual's identity.
565
- *
566
- * - `social_security_number` - A social security number.
567
- * - `individual_taxpayer_identification_number` - An individual taxpayer
568
- * identification number (ITIN).
569
- * - `passport` - A passport number.
570
- * - `drivers_license` - A driver's license number.
571
- * - `other` - Another identifying document.
572
- */
573
- method:
574
- | 'social_security_number'
575
- | 'individual_taxpayer_identification_number'
576
- | 'passport'
577
- | 'drivers_license'
578
- | 'other';
579
- /**
580
- * The last 4 digits of the identification number that can be used to verify the
581
- * individual's identity.
582
- */
583
- number_last4: string;
584
- }
125
+ * The website of the corporation.
126
+ */
127
+ website: string | null;
128
+ }
129
+ namespace Corporation {
130
+ /**
131
+ * The corporation's address.
132
+ */
133
+ interface Address {
134
+ /**
135
+ * The city of the address.
136
+ */
137
+ city: string;
138
+ /**
139
+ * The first line of the address.
140
+ */
141
+ line1: string;
142
+ /**
143
+ * The second line of the address.
144
+ */
145
+ line2: string | null;
146
+ /**
147
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
148
+ * the address.
149
+ */
150
+ state: string;
151
+ /**
152
+ * The ZIP code of the address.
153
+ */
154
+ zip: string;
155
+ }
156
+ interface BeneficialOwner {
157
+ /**
158
+ * The identifier of this beneficial owner.
159
+ */
160
+ beneficial_owner_id: string;
161
+ /**
162
+ * This person's role or title within the entity.
163
+ */
164
+ company_title: string | null;
165
+ /**
166
+ * Personal details for the beneficial owner.
167
+ */
168
+ individual: BeneficialOwner.Individual;
169
+ /**
170
+ * Why this person is considered a beneficial owner of the entity.
171
+ *
172
+ * - `ownership` - A person with 25% or greater direct or indirect ownership of the
173
+ * entity.
174
+ * - `control` - A person who manages, directs, or has significant control of the
175
+ * entity.
176
+ */
177
+ prong: 'ownership' | 'control';
178
+ }
179
+ namespace BeneficialOwner {
180
+ /**
181
+ * Personal details for the beneficial owner.
182
+ */
183
+ interface Individual {
184
+ /**
185
+ * The person's address.
186
+ */
187
+ address: Individual.Address;
188
+ /**
189
+ * The person's date of birth in YYYY-MM-DD format.
190
+ */
191
+ date_of_birth: string;
192
+ /**
193
+ * A means of verifying the person's identity.
194
+ */
195
+ identification: Individual.Identification;
196
+ /**
197
+ * The person's legal name.
198
+ */
199
+ name: string;
200
+ }
201
+ namespace Individual {
202
+ /**
203
+ * The person's address.
204
+ */
205
+ interface Address {
206
+ /**
207
+ * The city of the address.
208
+ */
209
+ city: string;
210
+ /**
211
+ * The first line of the address.
212
+ */
213
+ line1: string;
214
+ /**
215
+ * The second line of the address.
216
+ */
217
+ line2: string | null;
218
+ /**
219
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
220
+ * the address.
221
+ */
222
+ state: string;
223
+ /**
224
+ * The ZIP code of the address.
225
+ */
226
+ zip: string;
227
+ }
228
+ /**
229
+ * A means of verifying the person's identity.
230
+ */
231
+ interface Identification {
232
+ /**
233
+ * A method that can be used to verify the individual's identity.
234
+ *
235
+ * - `social_security_number` - A social security number.
236
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
237
+ * identification number (ITIN).
238
+ * - `passport` - A passport number.
239
+ * - `drivers_license` - A driver's license number.
240
+ * - `other` - Another identifying document.
241
+ */
242
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
243
+ /**
244
+ * The last 4 digits of the identification number that can be used to verify the
245
+ * individual's identity.
246
+ */
247
+ number_last4: string;
248
+ }
249
+ }
250
+ }
585
251
  }
586
- interface Trustee {
587
- /**
588
- * The individual trustee of the trust. Will be present if the trustee's
589
- * `structure` is equal to `individual`.
590
- */
591
- individual: Trustee.Individual | null;
592
- /**
593
- * The structure of the trustee. Will always be equal to `individual`.
594
- *
595
- * - `individual` - The trustee is an individual.
596
- */
597
- structure: 'individual';
252
+ /**
253
+ * Details of the joint entity. Will be present if `structure` is equal to `joint`.
254
+ */
255
+ interface Joint {
256
+ /**
257
+ * The two individuals that share control of the entity.
258
+ */
259
+ individuals: Array<Joint.Individual>;
260
+ /**
261
+ * The entity's name.
262
+ */
263
+ name: string;
264
+ }
265
+ namespace Joint {
266
+ interface Individual {
267
+ /**
268
+ * The person's address.
269
+ */
270
+ address: Individual.Address;
271
+ /**
272
+ * The person's date of birth in YYYY-MM-DD format.
273
+ */
274
+ date_of_birth: string;
275
+ /**
276
+ * A means of verifying the person's identity.
277
+ */
278
+ identification: Individual.Identification;
279
+ /**
280
+ * The person's legal name.
281
+ */
282
+ name: string;
283
+ }
284
+ namespace Individual {
285
+ /**
286
+ * The person's address.
287
+ */
288
+ interface Address {
289
+ /**
290
+ * The city of the address.
291
+ */
292
+ city: string;
293
+ /**
294
+ * The first line of the address.
295
+ */
296
+ line1: string;
297
+ /**
298
+ * The second line of the address.
299
+ */
300
+ line2: string | null;
301
+ /**
302
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
303
+ * the address.
304
+ */
305
+ state: string;
306
+ /**
307
+ * The ZIP code of the address.
308
+ */
309
+ zip: string;
310
+ }
311
+ /**
312
+ * A means of verifying the person's identity.
313
+ */
314
+ interface Identification {
315
+ /**
316
+ * A method that can be used to verify the individual's identity.
317
+ *
318
+ * - `social_security_number` - A social security number.
319
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
320
+ * identification number (ITIN).
321
+ * - `passport` - A passport number.
322
+ * - `drivers_license` - A driver's license number.
323
+ * - `other` - Another identifying document.
324
+ */
325
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
326
+ /**
327
+ * The last 4 digits of the identification number that can be used to verify the
328
+ * individual's identity.
329
+ */
330
+ number_last4: string;
331
+ }
332
+ }
598
333
  }
599
- namespace Trustee {
600
- /**
601
- * The individual trustee of the trust. Will be present if the trustee's
602
- * `structure` is equal to `individual`.
603
- */
604
- interface Individual {
334
+ /**
335
+ * Details of the natural person entity. Will be present if `structure` is equal to
336
+ * `natural_person`.
337
+ */
338
+ interface NaturalPerson {
605
339
  /**
606
340
  * The person's address.
607
341
  */
608
- address: Individual.Address;
342
+ address: NaturalPerson.Address;
609
343
  /**
610
344
  * The person's date of birth in YYYY-MM-DD format.
611
345
  */
@@ -613,815 +347,783 @@ export declare namespace Entity {
613
347
  /**
614
348
  * A means of verifying the person's identity.
615
349
  */
616
- identification: Individual.Identification;
350
+ identification: NaturalPerson.Identification;
617
351
  /**
618
352
  * The person's legal name.
619
353
  */
620
354
  name: string;
621
- }
622
- namespace Individual {
355
+ }
356
+ namespace NaturalPerson {
623
357
  /**
624
358
  * The person's address.
625
359
  */
626
360
  interface Address {
627
- /**
628
- * The city of the address.
629
- */
630
- city: string;
631
- /**
632
- * The first line of the address.
633
- */
634
- line1: string;
635
- /**
636
- * The second line of the address.
637
- */
638
- line2: string | null;
639
- /**
640
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
641
- * the address.
642
- */
643
- state: string;
644
- /**
645
- * The ZIP code of the address.
646
- */
647
- zip: string;
361
+ /**
362
+ * The city of the address.
363
+ */
364
+ city: string;
365
+ /**
366
+ * The first line of the address.
367
+ */
368
+ line1: string;
369
+ /**
370
+ * The second line of the address.
371
+ */
372
+ line2: string | null;
373
+ /**
374
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
375
+ * the address.
376
+ */
377
+ state: string;
378
+ /**
379
+ * The ZIP code of the address.
380
+ */
381
+ zip: string;
648
382
  }
649
383
  /**
650
384
  * A means of verifying the person's identity.
651
385
  */
652
386
  interface Identification {
653
- /**
654
- * A method that can be used to verify the individual's identity.
655
- *
656
- * - `social_security_number` - A social security number.
657
- * - `individual_taxpayer_identification_number` - An individual taxpayer
658
- * identification number (ITIN).
659
- * - `passport` - A passport number.
660
- * - `drivers_license` - A driver's license number.
661
- * - `other` - Another identifying document.
662
- */
663
- method:
664
- | 'social_security_number'
665
- | 'individual_taxpayer_identification_number'
666
- | 'passport'
667
- | 'drivers_license'
668
- | 'other';
669
- /**
670
- * The last 4 digits of the identification number that can be used to verify the
671
- * individual's identity.
672
- */
673
- number_last4: string;
387
+ /**
388
+ * A method that can be used to verify the individual's identity.
389
+ *
390
+ * - `social_security_number` - A social security number.
391
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
392
+ * identification number (ITIN).
393
+ * - `passport` - A passport number.
394
+ * - `drivers_license` - A driver's license number.
395
+ * - `other` - Another identifying document.
396
+ */
397
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
398
+ /**
399
+ * The last 4 digits of the identification number that can be used to verify the
400
+ * individual's identity.
401
+ */
402
+ number_last4: string;
674
403
  }
675
- }
676
404
  }
677
- }
678
- }
679
- export interface EntityCreateParams {
680
- /**
681
- * The relationship between your group and the entity.
682
- *
683
- * - `affiliated` - The entity is controlled by your group.
684
- * - `informational` - The entity is for informational purposes only.
685
- * - `unaffiliated` - The entity is not controlled by your group, but can still
686
- * directly open accounts.
687
- */
688
- relationship: 'affiliated' | 'informational' | 'unaffiliated';
689
- /**
690
- * The type of Entity to create.
691
- *
692
- * - `corporation` - A corporation.
693
- * - `natural_person` - An individual person.
694
- * - `joint` - Multiple individual people.
695
- * - `trust` - A trust.
696
- */
697
- structure: 'corporation' | 'natural_person' | 'joint' | 'trust';
698
- /**
699
- * Details of the corporation entity to create. Required if `structure` is equal to
700
- * `corporation`.
701
- */
702
- corporation?: EntityCreateParams.Corporation;
703
- /**
704
- * The description you choose to give the entity.
705
- */
706
- description?: string;
707
- /**
708
- * Details of the joint entity to create. Required if `structure` is equal to
709
- * `joint`.
710
- */
711
- joint?: EntityCreateParams.Joint;
712
- /**
713
- * Details of the natural person entity to create. Required if `structure` is equal
714
- * to `natural_person`. Natural people entities should be submitted with
715
- * `social_security_number` or `individual_taxpayer_identification_number`
716
- * identification methods.
717
- */
718
- natural_person?: EntityCreateParams.NaturalPerson;
719
- /**
720
- * Additional documentation associated with the entity.
721
- */
722
- supplemental_documents?: Array<EntityCreateParams.SupplementalDocument>;
723
- /**
724
- * Details of the trust entity to create. Required if `structure` is equal to
725
- * `trust`.
726
- */
727
- trust?: EntityCreateParams.Trust;
728
- }
729
- export declare namespace EntityCreateParams {
730
- /**
731
- * Details of the corporation entity to create. Required if `structure` is equal to
732
- * `corporation`.
733
- */
734
- interface Corporation {
735
- /**
736
- * The corporation's physical address. Post Office Boxes are disallowed.
737
- */
738
- address: Corporation.Address;
739
- /**
740
- * The identifying details of anyone controlling or owning 25% or more of the
741
- * corporation.
742
- */
743
- beneficial_owners: Array<Corporation.BeneficialOwner>;
744
- /**
745
- * The legal name of the corporation.
746
- */
747
- name: string;
748
- /**
749
- * The Employer Identification Number (EIN) for the corporation.
750
- */
751
- tax_identifier: string;
752
- /**
753
- * The two-letter United States Postal Service (USPS) abbreviation for the
754
- * corporation's state of incorporation.
755
- */
756
- incorporation_state?: string;
757
405
  /**
758
- * The website of the corporation.
406
+ * Supplemental Documents are uploaded files connected to an Entity during
407
+ * onboarding.
759
408
  */
760
- website?: string;
761
- }
762
- namespace Corporation {
409
+ interface SupplementalDocument {
410
+ /**
411
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
412
+ * Supplemental Document was created.
413
+ */
414
+ created_at: string;
415
+ /**
416
+ * The File containing the document.
417
+ */
418
+ file_id: string;
419
+ /**
420
+ * A constant representing the object's type. For this resource it will always be
421
+ * `entity_supplemental_document`.
422
+ */
423
+ type: 'entity_supplemental_document';
424
+ }
763
425
  /**
764
- * The corporation's physical address. Post Office Boxes are disallowed.
426
+ * Details of the trust entity. Will be present if `structure` is equal to `trust`.
765
427
  */
766
- interface Address {
767
- /**
768
- * The city of the address.
769
- */
770
- city: string;
771
- /**
772
- * The first line of the address. This is usually the street number and street.
773
- */
774
- line1: string;
775
- /**
776
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
777
- * the address.
778
- */
779
- state: string;
780
- /**
781
- * The ZIP code of the address.
782
- */
783
- zip: string;
784
- /**
785
- * The second line of the address. This might be the floor or room number.
786
- */
787
- line2?: string;
788
- }
789
- interface BeneficialOwner {
790
- /**
791
- * Personal details for the beneficial owner.
792
- */
793
- individual: BeneficialOwner.Individual;
794
- /**
795
- * Why this person is considered a beneficial owner of the entity. At least one
796
- * option is required.
797
- */
798
- prongs: Array<'ownership' | 'control'>;
799
- /**
800
- * This person's role or title within the entity.
801
- */
802
- company_title?: string;
803
- }
804
- namespace BeneficialOwner {
805
- /**
806
- * Personal details for the beneficial owner.
807
- */
808
- interface Individual {
428
+ interface Trust {
809
429
  /**
810
- * The individual's physical address. Post Office Boxes are disallowed.
430
+ * The trust's address.
811
431
  */
812
- address: Individual.Address;
432
+ address: Trust.Address;
813
433
  /**
814
- * The person's date of birth in YYYY-MM-DD format.
434
+ * Whether the trust is `revocable` or `irrevocable`.
435
+ *
436
+ * - `revocable` - The trust is revocable by the grantor.
437
+ * - `irrevocable` - The trust cannot be revoked.
815
438
  */
816
- date_of_birth: string;
439
+ category: 'revocable' | 'irrevocable';
817
440
  /**
818
- * A means of verifying the person's identity.
441
+ * The ID for the File containing the formation document of the trust.
819
442
  */
820
- identification: Individual.Identification;
443
+ formation_document_file_id: string | null;
821
444
  /**
822
- * The person's legal name.
445
+ * The two-letter United States Postal Service (USPS) abbreviation for the state in
446
+ * which the trust was formed.
447
+ */
448
+ formation_state: string | null;
449
+ /**
450
+ * The grantor of the trust. Will be present if the `category` is `revocable`.
451
+ */
452
+ grantor: Trust.Grantor | null;
453
+ /**
454
+ * The trust's name.
823
455
  */
824
456
  name: string;
825
457
  /**
826
- * The identification method for an individual can only be a passport, driver's
827
- * license, or other document if you've confirmed the individual does not have a US
828
- * tax id (either a Social Security Number or Individual Taxpayer Identification
829
- * Number).
458
+ * The Employer Identification Number (EIN) of the trust itself.
830
459
  */
831
- confirmed_no_us_tax_id?: boolean;
832
- }
833
- namespace Individual {
460
+ tax_identifier: string | null;
834
461
  /**
835
- * The individual's physical address. Post Office Boxes are disallowed.
462
+ * The trustees of the trust.
836
463
  */
837
- interface Address {
838
- /**
839
- * The city of the address.
840
- */
841
- city: string;
842
- /**
843
- * The first line of the address. This is usually the street number and street.
844
- */
845
- line1: string;
846
- /**
847
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
848
- * the address.
849
- */
850
- state: string;
851
- /**
852
- * The ZIP code of the address.
853
- */
854
- zip: string;
855
- /**
856
- * The second line of the address. This might be the floor or room number.
857
- */
858
- line2?: string;
859
- }
464
+ trustees: Array<Trust.Trustee>;
465
+ }
466
+ namespace Trust {
860
467
  /**
861
- * A means of verifying the person's identity.
468
+ * The trust's address.
862
469
  */
863
- interface Identification {
864
- /**
865
- * A method that can be used to verify the individual's identity.
866
- *
867
- * - `social_security_number` - A social security number.
868
- * - `individual_taxpayer_identification_number` - An individual taxpayer
869
- * identification number (ITIN).
870
- * - `passport` - A passport number.
871
- * - `drivers_license` - A driver's license number.
872
- * - `other` - Another identifying document.
873
- */
874
- method:
875
- | 'social_security_number'
876
- | 'individual_taxpayer_identification_number'
877
- | 'passport'
878
- | 'drivers_license'
879
- | 'other';
880
- /**
881
- * An identification number that can be used to verify the individual's identity,
882
- * such as a social security number.
883
- */
884
- number: string;
885
- /**
886
- * Information about the United States driver's license used for identification.
887
- * Required if `method` is equal to `drivers_license`.
888
- */
889
- drivers_license?: Identification.DriversLicense;
890
- /**
891
- * Information about the identification document provided. Required if `method` is
892
- * equal to `other`.
893
- */
894
- other?: Identification.Other;
895
- /**
896
- * Information about the passport used for identification. Required if `method` is
897
- * equal to `passport`.
898
- */
899
- passport?: Identification.Passport;
900
- }
901
- namespace Identification {
902
- /**
903
- * Information about the United States driver's license used for identification.
904
- * Required if `method` is equal to `drivers_license`.
905
- */
906
- interface DriversLicense {
470
+ interface Address {
471
+ /**
472
+ * The city of the address.
473
+ */
474
+ city: string;
907
475
  /**
908
- * The driver's license's expiration date in YYYY-MM-DD format.
476
+ * The first line of the address.
909
477
  */
910
- expiration_date: string;
478
+ line1: string;
911
479
  /**
912
- * The identifier of the File containing the front of the driver's license.
480
+ * The second line of the address.
913
481
  */
914
- file_id: string;
482
+ line2: string | null;
915
483
  /**
916
- * The state that issued the provided driver's license.
484
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
485
+ * the address.
917
486
  */
918
487
  state: string;
919
488
  /**
920
- * The identifier of the File containing the back of the driver's license.
489
+ * The ZIP code of the address.
921
490
  */
922
- back_file_id?: string;
923
- }
924
- /**
925
- * Information about the identification document provided. Required if `method` is
926
- * equal to `other`.
927
- */
928
- interface Other {
491
+ zip: string;
492
+ }
493
+ /**
494
+ * The grantor of the trust. Will be present if the `category` is `revocable`.
495
+ */
496
+ interface Grantor {
929
497
  /**
930
- * The two-character ISO 3166-1 code representing the country that issued the
931
- * document.
498
+ * The person's address.
932
499
  */
933
- country: string;
500
+ address: Grantor.Address;
934
501
  /**
935
- * A description of the document submitted.
502
+ * The person's date of birth in YYYY-MM-DD format.
936
503
  */
937
- description: string;
504
+ date_of_birth: string;
938
505
  /**
939
- * The identifier of the File containing the front of the document.
506
+ * A means of verifying the person's identity.
940
507
  */
941
- file_id: string;
508
+ identification: Grantor.Identification;
942
509
  /**
943
- * The identifier of the File containing the back of the document. Not every
944
- * document has a reverse side.
510
+ * The person's legal name.
945
511
  */
946
- back_file_id?: string;
512
+ name: string;
513
+ }
514
+ namespace Grantor {
947
515
  /**
948
- * The document's expiration date in YYYY-MM-DD format.
516
+ * The person's address.
949
517
  */
950
- expiration_date?: string;
951
- }
952
- /**
953
- * Information about the passport used for identification. Required if `method` is
954
- * equal to `passport`.
955
- */
956
- interface Passport {
518
+ interface Address {
519
+ /**
520
+ * The city of the address.
521
+ */
522
+ city: string;
523
+ /**
524
+ * The first line of the address.
525
+ */
526
+ line1: string;
527
+ /**
528
+ * The second line of the address.
529
+ */
530
+ line2: string | null;
531
+ /**
532
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
533
+ * the address.
534
+ */
535
+ state: string;
536
+ /**
537
+ * The ZIP code of the address.
538
+ */
539
+ zip: string;
540
+ }
957
541
  /**
958
- * The country that issued the passport.
542
+ * A means of verifying the person's identity.
959
543
  */
960
- country: string;
544
+ interface Identification {
545
+ /**
546
+ * A method that can be used to verify the individual's identity.
547
+ *
548
+ * - `social_security_number` - A social security number.
549
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
550
+ * identification number (ITIN).
551
+ * - `passport` - A passport number.
552
+ * - `drivers_license` - A driver's license number.
553
+ * - `other` - Another identifying document.
554
+ */
555
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
556
+ /**
557
+ * The last 4 digits of the identification number that can be used to verify the
558
+ * individual's identity.
559
+ */
560
+ number_last4: string;
561
+ }
562
+ }
563
+ interface Trustee {
961
564
  /**
962
- * The passport's expiration date in YYYY-MM-DD format.
565
+ * The individual trustee of the trust. Will be present if the trustee's
566
+ * `structure` is equal to `individual`.
963
567
  */
964
- expiration_date: string;
568
+ individual: Trustee.Individual | null;
569
+ /**
570
+ * The structure of the trustee. Will always be equal to `individual`.
571
+ *
572
+ * - `individual` - The trustee is an individual.
573
+ */
574
+ structure: 'individual';
575
+ }
576
+ namespace Trustee {
965
577
  /**
966
- * The identifier of the File containing the passport.
578
+ * The individual trustee of the trust. Will be present if the trustee's
579
+ * `structure` is equal to `individual`.
967
580
  */
968
- file_id: string;
969
- }
581
+ interface Individual {
582
+ /**
583
+ * The person's address.
584
+ */
585
+ address: Individual.Address;
586
+ /**
587
+ * The person's date of birth in YYYY-MM-DD format.
588
+ */
589
+ date_of_birth: string;
590
+ /**
591
+ * A means of verifying the person's identity.
592
+ */
593
+ identification: Individual.Identification;
594
+ /**
595
+ * The person's legal name.
596
+ */
597
+ name: string;
598
+ }
599
+ namespace Individual {
600
+ /**
601
+ * The person's address.
602
+ */
603
+ interface Address {
604
+ /**
605
+ * The city of the address.
606
+ */
607
+ city: string;
608
+ /**
609
+ * The first line of the address.
610
+ */
611
+ line1: string;
612
+ /**
613
+ * The second line of the address.
614
+ */
615
+ line2: string | null;
616
+ /**
617
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
618
+ * the address.
619
+ */
620
+ state: string;
621
+ /**
622
+ * The ZIP code of the address.
623
+ */
624
+ zip: string;
625
+ }
626
+ /**
627
+ * A means of verifying the person's identity.
628
+ */
629
+ interface Identification {
630
+ /**
631
+ * A method that can be used to verify the individual's identity.
632
+ *
633
+ * - `social_security_number` - A social security number.
634
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
635
+ * identification number (ITIN).
636
+ * - `passport` - A passport number.
637
+ * - `drivers_license` - A driver's license number.
638
+ * - `other` - Another identifying document.
639
+ */
640
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
641
+ /**
642
+ * The last 4 digits of the identification number that can be used to verify the
643
+ * individual's identity.
644
+ */
645
+ number_last4: string;
646
+ }
647
+ }
970
648
  }
971
- }
972
649
  }
973
- }
974
- /**
975
- * Details of the joint entity to create. Required if `structure` is equal to
976
- * `joint`.
977
- */
978
- interface Joint {
650
+ }
651
+ export interface EntityCreateParams {
979
652
  /**
980
- * The two individuals that share control of the entity.
653
+ * The type of Entity to create.
654
+ *
655
+ * - `corporation` - A corporation.
656
+ * - `natural_person` - An individual person.
657
+ * - `joint` - Multiple individual people.
658
+ * - `trust` - A trust.
981
659
  */
982
- individuals: Array<Joint.Individual>;
660
+ structure: 'corporation' | 'natural_person' | 'joint' | 'trust';
983
661
  /**
984
- * The name of the joint entity.
662
+ * Details of the corporation entity to create. Required if `structure` is equal to
663
+ * `corporation`.
985
664
  */
986
- name?: string;
987
- }
988
- namespace Joint {
989
- interface Individual {
990
- /**
991
- * The individual's physical address. Post Office Boxes are disallowed.
992
- */
993
- address: Individual.Address;
994
- /**
995
- * The person's date of birth in YYYY-MM-DD format.
996
- */
997
- date_of_birth: string;
998
- /**
999
- * A means of verifying the person's identity.
1000
- */
1001
- identification: Individual.Identification;
1002
- /**
1003
- * The person's legal name.
1004
- */
1005
- name: string;
1006
- /**
1007
- * The identification method for an individual can only be a passport, driver's
1008
- * license, or other document if you've confirmed the individual does not have a US
1009
- * tax id (either a Social Security Number or Individual Taxpayer Identification
1010
- * Number).
1011
- */
1012
- confirmed_no_us_tax_id?: boolean;
1013
- }
1014
- namespace Individual {
1015
- /**
1016
- * The individual's physical address. Post Office Boxes are disallowed.
1017
- */
1018
- interface Address {
1019
- /**
1020
- * The city of the address.
1021
- */
1022
- city: string;
1023
- /**
1024
- * The first line of the address. This is usually the street number and street.
1025
- */
1026
- line1: string;
1027
- /**
1028
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1029
- * the address.
1030
- */
1031
- state: string;
1032
- /**
1033
- * The ZIP code of the address.
1034
- */
1035
- zip: string;
1036
- /**
1037
- * The second line of the address. This might be the floor or room number.
1038
- */
1039
- line2?: string;
1040
- }
1041
- /**
1042
- * A means of verifying the person's identity.
1043
- */
1044
- interface Identification {
1045
- /**
1046
- * A method that can be used to verify the individual's identity.
1047
- *
1048
- * - `social_security_number` - A social security number.
1049
- * - `individual_taxpayer_identification_number` - An individual taxpayer
1050
- * identification number (ITIN).
1051
- * - `passport` - A passport number.
1052
- * - `drivers_license` - A driver's license number.
1053
- * - `other` - Another identifying document.
1054
- */
1055
- method:
1056
- | 'social_security_number'
1057
- | 'individual_taxpayer_identification_number'
1058
- | 'passport'
1059
- | 'drivers_license'
1060
- | 'other';
1061
- /**
1062
- * An identification number that can be used to verify the individual's identity,
1063
- * such as a social security number.
1064
- */
1065
- number: string;
1066
- /**
1067
- * Information about the United States driver's license used for identification.
1068
- * Required if `method` is equal to `drivers_license`.
1069
- */
1070
- drivers_license?: Identification.DriversLicense;
1071
- /**
1072
- * Information about the identification document provided. Required if `method` is
1073
- * equal to `other`.
1074
- */
1075
- other?: Identification.Other;
1076
- /**
1077
- * Information about the passport used for identification. Required if `method` is
1078
- * equal to `passport`.
1079
- */
1080
- passport?: Identification.Passport;
1081
- }
1082
- namespace Identification {
1083
- /**
1084
- * Information about the United States driver's license used for identification.
1085
- * Required if `method` is equal to `drivers_license`.
1086
- */
1087
- interface DriversLicense {
1088
- /**
1089
- * The driver's license's expiration date in YYYY-MM-DD format.
1090
- */
1091
- expiration_date: string;
1092
- /**
1093
- * The identifier of the File containing the front of the driver's license.
1094
- */
1095
- file_id: string;
1096
- /**
1097
- * The state that issued the provided driver's license.
1098
- */
1099
- state: string;
1100
- /**
1101
- * The identifier of the File containing the back of the driver's license.
1102
- */
1103
- back_file_id?: string;
1104
- }
1105
- /**
1106
- * Information about the identification document provided. Required if `method` is
1107
- * equal to `other`.
1108
- */
1109
- interface Other {
1110
- /**
1111
- * The two-character ISO 3166-1 code representing the country that issued the
1112
- * document.
1113
- */
1114
- country: string;
1115
- /**
1116
- * A description of the document submitted.
1117
- */
1118
- description: string;
1119
- /**
1120
- * The identifier of the File containing the front of the document.
1121
- */
1122
- file_id: string;
1123
- /**
1124
- * The identifier of the File containing the back of the document. Not every
1125
- * document has a reverse side.
1126
- */
1127
- back_file_id?: string;
1128
- /**
1129
- * The document's expiration date in YYYY-MM-DD format.
1130
- */
1131
- expiration_date?: string;
1132
- }
1133
- /**
1134
- * Information about the passport used for identification. Required if `method` is
1135
- * equal to `passport`.
1136
- */
1137
- interface Passport {
1138
- /**
1139
- * The country that issued the passport.
1140
- */
1141
- country: string;
1142
- /**
1143
- * The passport's expiration date in YYYY-MM-DD format.
1144
- */
1145
- expiration_date: string;
1146
- /**
1147
- * The identifier of the File containing the passport.
1148
- */
1149
- file_id: string;
1150
- }
1151
- }
1152
- }
1153
- }
1154
- /**
1155
- * Details of the natural person entity to create. Required if `structure` is equal
1156
- * to `natural_person`. Natural people entities should be submitted with
1157
- * `social_security_number` or `individual_taxpayer_identification_number`
1158
- * identification methods.
1159
- */
1160
- interface NaturalPerson {
665
+ corporation?: EntityCreateParams.Corporation;
1161
666
  /**
1162
- * The individual's physical address. Post Office Boxes are disallowed.
667
+ * The description you choose to give the entity.
1163
668
  */
1164
- address: NaturalPerson.Address;
669
+ description?: string;
1165
670
  /**
1166
- * The person's date of birth in YYYY-MM-DD format.
671
+ * Details of the joint entity to create. Required if `structure` is equal to
672
+ * `joint`.
1167
673
  */
1168
- date_of_birth: string;
674
+ joint?: EntityCreateParams.Joint;
1169
675
  /**
1170
- * A means of verifying the person's identity.
676
+ * Details of the natural person entity to create. Required if `structure` is equal
677
+ * to `natural_person`. Natural people entities should be submitted with
678
+ * `social_security_number` or `individual_taxpayer_identification_number`
679
+ * identification methods.
1171
680
  */
1172
- identification: NaturalPerson.Identification;
681
+ natural_person?: EntityCreateParams.NaturalPerson;
1173
682
  /**
1174
- * The person's legal name.
683
+ * The relationship between your group and the entity.
684
+ *
685
+ * - `affiliated` - The entity is controlled by your group.
686
+ * - `informational` - The entity is for informational purposes only.
687
+ * - `unaffiliated` - The entity is not controlled by your group, but can still
688
+ * directly open accounts.
1175
689
  */
1176
- name: string;
690
+ relationship?: 'affiliated' | 'informational' | 'unaffiliated';
1177
691
  /**
1178
- * The identification method for an individual can only be a passport, driver's
1179
- * license, or other document if you've confirmed the individual does not have a US
1180
- * tax id (either a Social Security Number or Individual Taxpayer Identification
1181
- * Number).
692
+ * Additional documentation associated with the entity.
1182
693
  */
1183
- confirmed_no_us_tax_id?: boolean;
1184
- }
1185
- namespace NaturalPerson {
694
+ supplemental_documents?: Array<EntityCreateParams.SupplementalDocument>;
1186
695
  /**
1187
- * The individual's physical address. Post Office Boxes are disallowed.
696
+ * Details of the trust entity to create. Required if `structure` is equal to
697
+ * `trust`.
1188
698
  */
1189
- interface Address {
1190
- /**
1191
- * The city of the address.
1192
- */
1193
- city: string;
1194
- /**
1195
- * The first line of the address. This is usually the street number and street.
1196
- */
1197
- line1: string;
1198
- /**
1199
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1200
- * the address.
1201
- */
1202
- state: string;
1203
- /**
1204
- * The ZIP code of the address.
1205
- */
1206
- zip: string;
1207
- /**
1208
- * The second line of the address. This might be the floor or room number.
1209
- */
1210
- line2?: string;
1211
- }
699
+ trust?: EntityCreateParams.Trust;
700
+ }
701
+ export declare namespace EntityCreateParams {
1212
702
  /**
1213
- * A means of verifying the person's identity.
703
+ * Details of the corporation entity to create. Required if `structure` is equal to
704
+ * `corporation`.
1214
705
  */
1215
- interface Identification {
1216
- /**
1217
- * A method that can be used to verify the individual's identity.
1218
- *
1219
- * - `social_security_number` - A social security number.
1220
- * - `individual_taxpayer_identification_number` - An individual taxpayer
1221
- * identification number (ITIN).
1222
- * - `passport` - A passport number.
1223
- * - `drivers_license` - A driver's license number.
1224
- * - `other` - Another identifying document.
1225
- */
1226
- method:
1227
- | 'social_security_number'
1228
- | 'individual_taxpayer_identification_number'
1229
- | 'passport'
1230
- | 'drivers_license'
1231
- | 'other';
1232
- /**
1233
- * An identification number that can be used to verify the individual's identity,
1234
- * such as a social security number.
1235
- */
1236
- number: string;
1237
- /**
1238
- * Information about the United States driver's license used for identification.
1239
- * Required if `method` is equal to `drivers_license`.
1240
- */
1241
- drivers_license?: Identification.DriversLicense;
1242
- /**
1243
- * Information about the identification document provided. Required if `method` is
1244
- * equal to `other`.
1245
- */
1246
- other?: Identification.Other;
1247
- /**
1248
- * Information about the passport used for identification. Required if `method` is
1249
- * equal to `passport`.
1250
- */
1251
- passport?: Identification.Passport;
1252
- }
1253
- namespace Identification {
1254
- /**
1255
- * Information about the United States driver's license used for identification.
1256
- * Required if `method` is equal to `drivers_license`.
1257
- */
1258
- interface DriversLicense {
1259
- /**
1260
- * The driver's license's expiration date in YYYY-MM-DD format.
1261
- */
1262
- expiration_date: string;
1263
- /**
1264
- * The identifier of the File containing the front of the driver's license.
1265
- */
1266
- file_id: string;
1267
- /**
1268
- * The state that issued the provided driver's license.
1269
- */
1270
- state: string;
706
+ interface Corporation {
1271
707
  /**
1272
- * The identifier of the File containing the back of the driver's license.
708
+ * The corporation's physical address. Post Office Boxes are disallowed.
1273
709
  */
1274
- back_file_id?: string;
1275
- }
1276
- /**
1277
- * Information about the identification document provided. Required if `method` is
1278
- * equal to `other`.
1279
- */
1280
- interface Other {
710
+ address: Corporation.Address;
1281
711
  /**
1282
- * The two-character ISO 3166-1 code representing the country that issued the
1283
- * document.
712
+ * The identifying details of anyone controlling or owning 25% or more of the
713
+ * corporation.
1284
714
  */
1285
- country: string;
715
+ beneficial_owners: Array<Corporation.BeneficialOwner>;
1286
716
  /**
1287
- * A description of the document submitted.
717
+ * The legal name of the corporation.
1288
718
  */
1289
- description: string;
719
+ name: string;
1290
720
  /**
1291
- * The identifier of the File containing the front of the document.
721
+ * The Employer Identification Number (EIN) for the corporation.
1292
722
  */
1293
- file_id: string;
723
+ tax_identifier: string;
1294
724
  /**
1295
- * The identifier of the File containing the back of the document. Not every
1296
- * document has a reverse side.
725
+ * The two-letter United States Postal Service (USPS) abbreviation for the
726
+ * corporation's state of incorporation.
1297
727
  */
1298
- back_file_id?: string;
728
+ incorporation_state?: string;
1299
729
  /**
1300
- * The document's expiration date in YYYY-MM-DD format.
730
+ * The website of the corporation.
1301
731
  */
1302
- expiration_date?: string;
1303
- }
1304
- /**
1305
- * Information about the passport used for identification. Required if `method` is
1306
- * equal to `passport`.
1307
- */
1308
- interface Passport {
732
+ website?: string;
733
+ }
734
+ namespace Corporation {
1309
735
  /**
1310
- * The country that issued the passport.
736
+ * The corporation's physical address. Post Office Boxes are disallowed.
1311
737
  */
1312
- country: string;
738
+ interface Address {
739
+ /**
740
+ * The city of the address.
741
+ */
742
+ city: string;
743
+ /**
744
+ * The first line of the address. This is usually the street number and street.
745
+ */
746
+ line1: string;
747
+ /**
748
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
749
+ * the address.
750
+ */
751
+ state: string;
752
+ /**
753
+ * The ZIP code of the address.
754
+ */
755
+ zip: string;
756
+ /**
757
+ * The second line of the address. This might be the floor or room number.
758
+ */
759
+ line2?: string;
760
+ }
761
+ interface BeneficialOwner {
762
+ /**
763
+ * Personal details for the beneficial owner.
764
+ */
765
+ individual: BeneficialOwner.Individual;
766
+ /**
767
+ * Why this person is considered a beneficial owner of the entity. At least one
768
+ * option is required.
769
+ */
770
+ prongs: Array<'ownership' | 'control'>;
771
+ /**
772
+ * This person's role or title within the entity.
773
+ */
774
+ company_title?: string;
775
+ }
776
+ namespace BeneficialOwner {
777
+ /**
778
+ * Personal details for the beneficial owner.
779
+ */
780
+ interface Individual {
781
+ /**
782
+ * The individual's physical address. Post Office Boxes are disallowed.
783
+ */
784
+ address: Individual.Address;
785
+ /**
786
+ * The person's date of birth in YYYY-MM-DD format.
787
+ */
788
+ date_of_birth: string;
789
+ /**
790
+ * A means of verifying the person's identity.
791
+ */
792
+ identification: Individual.Identification;
793
+ /**
794
+ * The person's legal name.
795
+ */
796
+ name: string;
797
+ /**
798
+ * The identification method for an individual can only be a passport, driver's
799
+ * license, or other document if you've confirmed the individual does not have a US
800
+ * tax id (either a Social Security Number or Individual Taxpayer Identification
801
+ * Number).
802
+ */
803
+ confirmed_no_us_tax_id?: boolean;
804
+ }
805
+ namespace Individual {
806
+ /**
807
+ * The individual's physical address. Post Office Boxes are disallowed.
808
+ */
809
+ interface Address {
810
+ /**
811
+ * The city of the address.
812
+ */
813
+ city: string;
814
+ /**
815
+ * The first line of the address. This is usually the street number and street.
816
+ */
817
+ line1: string;
818
+ /**
819
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
820
+ * the address.
821
+ */
822
+ state: string;
823
+ /**
824
+ * The ZIP code of the address.
825
+ */
826
+ zip: string;
827
+ /**
828
+ * The second line of the address. This might be the floor or room number.
829
+ */
830
+ line2?: string;
831
+ }
832
+ /**
833
+ * A means of verifying the person's identity.
834
+ */
835
+ interface Identification {
836
+ /**
837
+ * A method that can be used to verify the individual's identity.
838
+ *
839
+ * - `social_security_number` - A social security number.
840
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
841
+ * identification number (ITIN).
842
+ * - `passport` - A passport number.
843
+ * - `drivers_license` - A driver's license number.
844
+ * - `other` - Another identifying document.
845
+ */
846
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
847
+ /**
848
+ * An identification number that can be used to verify the individual's identity,
849
+ * such as a social security number.
850
+ */
851
+ number: string;
852
+ /**
853
+ * Information about the United States driver's license used for identification.
854
+ * Required if `method` is equal to `drivers_license`.
855
+ */
856
+ drivers_license?: Identification.DriversLicense;
857
+ /**
858
+ * Information about the identification document provided. Required if `method` is
859
+ * equal to `other`.
860
+ */
861
+ other?: Identification.Other;
862
+ /**
863
+ * Information about the passport used for identification. Required if `method` is
864
+ * equal to `passport`.
865
+ */
866
+ passport?: Identification.Passport;
867
+ }
868
+ namespace Identification {
869
+ /**
870
+ * Information about the United States driver's license used for identification.
871
+ * Required if `method` is equal to `drivers_license`.
872
+ */
873
+ interface DriversLicense {
874
+ /**
875
+ * The driver's license's expiration date in YYYY-MM-DD format.
876
+ */
877
+ expiration_date: string;
878
+ /**
879
+ * The identifier of the File containing the front of the driver's license.
880
+ */
881
+ file_id: string;
882
+ /**
883
+ * The state that issued the provided driver's license.
884
+ */
885
+ state: string;
886
+ /**
887
+ * The identifier of the File containing the back of the driver's license.
888
+ */
889
+ back_file_id?: string;
890
+ }
891
+ /**
892
+ * Information about the identification document provided. Required if `method` is
893
+ * equal to `other`.
894
+ */
895
+ interface Other {
896
+ /**
897
+ * The two-character ISO 3166-1 code representing the country that issued the
898
+ * document.
899
+ */
900
+ country: string;
901
+ /**
902
+ * A description of the document submitted.
903
+ */
904
+ description: string;
905
+ /**
906
+ * The identifier of the File containing the front of the document.
907
+ */
908
+ file_id: string;
909
+ /**
910
+ * The identifier of the File containing the back of the document. Not every
911
+ * document has a reverse side.
912
+ */
913
+ back_file_id?: string;
914
+ /**
915
+ * The document's expiration date in YYYY-MM-DD format.
916
+ */
917
+ expiration_date?: string;
918
+ }
919
+ /**
920
+ * Information about the passport used for identification. Required if `method` is
921
+ * equal to `passport`.
922
+ */
923
+ interface Passport {
924
+ /**
925
+ * The country that issued the passport.
926
+ */
927
+ country: string;
928
+ /**
929
+ * The passport's expiration date in YYYY-MM-DD format.
930
+ */
931
+ expiration_date: string;
932
+ /**
933
+ * The identifier of the File containing the passport.
934
+ */
935
+ file_id: string;
936
+ }
937
+ }
938
+ }
939
+ }
940
+ }
941
+ /**
942
+ * Details of the joint entity to create. Required if `structure` is equal to
943
+ * `joint`.
944
+ */
945
+ interface Joint {
1313
946
  /**
1314
- * The passport's expiration date in YYYY-MM-DD format.
947
+ * The two individuals that share control of the entity.
1315
948
  */
1316
- expiration_date: string;
949
+ individuals: Array<Joint.Individual>;
1317
950
  /**
1318
- * The identifier of the File containing the passport.
951
+ * The name of the joint entity.
1319
952
  */
1320
- file_id: string;
1321
- }
953
+ name?: string;
954
+ }
955
+ namespace Joint {
956
+ interface Individual {
957
+ /**
958
+ * The individual's physical address. Post Office Boxes are disallowed.
959
+ */
960
+ address: Individual.Address;
961
+ /**
962
+ * The person's date of birth in YYYY-MM-DD format.
963
+ */
964
+ date_of_birth: string;
965
+ /**
966
+ * A means of verifying the person's identity.
967
+ */
968
+ identification: Individual.Identification;
969
+ /**
970
+ * The person's legal name.
971
+ */
972
+ name: string;
973
+ /**
974
+ * The identification method for an individual can only be a passport, driver's
975
+ * license, or other document if you've confirmed the individual does not have a US
976
+ * tax id (either a Social Security Number or Individual Taxpayer Identification
977
+ * Number).
978
+ */
979
+ confirmed_no_us_tax_id?: boolean;
980
+ }
981
+ namespace Individual {
982
+ /**
983
+ * The individual's physical address. Post Office Boxes are disallowed.
984
+ */
985
+ interface Address {
986
+ /**
987
+ * The city of the address.
988
+ */
989
+ city: string;
990
+ /**
991
+ * The first line of the address. This is usually the street number and street.
992
+ */
993
+ line1: string;
994
+ /**
995
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
996
+ * the address.
997
+ */
998
+ state: string;
999
+ /**
1000
+ * The ZIP code of the address.
1001
+ */
1002
+ zip: string;
1003
+ /**
1004
+ * The second line of the address. This might be the floor or room number.
1005
+ */
1006
+ line2?: string;
1007
+ }
1008
+ /**
1009
+ * A means of verifying the person's identity.
1010
+ */
1011
+ interface Identification {
1012
+ /**
1013
+ * A method that can be used to verify the individual's identity.
1014
+ *
1015
+ * - `social_security_number` - A social security number.
1016
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
1017
+ * identification number (ITIN).
1018
+ * - `passport` - A passport number.
1019
+ * - `drivers_license` - A driver's license number.
1020
+ * - `other` - Another identifying document.
1021
+ */
1022
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
1023
+ /**
1024
+ * An identification number that can be used to verify the individual's identity,
1025
+ * such as a social security number.
1026
+ */
1027
+ number: string;
1028
+ /**
1029
+ * Information about the United States driver's license used for identification.
1030
+ * Required if `method` is equal to `drivers_license`.
1031
+ */
1032
+ drivers_license?: Identification.DriversLicense;
1033
+ /**
1034
+ * Information about the identification document provided. Required if `method` is
1035
+ * equal to `other`.
1036
+ */
1037
+ other?: Identification.Other;
1038
+ /**
1039
+ * Information about the passport used for identification. Required if `method` is
1040
+ * equal to `passport`.
1041
+ */
1042
+ passport?: Identification.Passport;
1043
+ }
1044
+ namespace Identification {
1045
+ /**
1046
+ * Information about the United States driver's license used for identification.
1047
+ * Required if `method` is equal to `drivers_license`.
1048
+ */
1049
+ interface DriversLicense {
1050
+ /**
1051
+ * The driver's license's expiration date in YYYY-MM-DD format.
1052
+ */
1053
+ expiration_date: string;
1054
+ /**
1055
+ * The identifier of the File containing the front of the driver's license.
1056
+ */
1057
+ file_id: string;
1058
+ /**
1059
+ * The state that issued the provided driver's license.
1060
+ */
1061
+ state: string;
1062
+ /**
1063
+ * The identifier of the File containing the back of the driver's license.
1064
+ */
1065
+ back_file_id?: string;
1066
+ }
1067
+ /**
1068
+ * Information about the identification document provided. Required if `method` is
1069
+ * equal to `other`.
1070
+ */
1071
+ interface Other {
1072
+ /**
1073
+ * The two-character ISO 3166-1 code representing the country that issued the
1074
+ * document.
1075
+ */
1076
+ country: string;
1077
+ /**
1078
+ * A description of the document submitted.
1079
+ */
1080
+ description: string;
1081
+ /**
1082
+ * The identifier of the File containing the front of the document.
1083
+ */
1084
+ file_id: string;
1085
+ /**
1086
+ * The identifier of the File containing the back of the document. Not every
1087
+ * document has a reverse side.
1088
+ */
1089
+ back_file_id?: string;
1090
+ /**
1091
+ * The document's expiration date in YYYY-MM-DD format.
1092
+ */
1093
+ expiration_date?: string;
1094
+ }
1095
+ /**
1096
+ * Information about the passport used for identification. Required if `method` is
1097
+ * equal to `passport`.
1098
+ */
1099
+ interface Passport {
1100
+ /**
1101
+ * The country that issued the passport.
1102
+ */
1103
+ country: string;
1104
+ /**
1105
+ * The passport's expiration date in YYYY-MM-DD format.
1106
+ */
1107
+ expiration_date: string;
1108
+ /**
1109
+ * The identifier of the File containing the passport.
1110
+ */
1111
+ file_id: string;
1112
+ }
1113
+ }
1114
+ }
1322
1115
  }
1323
- }
1324
- interface SupplementalDocument {
1325
- /**
1326
- * The identifier of the File containing the document.
1327
- */
1328
- file_id: string;
1329
- }
1330
- /**
1331
- * Details of the trust entity to create. Required if `structure` is equal to
1332
- * `trust`.
1333
- */
1334
- interface Trust {
1335
- /**
1336
- * The trust's physical address. Post Office Boxes are disallowed.
1337
- */
1338
- address: Trust.Address;
1339
- /**
1340
- * Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
1341
- * their own Employer Identification Number. Revocable trusts require information
1342
- * about the individual `grantor` who created the trust.
1343
- *
1344
- * - `revocable` - The trust is revocable by the grantor.
1345
- * - `irrevocable` - The trust cannot be revoked.
1346
- */
1347
- category: 'revocable' | 'irrevocable';
1348
- /**
1349
- * The legal name of the trust.
1350
- */
1351
- name: string;
1352
- /**
1353
- * The trustees of the trust.
1354
- */
1355
- trustees: Array<Trust.Trustee>;
1356
- /**
1357
- * The identifier of the File containing the formation document of the trust.
1358
- */
1359
- formation_document_file_id?: string;
1360
- /**
1361
- * The two-letter United States Postal Service (USPS) abbreviation for the state in
1362
- * which the trust was formed.
1363
- */
1364
- formation_state?: string;
1365
- /**
1366
- * The grantor of the trust. Required if `category` is equal to `revocable`.
1367
- */
1368
- grantor?: Trust.Grantor;
1369
- /**
1370
- * The Employer Identification Number (EIN) for the trust. Required if `category`
1371
- * is equal to `irrevocable`.
1372
- */
1373
- tax_identifier?: string;
1374
- }
1375
- namespace Trust {
1376
1116
  /**
1377
- * The trust's physical address. Post Office Boxes are disallowed.
1117
+ * Details of the natural person entity to create. Required if `structure` is equal
1118
+ * to `natural_person`. Natural people entities should be submitted with
1119
+ * `social_security_number` or `individual_taxpayer_identification_number`
1120
+ * identification methods.
1378
1121
  */
1379
- interface Address {
1380
- /**
1381
- * The city of the address.
1382
- */
1383
- city: string;
1384
- /**
1385
- * The first line of the address. This is usually the street number and street.
1386
- */
1387
- line1: string;
1388
- /**
1389
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1390
- * the address.
1391
- */
1392
- state: string;
1393
- /**
1394
- * The ZIP code of the address.
1395
- */
1396
- zip: string;
1397
- /**
1398
- * The second line of the address. This might be the floor or room number.
1399
- */
1400
- line2?: string;
1401
- }
1402
- interface Trustee {
1403
- /**
1404
- * The structure of the trustee.
1405
- *
1406
- * - `individual` - The trustee is an individual.
1407
- */
1408
- structure: 'individual';
1409
- /**
1410
- * Details of the individual trustee. Required when the trustee `structure` is
1411
- * equal to `individual`.
1412
- */
1413
- individual?: Trustee.Individual;
1414
- }
1415
- namespace Trustee {
1416
- /**
1417
- * Details of the individual trustee. Required when the trustee `structure` is
1418
- * equal to `individual`.
1419
- */
1420
- interface Individual {
1122
+ interface NaturalPerson {
1421
1123
  /**
1422
1124
  * The individual's physical address. Post Office Boxes are disallowed.
1423
1125
  */
1424
- address: Individual.Address;
1126
+ address: NaturalPerson.Address;
1425
1127
  /**
1426
1128
  * The person's date of birth in YYYY-MM-DD format.
1427
1129
  */
@@ -1429,7 +1131,7 @@ export declare namespace EntityCreateParams {
1429
1131
  /**
1430
1132
  * A means of verifying the person's identity.
1431
1133
  */
1432
- identification: Individual.Identification;
1134
+ identification: NaturalPerson.Identification;
1433
1135
  /**
1434
1136
  * The person's legal name.
1435
1137
  */
@@ -1441,180 +1143,599 @@ export declare namespace EntityCreateParams {
1441
1143
  * Number).
1442
1144
  */
1443
1145
  confirmed_no_us_tax_id?: boolean;
1444
- }
1445
- namespace Individual {
1146
+ }
1147
+ namespace NaturalPerson {
1446
1148
  /**
1447
1149
  * The individual's physical address. Post Office Boxes are disallowed.
1448
1150
  */
1449
1151
  interface Address {
1450
- /**
1451
- * The city of the address.
1452
- */
1453
- city: string;
1454
- /**
1455
- * The first line of the address. This is usually the street number and street.
1456
- */
1457
- line1: string;
1458
- /**
1459
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1460
- * the address.
1461
- */
1462
- state: string;
1463
- /**
1464
- * The ZIP code of the address.
1465
- */
1466
- zip: string;
1467
- /**
1468
- * The second line of the address. This might be the floor or room number.
1469
- */
1470
- line2?: string;
1152
+ /**
1153
+ * The city of the address.
1154
+ */
1155
+ city: string;
1156
+ /**
1157
+ * The first line of the address. This is usually the street number and street.
1158
+ */
1159
+ line1: string;
1160
+ /**
1161
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
1162
+ * the address.
1163
+ */
1164
+ state: string;
1165
+ /**
1166
+ * The ZIP code of the address.
1167
+ */
1168
+ zip: string;
1169
+ /**
1170
+ * The second line of the address. This might be the floor or room number.
1171
+ */
1172
+ line2?: string;
1471
1173
  }
1472
1174
  /**
1473
1175
  * A means of verifying the person's identity.
1474
1176
  */
1475
1177
  interface Identification {
1476
- /**
1477
- * A method that can be used to verify the individual's identity.
1478
- *
1479
- * - `social_security_number` - A social security number.
1480
- * - `individual_taxpayer_identification_number` - An individual taxpayer
1481
- * identification number (ITIN).
1482
- * - `passport` - A passport number.
1483
- * - `drivers_license` - A driver's license number.
1484
- * - `other` - Another identifying document.
1485
- */
1486
- method:
1487
- | 'social_security_number'
1488
- | 'individual_taxpayer_identification_number'
1489
- | 'passport'
1490
- | 'drivers_license'
1491
- | 'other';
1492
- /**
1493
- * An identification number that can be used to verify the individual's identity,
1494
- * such as a social security number.
1495
- */
1496
- number: string;
1497
- /**
1498
- * Information about the United States driver's license used for identification.
1499
- * Required if `method` is equal to `drivers_license`.
1500
- */
1501
- drivers_license?: Identification.DriversLicense;
1502
- /**
1503
- * Information about the identification document provided. Required if `method` is
1504
- * equal to `other`.
1505
- */
1506
- other?: Identification.Other;
1507
- /**
1508
- * Information about the passport used for identification. Required if `method` is
1509
- * equal to `passport`.
1510
- */
1511
- passport?: Identification.Passport;
1178
+ /**
1179
+ * A method that can be used to verify the individual's identity.
1180
+ *
1181
+ * - `social_security_number` - A social security number.
1182
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
1183
+ * identification number (ITIN).
1184
+ * - `passport` - A passport number.
1185
+ * - `drivers_license` - A driver's license number.
1186
+ * - `other` - Another identifying document.
1187
+ */
1188
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
1189
+ /**
1190
+ * An identification number that can be used to verify the individual's identity,
1191
+ * such as a social security number.
1192
+ */
1193
+ number: string;
1194
+ /**
1195
+ * Information about the United States driver's license used for identification.
1196
+ * Required if `method` is equal to `drivers_license`.
1197
+ */
1198
+ drivers_license?: Identification.DriversLicense;
1199
+ /**
1200
+ * Information about the identification document provided. Required if `method` is
1201
+ * equal to `other`.
1202
+ */
1203
+ other?: Identification.Other;
1204
+ /**
1205
+ * Information about the passport used for identification. Required if `method` is
1206
+ * equal to `passport`.
1207
+ */
1208
+ passport?: Identification.Passport;
1512
1209
  }
1513
1210
  namespace Identification {
1514
- /**
1515
- * Information about the United States driver's license used for identification.
1516
- * Required if `method` is equal to `drivers_license`.
1517
- */
1518
- interface DriversLicense {
1519
1211
  /**
1520
- * The driver's license's expiration date in YYYY-MM-DD format.
1212
+ * Information about the United States driver's license used for identification.
1213
+ * Required if `method` is equal to `drivers_license`.
1214
+ */
1215
+ interface DriversLicense {
1216
+ /**
1217
+ * The driver's license's expiration date in YYYY-MM-DD format.
1218
+ */
1219
+ expiration_date: string;
1220
+ /**
1221
+ * The identifier of the File containing the front of the driver's license.
1222
+ */
1223
+ file_id: string;
1224
+ /**
1225
+ * The state that issued the provided driver's license.
1226
+ */
1227
+ state: string;
1228
+ /**
1229
+ * The identifier of the File containing the back of the driver's license.
1230
+ */
1231
+ back_file_id?: string;
1232
+ }
1233
+ /**
1234
+ * Information about the identification document provided. Required if `method` is
1235
+ * equal to `other`.
1236
+ */
1237
+ interface Other {
1238
+ /**
1239
+ * The two-character ISO 3166-1 code representing the country that issued the
1240
+ * document.
1241
+ */
1242
+ country: string;
1243
+ /**
1244
+ * A description of the document submitted.
1245
+ */
1246
+ description: string;
1247
+ /**
1248
+ * The identifier of the File containing the front of the document.
1249
+ */
1250
+ file_id: string;
1251
+ /**
1252
+ * The identifier of the File containing the back of the document. Not every
1253
+ * document has a reverse side.
1254
+ */
1255
+ back_file_id?: string;
1256
+ /**
1257
+ * The document's expiration date in YYYY-MM-DD format.
1258
+ */
1259
+ expiration_date?: string;
1260
+ }
1261
+ /**
1262
+ * Information about the passport used for identification. Required if `method` is
1263
+ * equal to `passport`.
1264
+ */
1265
+ interface Passport {
1266
+ /**
1267
+ * The country that issued the passport.
1268
+ */
1269
+ country: string;
1270
+ /**
1271
+ * The passport's expiration date in YYYY-MM-DD format.
1272
+ */
1273
+ expiration_date: string;
1274
+ /**
1275
+ * The identifier of the File containing the passport.
1276
+ */
1277
+ file_id: string;
1278
+ }
1279
+ }
1280
+ }
1281
+ interface SupplementalDocument {
1282
+ /**
1283
+ * The identifier of the File containing the document.
1284
+ */
1285
+ file_id: string;
1286
+ }
1287
+ /**
1288
+ * Details of the trust entity to create. Required if `structure` is equal to
1289
+ * `trust`.
1290
+ */
1291
+ interface Trust {
1292
+ /**
1293
+ * The trust's physical address. Post Office Boxes are disallowed.
1294
+ */
1295
+ address: Trust.Address;
1296
+ /**
1297
+ * Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
1298
+ * their own Employer Identification Number. Revocable trusts require information
1299
+ * about the individual `grantor` who created the trust.
1300
+ *
1301
+ * - `revocable` - The trust is revocable by the grantor.
1302
+ * - `irrevocable` - The trust cannot be revoked.
1303
+ */
1304
+ category: 'revocable' | 'irrevocable';
1305
+ /**
1306
+ * The legal name of the trust.
1307
+ */
1308
+ name: string;
1309
+ /**
1310
+ * The trustees of the trust.
1311
+ */
1312
+ trustees: Array<Trust.Trustee>;
1313
+ /**
1314
+ * The identifier of the File containing the formation document of the trust.
1315
+ */
1316
+ formation_document_file_id?: string;
1317
+ /**
1318
+ * The two-letter United States Postal Service (USPS) abbreviation for the state in
1319
+ * which the trust was formed.
1320
+ */
1321
+ formation_state?: string;
1322
+ /**
1323
+ * The grantor of the trust. Required if `category` is equal to `revocable`.
1324
+ */
1325
+ grantor?: Trust.Grantor;
1326
+ /**
1327
+ * The Employer Identification Number (EIN) for the trust. Required if `category`
1328
+ * is equal to `irrevocable`.
1329
+ */
1330
+ tax_identifier?: string;
1331
+ }
1332
+ namespace Trust {
1333
+ /**
1334
+ * The trust's physical address. Post Office Boxes are disallowed.
1335
+ */
1336
+ interface Address {
1337
+ /**
1338
+ * The city of the address.
1521
1339
  */
1522
- expiration_date: string;
1340
+ city: string;
1523
1341
  /**
1524
- * The identifier of the File containing the front of the driver's license.
1342
+ * The first line of the address. This is usually the street number and street.
1525
1343
  */
1526
- file_id: string;
1344
+ line1: string;
1527
1345
  /**
1528
- * The state that issued the provided driver's license.
1346
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
1347
+ * the address.
1529
1348
  */
1530
1349
  state: string;
1531
1350
  /**
1532
- * The identifier of the File containing the back of the driver's license.
1351
+ * The ZIP code of the address.
1352
+ */
1353
+ zip: string;
1354
+ /**
1355
+ * The second line of the address. This might be the floor or room number.
1356
+ */
1357
+ line2?: string;
1358
+ }
1359
+ interface Trustee {
1360
+ /**
1361
+ * The structure of the trustee.
1362
+ *
1363
+ * - `individual` - The trustee is an individual.
1364
+ */
1365
+ structure: 'individual';
1366
+ /**
1367
+ * Details of the individual trustee. Required when the trustee `structure` is
1368
+ * equal to `individual`.
1533
1369
  */
1534
- back_file_id?: string;
1535
- }
1536
- /**
1537
- * Information about the identification document provided. Required if `method` is
1538
- * equal to `other`.
1539
- */
1540
- interface Other {
1370
+ individual?: Trustee.Individual;
1371
+ }
1372
+ namespace Trustee {
1541
1373
  /**
1542
- * The two-character ISO 3166-1 code representing the country that issued the
1543
- * document.
1374
+ * Details of the individual trustee. Required when the trustee `structure` is
1375
+ * equal to `individual`.
1544
1376
  */
1545
- country: string;
1377
+ interface Individual {
1378
+ /**
1379
+ * The individual's physical address. Post Office Boxes are disallowed.
1380
+ */
1381
+ address: Individual.Address;
1382
+ /**
1383
+ * The person's date of birth in YYYY-MM-DD format.
1384
+ */
1385
+ date_of_birth: string;
1386
+ /**
1387
+ * A means of verifying the person's identity.
1388
+ */
1389
+ identification: Individual.Identification;
1390
+ /**
1391
+ * The person's legal name.
1392
+ */
1393
+ name: string;
1394
+ /**
1395
+ * The identification method for an individual can only be a passport, driver's
1396
+ * license, or other document if you've confirmed the individual does not have a US
1397
+ * tax id (either a Social Security Number or Individual Taxpayer Identification
1398
+ * Number).
1399
+ */
1400
+ confirmed_no_us_tax_id?: boolean;
1401
+ }
1402
+ namespace Individual {
1403
+ /**
1404
+ * The individual's physical address. Post Office Boxes are disallowed.
1405
+ */
1406
+ interface Address {
1407
+ /**
1408
+ * The city of the address.
1409
+ */
1410
+ city: string;
1411
+ /**
1412
+ * The first line of the address. This is usually the street number and street.
1413
+ */
1414
+ line1: string;
1415
+ /**
1416
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
1417
+ * the address.
1418
+ */
1419
+ state: string;
1420
+ /**
1421
+ * The ZIP code of the address.
1422
+ */
1423
+ zip: string;
1424
+ /**
1425
+ * The second line of the address. This might be the floor or room number.
1426
+ */
1427
+ line2?: string;
1428
+ }
1429
+ /**
1430
+ * A means of verifying the person's identity.
1431
+ */
1432
+ interface Identification {
1433
+ /**
1434
+ * A method that can be used to verify the individual's identity.
1435
+ *
1436
+ * - `social_security_number` - A social security number.
1437
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
1438
+ * identification number (ITIN).
1439
+ * - `passport` - A passport number.
1440
+ * - `drivers_license` - A driver's license number.
1441
+ * - `other` - Another identifying document.
1442
+ */
1443
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
1444
+ /**
1445
+ * An identification number that can be used to verify the individual's identity,
1446
+ * such as a social security number.
1447
+ */
1448
+ number: string;
1449
+ /**
1450
+ * Information about the United States driver's license used for identification.
1451
+ * Required if `method` is equal to `drivers_license`.
1452
+ */
1453
+ drivers_license?: Identification.DriversLicense;
1454
+ /**
1455
+ * Information about the identification document provided. Required if `method` is
1456
+ * equal to `other`.
1457
+ */
1458
+ other?: Identification.Other;
1459
+ /**
1460
+ * Information about the passport used for identification. Required if `method` is
1461
+ * equal to `passport`.
1462
+ */
1463
+ passport?: Identification.Passport;
1464
+ }
1465
+ namespace Identification {
1466
+ /**
1467
+ * Information about the United States driver's license used for identification.
1468
+ * Required if `method` is equal to `drivers_license`.
1469
+ */
1470
+ interface DriversLicense {
1471
+ /**
1472
+ * The driver's license's expiration date in YYYY-MM-DD format.
1473
+ */
1474
+ expiration_date: string;
1475
+ /**
1476
+ * The identifier of the File containing the front of the driver's license.
1477
+ */
1478
+ file_id: string;
1479
+ /**
1480
+ * The state that issued the provided driver's license.
1481
+ */
1482
+ state: string;
1483
+ /**
1484
+ * The identifier of the File containing the back of the driver's license.
1485
+ */
1486
+ back_file_id?: string;
1487
+ }
1488
+ /**
1489
+ * Information about the identification document provided. Required if `method` is
1490
+ * equal to `other`.
1491
+ */
1492
+ interface Other {
1493
+ /**
1494
+ * The two-character ISO 3166-1 code representing the country that issued the
1495
+ * document.
1496
+ */
1497
+ country: string;
1498
+ /**
1499
+ * A description of the document submitted.
1500
+ */
1501
+ description: string;
1502
+ /**
1503
+ * The identifier of the File containing the front of the document.
1504
+ */
1505
+ file_id: string;
1506
+ /**
1507
+ * The identifier of the File containing the back of the document. Not every
1508
+ * document has a reverse side.
1509
+ */
1510
+ back_file_id?: string;
1511
+ /**
1512
+ * The document's expiration date in YYYY-MM-DD format.
1513
+ */
1514
+ expiration_date?: string;
1515
+ }
1516
+ /**
1517
+ * Information about the passport used for identification. Required if `method` is
1518
+ * equal to `passport`.
1519
+ */
1520
+ interface Passport {
1521
+ /**
1522
+ * The country that issued the passport.
1523
+ */
1524
+ country: string;
1525
+ /**
1526
+ * The passport's expiration date in YYYY-MM-DD format.
1527
+ */
1528
+ expiration_date: string;
1529
+ /**
1530
+ * The identifier of the File containing the passport.
1531
+ */
1532
+ file_id: string;
1533
+ }
1534
+ }
1535
+ }
1536
+ }
1537
+ /**
1538
+ * The grantor of the trust. Required if `category` is equal to `revocable`.
1539
+ */
1540
+ interface Grantor {
1546
1541
  /**
1547
- * A description of the document submitted.
1542
+ * The individual's physical address. Post Office Boxes are disallowed.
1548
1543
  */
1549
- description: string;
1544
+ address: Grantor.Address;
1550
1545
  /**
1551
- * The identifier of the File containing the front of the document.
1546
+ * The person's date of birth in YYYY-MM-DD format.
1552
1547
  */
1553
- file_id: string;
1548
+ date_of_birth: string;
1554
1549
  /**
1555
- * The identifier of the File containing the back of the document. Not every
1556
- * document has a reverse side.
1550
+ * A means of verifying the person's identity.
1557
1551
  */
1558
- back_file_id?: string;
1552
+ identification: Grantor.Identification;
1559
1553
  /**
1560
- * The document's expiration date in YYYY-MM-DD format.
1554
+ * The person's legal name.
1561
1555
  */
1562
- expiration_date?: string;
1563
- }
1564
- /**
1565
- * Information about the passport used for identification. Required if `method` is
1566
- * equal to `passport`.
1567
- */
1568
- interface Passport {
1556
+ name: string;
1569
1557
  /**
1570
- * The country that issued the passport.
1558
+ * The identification method for an individual can only be a passport, driver's
1559
+ * license, or other document if you've confirmed the individual does not have a US
1560
+ * tax id (either a Social Security Number or Individual Taxpayer Identification
1561
+ * Number).
1571
1562
  */
1572
- country: string;
1563
+ confirmed_no_us_tax_id?: boolean;
1564
+ }
1565
+ namespace Grantor {
1573
1566
  /**
1574
- * The passport's expiration date in YYYY-MM-DD format.
1567
+ * The individual's physical address. Post Office Boxes are disallowed.
1575
1568
  */
1576
- expiration_date: string;
1569
+ interface Address {
1570
+ /**
1571
+ * The city of the address.
1572
+ */
1573
+ city: string;
1574
+ /**
1575
+ * The first line of the address. This is usually the street number and street.
1576
+ */
1577
+ line1: string;
1578
+ /**
1579
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
1580
+ * the address.
1581
+ */
1582
+ state: string;
1583
+ /**
1584
+ * The ZIP code of the address.
1585
+ */
1586
+ zip: string;
1587
+ /**
1588
+ * The second line of the address. This might be the floor or room number.
1589
+ */
1590
+ line2?: string;
1591
+ }
1577
1592
  /**
1578
- * The identifier of the File containing the passport.
1593
+ * A means of verifying the person's identity.
1579
1594
  */
1580
- file_id: string;
1581
- }
1595
+ interface Identification {
1596
+ /**
1597
+ * A method that can be used to verify the individual's identity.
1598
+ *
1599
+ * - `social_security_number` - A social security number.
1600
+ * - `individual_taxpayer_identification_number` - An individual taxpayer
1601
+ * identification number (ITIN).
1602
+ * - `passport` - A passport number.
1603
+ * - `drivers_license` - A driver's license number.
1604
+ * - `other` - Another identifying document.
1605
+ */
1606
+ method: 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other';
1607
+ /**
1608
+ * An identification number that can be used to verify the individual's identity,
1609
+ * such as a social security number.
1610
+ */
1611
+ number: string;
1612
+ /**
1613
+ * Information about the United States driver's license used for identification.
1614
+ * Required if `method` is equal to `drivers_license`.
1615
+ */
1616
+ drivers_license?: Identification.DriversLicense;
1617
+ /**
1618
+ * Information about the identification document provided. Required if `method` is
1619
+ * equal to `other`.
1620
+ */
1621
+ other?: Identification.Other;
1622
+ /**
1623
+ * Information about the passport used for identification. Required if `method` is
1624
+ * equal to `passport`.
1625
+ */
1626
+ passport?: Identification.Passport;
1627
+ }
1628
+ namespace Identification {
1629
+ /**
1630
+ * Information about the United States driver's license used for identification.
1631
+ * Required if `method` is equal to `drivers_license`.
1632
+ */
1633
+ interface DriversLicense {
1634
+ /**
1635
+ * The driver's license's expiration date in YYYY-MM-DD format.
1636
+ */
1637
+ expiration_date: string;
1638
+ /**
1639
+ * The identifier of the File containing the front of the driver's license.
1640
+ */
1641
+ file_id: string;
1642
+ /**
1643
+ * The state that issued the provided driver's license.
1644
+ */
1645
+ state: string;
1646
+ /**
1647
+ * The identifier of the File containing the back of the driver's license.
1648
+ */
1649
+ back_file_id?: string;
1650
+ }
1651
+ /**
1652
+ * Information about the identification document provided. Required if `method` is
1653
+ * equal to `other`.
1654
+ */
1655
+ interface Other {
1656
+ /**
1657
+ * The two-character ISO 3166-1 code representing the country that issued the
1658
+ * document.
1659
+ */
1660
+ country: string;
1661
+ /**
1662
+ * A description of the document submitted.
1663
+ */
1664
+ description: string;
1665
+ /**
1666
+ * The identifier of the File containing the front of the document.
1667
+ */
1668
+ file_id: string;
1669
+ /**
1670
+ * The identifier of the File containing the back of the document. Not every
1671
+ * document has a reverse side.
1672
+ */
1673
+ back_file_id?: string;
1674
+ /**
1675
+ * The document's expiration date in YYYY-MM-DD format.
1676
+ */
1677
+ expiration_date?: string;
1678
+ }
1679
+ /**
1680
+ * Information about the passport used for identification. Required if `method` is
1681
+ * equal to `passport`.
1682
+ */
1683
+ interface Passport {
1684
+ /**
1685
+ * The country that issued the passport.
1686
+ */
1687
+ country: string;
1688
+ /**
1689
+ * The passport's expiration date in YYYY-MM-DD format.
1690
+ */
1691
+ expiration_date: string;
1692
+ /**
1693
+ * The identifier of the File containing the passport.
1694
+ */
1695
+ file_id: string;
1696
+ }
1697
+ }
1582
1698
  }
1583
- }
1584
1699
  }
1700
+ }
1701
+ export interface EntityListParams extends PageParams {
1702
+ created_at?: EntityListParams.CreatedAt;
1703
+ }
1704
+ export declare namespace EntityListParams {
1705
+ interface CreatedAt {
1706
+ /**
1707
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1708
+ * timestamp.
1709
+ */
1710
+ after?: string;
1711
+ /**
1712
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1713
+ * timestamp.
1714
+ */
1715
+ before?: string;
1716
+ /**
1717
+ * Return results on or after this
1718
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1719
+ */
1720
+ on_or_after?: string;
1721
+ /**
1722
+ * Return results on or before this
1723
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1724
+ */
1725
+ on_or_before?: string;
1726
+ }
1727
+ }
1728
+ export interface EntityUpdateAddressParams {
1585
1729
  /**
1586
- * The grantor of the trust. Required if `category` is equal to `revocable`.
1730
+ * The entity's physical address. Post Office Boxes are disallowed.
1587
1731
  */
1588
- interface Grantor {
1589
- /**
1590
- * The individual's physical address. Post Office Boxes are disallowed.
1591
- */
1592
- address: Grantor.Address;
1593
- /**
1594
- * The person's date of birth in YYYY-MM-DD format.
1595
- */
1596
- date_of_birth: string;
1597
- /**
1598
- * A means of verifying the person's identity.
1599
- */
1600
- identification: Grantor.Identification;
1601
- /**
1602
- * The person's legal name.
1603
- */
1604
- name: string;
1605
- /**
1606
- * The identification method for an individual can only be a passport, driver's
1607
- * license, or other document if you've confirmed the individual does not have a US
1608
- * tax id (either a Social Security Number or Individual Taxpayer Identification
1609
- * Number).
1610
- */
1611
- confirmed_no_us_tax_id?: boolean;
1612
- }
1613
- namespace Grantor {
1614
- /**
1615
- * The individual's physical address. Post Office Boxes are disallowed.
1616
- */
1617
- interface Address {
1732
+ address: EntityUpdateAddressParams.Address;
1733
+ }
1734
+ export declare namespace EntityUpdateAddressParams {
1735
+ /**
1736
+ * The entity's physical address. Post Office Boxes are disallowed.
1737
+ */
1738
+ interface Address {
1618
1739
  /**
1619
1740
  * The city of the address.
1620
1741
  */
@@ -1636,197 +1757,23 @@ export declare namespace EntityCreateParams {
1636
1757
  * The second line of the address. This might be the floor or room number.
1637
1758
  */
1638
1759
  line2?: string;
1639
- }
1640
- /**
1641
- * A means of verifying the person's identity.
1642
- */
1643
- interface Identification {
1644
- /**
1645
- * A method that can be used to verify the individual's identity.
1646
- *
1647
- * - `social_security_number` - A social security number.
1648
- * - `individual_taxpayer_identification_number` - An individual taxpayer
1649
- * identification number (ITIN).
1650
- * - `passport` - A passport number.
1651
- * - `drivers_license` - A driver's license number.
1652
- * - `other` - Another identifying document.
1653
- */
1654
- method:
1655
- | 'social_security_number'
1656
- | 'individual_taxpayer_identification_number'
1657
- | 'passport'
1658
- | 'drivers_license'
1659
- | 'other';
1660
- /**
1661
- * An identification number that can be used to verify the individual's identity,
1662
- * such as a social security number.
1663
- */
1664
- number: string;
1665
- /**
1666
- * Information about the United States driver's license used for identification.
1667
- * Required if `method` is equal to `drivers_license`.
1668
- */
1669
- drivers_license?: Identification.DriversLicense;
1670
- /**
1671
- * Information about the identification document provided. Required if `method` is
1672
- * equal to `other`.
1673
- */
1674
- other?: Identification.Other;
1675
- /**
1676
- * Information about the passport used for identification. Required if `method` is
1677
- * equal to `passport`.
1678
- */
1679
- passport?: Identification.Passport;
1680
- }
1681
- namespace Identification {
1682
- /**
1683
- * Information about the United States driver's license used for identification.
1684
- * Required if `method` is equal to `drivers_license`.
1685
- */
1686
- interface DriversLicense {
1687
- /**
1688
- * The driver's license's expiration date in YYYY-MM-DD format.
1689
- */
1690
- expiration_date: string;
1691
- /**
1692
- * The identifier of the File containing the front of the driver's license.
1693
- */
1694
- file_id: string;
1695
- /**
1696
- * The state that issued the provided driver's license.
1697
- */
1698
- state: string;
1699
- /**
1700
- * The identifier of the File containing the back of the driver's license.
1701
- */
1702
- back_file_id?: string;
1703
- }
1704
- /**
1705
- * Information about the identification document provided. Required if `method` is
1706
- * equal to `other`.
1707
- */
1708
- interface Other {
1709
- /**
1710
- * The two-character ISO 3166-1 code representing the country that issued the
1711
- * document.
1712
- */
1713
- country: string;
1714
- /**
1715
- * A description of the document submitted.
1716
- */
1717
- description: string;
1718
- /**
1719
- * The identifier of the File containing the front of the document.
1720
- */
1721
- file_id: string;
1722
- /**
1723
- * The identifier of the File containing the back of the document. Not every
1724
- * document has a reverse side.
1725
- */
1726
- back_file_id?: string;
1727
- /**
1728
- * The document's expiration date in YYYY-MM-DD format.
1729
- */
1730
- expiration_date?: string;
1731
- }
1732
- /**
1733
- * Information about the passport used for identification. Required if `method` is
1734
- * equal to `passport`.
1735
- */
1736
- interface Passport {
1737
- /**
1738
- * The country that issued the passport.
1739
- */
1740
- country: string;
1741
- /**
1742
- * The passport's expiration date in YYYY-MM-DD format.
1743
- */
1744
- expiration_date: string;
1745
- /**
1746
- * The identifier of the File containing the passport.
1747
- */
1748
- file_id: string;
1749
- }
1750
- }
1751
1760
  }
1752
- }
1753
- }
1754
- export interface EntityListParams extends PageParams {
1755
- created_at?: EntityListParams.CreatedAt;
1756
- }
1757
- export declare namespace EntityListParams {
1758
- interface CreatedAt {
1759
- /**
1760
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1761
- * timestamp.
1762
- */
1763
- after?: string;
1764
- /**
1765
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1766
- * timestamp.
1767
- */
1768
- before?: string;
1769
- /**
1770
- * Return results on or after this
1771
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1772
- */
1773
- on_or_after?: string;
1774
- /**
1775
- * Return results on or before this
1776
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1777
- */
1778
- on_or_before?: string;
1779
- }
1780
- }
1781
- export interface EntityUpdateAddressParams {
1782
- /**
1783
- * The entity's physical address. Post Office Boxes are disallowed.
1784
- */
1785
- address: EntityUpdateAddressParams.Address;
1786
- }
1787
- export declare namespace EntityUpdateAddressParams {
1788
- /**
1789
- * The entity's physical address. Post Office Boxes are disallowed.
1790
- */
1791
- interface Address {
1792
- /**
1793
- * The city of the address.
1794
- */
1795
- city: string;
1796
- /**
1797
- * The first line of the address. This is usually the street number and street.
1798
- */
1799
- line1: string;
1800
- /**
1801
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1802
- * the address.
1803
- */
1804
- state: string;
1805
- /**
1806
- * The ZIP code of the address.
1807
- */
1808
- zip: string;
1809
- /**
1810
- * The second line of the address. This might be the floor or room number.
1811
- */
1812
- line2?: string;
1813
- }
1814
1761
  }
1815
1762
  export declare namespace Entities {
1816
- export import Entity = API.Entity;
1817
- type EntitiesPage = _EntitiesPage;
1818
- export import EntityCreateParams = API.EntityCreateParams;
1819
- export import EntityListParams = API.EntityListParams;
1820
- export import EntityUpdateAddressParams = API.EntityUpdateAddressParams;
1821
- export import BeneficialOwners = API.BeneficialOwners;
1822
- export import BeneficialOwnerCreateParams = API.BeneficialOwnerCreateParams;
1823
- export import BeneficialOwnerArchiveParams = API.BeneficialOwnerArchiveParams;
1824
- export import BeneficialOwnerUpdateAddressParams = API.BeneficialOwnerUpdateAddressParams;
1825
- export import SupplementalDocuments = API.SupplementalDocuments;
1826
- export import SupplementalDocument = API.SupplementalDocument;
1827
- export import SupplementalDocumentsPage = API.SupplementalDocumentsPage;
1828
- export import SupplementalDocumentCreateParams = API.SupplementalDocumentCreateParams;
1829
- export import SupplementalDocumentListParams = API.SupplementalDocumentListParams;
1763
+ export import Entity = API.Entity;
1764
+ type EntitiesPage = _EntitiesPage;
1765
+ export import EntityCreateParams = API.EntityCreateParams;
1766
+ export import EntityListParams = API.EntityListParams;
1767
+ export import EntityUpdateAddressParams = API.EntityUpdateAddressParams;
1768
+ export import BeneficialOwners = API.BeneficialOwners;
1769
+ export import BeneficialOwnerCreateParams = API.BeneficialOwnerCreateParams;
1770
+ export import BeneficialOwnerArchiveParams = API.BeneficialOwnerArchiveParams;
1771
+ export import BeneficialOwnerUpdateAddressParams = API.BeneficialOwnerUpdateAddressParams;
1772
+ export import SupplementalDocuments = API.SupplementalDocuments;
1773
+ export import SupplementalDocument = API.SupplementalDocument;
1774
+ export import SupplementalDocumentsPage = API.SupplementalDocumentsPage;
1775
+ export import SupplementalDocumentCreateParams = API.SupplementalDocumentCreateParams;
1776
+ export import SupplementalDocumentListParams = API.SupplementalDocumentListParams;
1830
1777
  }
1831
1778
  export {};
1832
- //# sourceMappingURL=entities.d.ts.map
1779
+ //# sourceMappingURL=entities.d.ts.map