@augustusbank/typescript-sdk 0.17.0 → 0.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/client.d.mts +3 -0
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +3 -0
  5. package/client.d.ts.map +1 -1
  6. package/client.js +3 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +3 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/account-holders.d.mts +749 -0
  12. package/resources/account-holders.d.mts.map +1 -0
  13. package/resources/account-holders.d.ts +749 -0
  14. package/resources/account-holders.d.ts.map +1 -0
  15. package/resources/account-holders.js +32 -0
  16. package/resources/account-holders.js.map +1 -0
  17. package/resources/account-holders.mjs +28 -0
  18. package/resources/account-holders.mjs.map +1 -0
  19. package/resources/api-keys.d.mts +1 -1
  20. package/resources/api-keys.d.mts.map +1 -1
  21. package/resources/api-keys.d.ts +1 -1
  22. package/resources/api-keys.d.ts.map +1 -1
  23. package/resources/index.d.mts +1 -0
  24. package/resources/index.d.mts.map +1 -1
  25. package/resources/index.d.ts +1 -0
  26. package/resources/index.d.ts.map +1 -1
  27. package/resources/index.js +3 -1
  28. package/resources/index.js.map +1 -1
  29. package/resources/index.mjs +1 -0
  30. package/resources/index.mjs.map +1 -1
  31. package/resources/scopes.d.mts +1 -1
  32. package/resources/scopes.d.mts.map +1 -1
  33. package/resources/scopes.d.ts +1 -1
  34. package/resources/scopes.d.ts.map +1 -1
  35. package/src/client.ts +21 -0
  36. package/src/resources/account-holders.ts +3960 -0
  37. package/src/resources/api-keys.ts +2 -0
  38. package/src/resources/index.ts +9 -0
  39. package/src/resources/scopes.ts +2 -0
  40. package/src/version.ts +1 -1
  41. package/version.d.mts +1 -1
  42. package/version.d.ts +1 -1
  43. package/version.js +1 -1
  44. package/version.mjs +1 -1
@@ -0,0 +1,3960 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../core/resource';
4
+ import { APIPromise } from '../core/api-promise';
5
+ import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
6
+ import { RequestOptions } from '../internal/request-options';
7
+ import { path } from '../internal/utils/path';
8
+
9
+ export class AccountHolders extends APIResource {
10
+ /**
11
+ * Creates a new account holder and starts asynchronous processing.
12
+ */
13
+ create(body: AccountHolderCreateParams, options?: RequestOptions): APIPromise<AccountHolderCreateResponse> {
14
+ return this._client.post('/v1/account_holders', { body, ...options });
15
+ }
16
+
17
+ /**
18
+ * Retrieves an account holder by ID.
19
+ */
20
+ retrieve(id: string, options?: RequestOptions): APIPromise<AccountHolderRetrieveResponse> {
21
+ return this._client.get(path`/v1/account_holders/${id}`, options);
22
+ }
23
+
24
+ /**
25
+ * Lists account holders for the merchant with cursor-based pagination.
26
+ */
27
+ list(
28
+ query: AccountHolderListParams | null | undefined = {},
29
+ options?: RequestOptions,
30
+ ): PagePromise<AccountHolderListResponsesCursorPage, AccountHolderListResponse> {
31
+ return this._client.getAPIList('/v1/account_holders', CursorPage<AccountHolderListResponse>, {
32
+ query,
33
+ ...options,
34
+ });
35
+ }
36
+ }
37
+
38
+ export type AccountHolderListResponsesCursorPage = CursorPage<AccountHolderListResponse>;
39
+
40
+ export interface AccountHolderCreateResponse {
41
+ /**
42
+ * Unique identifier of the account holder.
43
+ */
44
+ id: string;
45
+
46
+ /**
47
+ * Beneficiary details used to create this account holder.
48
+ */
49
+ beneficiary_data:
50
+ | AccountHolderCreateResponse.UsBeneficiaryDataResponse
51
+ | AccountHolderCreateResponse.NonUsBeneficiaryDataResponse;
52
+
53
+ /**
54
+ * ISO 8601 UTC timestamp when the account holder was created.
55
+ */
56
+ created_at: string;
57
+
58
+ /**
59
+ * Current account holder status.
60
+ */
61
+ status: 'pending' | 'active' | 'closed';
62
+
63
+ /**
64
+ * Resource type discriminator.
65
+ */
66
+ type: 'account_holder';
67
+ }
68
+
69
+ export namespace AccountHolderCreateResponse {
70
+ export interface UsBeneficiaryDataResponse {
71
+ /**
72
+ * ISO 3166-1 alpha-2 country code of citizenship.
73
+ */
74
+ country_of_citizenship: 'US';
75
+
76
+ /**
77
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
78
+ */
79
+ date_of_birth: string;
80
+
81
+ /**
82
+ * Government-issued identification with type: "ssn" (Social Security Number,
83
+ * format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
84
+ */
85
+ identification:
86
+ | UsBeneficiaryDataResponse.SsnIdentification
87
+ | UsBeneficiaryDataResponse.ItinIdentification;
88
+
89
+ /**
90
+ * Full legal name of the account holder.
91
+ */
92
+ legal_name: string;
93
+
94
+ /**
95
+ * Residential address of the account holder.
96
+ */
97
+ residential_address:
98
+ | UsBeneficiaryDataResponse.UsResidentialAddressResponse
99
+ | UsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
100
+ }
101
+
102
+ export namespace UsBeneficiaryDataResponse {
103
+ export interface SsnIdentification {
104
+ type: 'ssn';
105
+
106
+ value: string;
107
+ }
108
+
109
+ export interface ItinIdentification {
110
+ type: 'itin';
111
+
112
+ value: string;
113
+ }
114
+
115
+ export interface UsResidentialAddressResponse {
116
+ /**
117
+ * City name.
118
+ */
119
+ city: string;
120
+
121
+ /**
122
+ * ISO 3166-1 alpha-2 country code.
123
+ */
124
+ country: 'US';
125
+
126
+ /**
127
+ * Postal or ZIP code.
128
+ */
129
+ postal_code: string;
130
+
131
+ /**
132
+ * Two-letter state code.
133
+ */
134
+ state: string;
135
+
136
+ /**
137
+ * Primary street address.
138
+ */
139
+ street_line_1: string;
140
+
141
+ /**
142
+ * Secondary street address (apartment, suite, etc.).
143
+ */
144
+ street_line_2: string | null;
145
+ }
146
+
147
+ export interface NonUsResidentialAddressResponse {
148
+ /**
149
+ * City name.
150
+ */
151
+ city: string;
152
+
153
+ /**
154
+ * ISO 3166-1 alpha-2 country code.
155
+ */
156
+ country:
157
+ | 'AF'
158
+ | 'AL'
159
+ | 'DZ'
160
+ | 'AS'
161
+ | 'AD'
162
+ | 'AO'
163
+ | 'AI'
164
+ | 'AQ'
165
+ | 'AG'
166
+ | 'AR'
167
+ | 'AM'
168
+ | 'AW'
169
+ | 'AU'
170
+ | 'AT'
171
+ | 'AZ'
172
+ | 'BS'
173
+ | 'BH'
174
+ | 'BD'
175
+ | 'BB'
176
+ | 'BY'
177
+ | 'BE'
178
+ | 'BZ'
179
+ | 'BJ'
180
+ | 'BM'
181
+ | 'BT'
182
+ | 'BO'
183
+ | 'BA'
184
+ | 'BW'
185
+ | 'BV'
186
+ | 'BR'
187
+ | 'IO'
188
+ | 'BN'
189
+ | 'BG'
190
+ | 'BF'
191
+ | 'BI'
192
+ | 'KH'
193
+ | 'CM'
194
+ | 'CA'
195
+ | 'CV'
196
+ | 'KY'
197
+ | 'CF'
198
+ | 'TD'
199
+ | 'CL'
200
+ | 'CN'
201
+ | 'CX'
202
+ | 'CC'
203
+ | 'CO'
204
+ | 'KM'
205
+ | 'CG'
206
+ | 'CD'
207
+ | 'CK'
208
+ | 'CR'
209
+ | 'CI'
210
+ | 'HR'
211
+ | 'CU'
212
+ | 'CY'
213
+ | 'CZ'
214
+ | 'DK'
215
+ | 'DJ'
216
+ | 'DM'
217
+ | 'DO'
218
+ | 'EC'
219
+ | 'EG'
220
+ | 'SV'
221
+ | 'GQ'
222
+ | 'ER'
223
+ | 'EE'
224
+ | 'ET'
225
+ | 'FK'
226
+ | 'FO'
227
+ | 'FJ'
228
+ | 'FI'
229
+ | 'FR'
230
+ | 'GF'
231
+ | 'PF'
232
+ | 'TF'
233
+ | 'GA'
234
+ | 'GM'
235
+ | 'GE'
236
+ | 'DE'
237
+ | 'GH'
238
+ | 'GI'
239
+ | 'GR'
240
+ | 'GL'
241
+ | 'GD'
242
+ | 'GP'
243
+ | 'GU'
244
+ | 'GT'
245
+ | 'GN'
246
+ | 'GW'
247
+ | 'GY'
248
+ | 'HT'
249
+ | 'HM'
250
+ | 'VA'
251
+ | 'HN'
252
+ | 'HK'
253
+ | 'HU'
254
+ | 'IS'
255
+ | 'IN'
256
+ | 'ID'
257
+ | 'IR'
258
+ | 'IQ'
259
+ | 'IE'
260
+ | 'IL'
261
+ | 'IT'
262
+ | 'JM'
263
+ | 'JP'
264
+ | 'JO'
265
+ | 'KZ'
266
+ | 'KE'
267
+ | 'KI'
268
+ | 'KP'
269
+ | 'KR'
270
+ | 'KW'
271
+ | 'KG'
272
+ | 'LA'
273
+ | 'LV'
274
+ | 'LB'
275
+ | 'LS'
276
+ | 'LR'
277
+ | 'LY'
278
+ | 'LI'
279
+ | 'LT'
280
+ | 'LU'
281
+ | 'MO'
282
+ | 'MG'
283
+ | 'MW'
284
+ | 'MY'
285
+ | 'MV'
286
+ | 'ML'
287
+ | 'MT'
288
+ | 'MH'
289
+ | 'MQ'
290
+ | 'MR'
291
+ | 'MU'
292
+ | 'YT'
293
+ | 'MX'
294
+ | 'FM'
295
+ | 'MD'
296
+ | 'MC'
297
+ | 'MN'
298
+ | 'MS'
299
+ | 'MA'
300
+ | 'MZ'
301
+ | 'MM'
302
+ | 'NA'
303
+ | 'NR'
304
+ | 'NP'
305
+ | 'NL'
306
+ | 'NC'
307
+ | 'NZ'
308
+ | 'NI'
309
+ | 'NE'
310
+ | 'NG'
311
+ | 'NU'
312
+ | 'NF'
313
+ | 'MP'
314
+ | 'MK'
315
+ | 'NO'
316
+ | 'OM'
317
+ | 'PK'
318
+ | 'PW'
319
+ | 'PS'
320
+ | 'PA'
321
+ | 'PG'
322
+ | 'PY'
323
+ | 'PE'
324
+ | 'PH'
325
+ | 'PN'
326
+ | 'PL'
327
+ | 'PT'
328
+ | 'PR'
329
+ | 'QA'
330
+ | 'RE'
331
+ | 'RO'
332
+ | 'RU'
333
+ | 'RW'
334
+ | 'SH'
335
+ | 'KN'
336
+ | 'LC'
337
+ | 'PM'
338
+ | 'VC'
339
+ | 'WS'
340
+ | 'SM'
341
+ | 'ST'
342
+ | 'SA'
343
+ | 'SN'
344
+ | 'SC'
345
+ | 'SL'
346
+ | 'SG'
347
+ | 'SK'
348
+ | 'SI'
349
+ | 'SB'
350
+ | 'SO'
351
+ | 'ZA'
352
+ | 'GS'
353
+ | 'ES'
354
+ | 'LK'
355
+ | 'SD'
356
+ | 'SR'
357
+ | 'SJ'
358
+ | 'SZ'
359
+ | 'SE'
360
+ | 'CH'
361
+ | 'SY'
362
+ | 'TW'
363
+ | 'TJ'
364
+ | 'TZ'
365
+ | 'TH'
366
+ | 'TL'
367
+ | 'TG'
368
+ | 'TK'
369
+ | 'TO'
370
+ | 'TT'
371
+ | 'TN'
372
+ | 'TR'
373
+ | 'TM'
374
+ | 'TC'
375
+ | 'TV'
376
+ | 'UG'
377
+ | 'UA'
378
+ | 'AE'
379
+ | 'GB'
380
+ | 'UM'
381
+ | 'UY'
382
+ | 'UZ'
383
+ | 'VU'
384
+ | 'VE'
385
+ | 'VN'
386
+ | 'VG'
387
+ | 'VI'
388
+ | 'WF'
389
+ | 'EH'
390
+ | 'YE'
391
+ | 'ZM'
392
+ | 'ZW'
393
+ | 'AX'
394
+ | 'BQ'
395
+ | 'CW'
396
+ | 'GG'
397
+ | 'IM'
398
+ | 'JE'
399
+ | 'ME'
400
+ | 'BL'
401
+ | 'MF'
402
+ | 'RS'
403
+ | 'SX'
404
+ | 'SS'
405
+ | 'XK';
406
+
407
+ /**
408
+ * Postal or ZIP code.
409
+ */
410
+ postal_code: string;
411
+
412
+ /**
413
+ * Primary street address.
414
+ */
415
+ street_line_1: string;
416
+
417
+ /**
418
+ * Secondary street address (apartment, suite, etc.).
419
+ */
420
+ street_line_2: string | null;
421
+ }
422
+ }
423
+
424
+ export interface NonUsBeneficiaryDataResponse {
425
+ /**
426
+ * ISO 3166-1 alpha-2 country code of citizenship.
427
+ */
428
+ country_of_citizenship:
429
+ | 'AF'
430
+ | 'AL'
431
+ | 'DZ'
432
+ | 'AS'
433
+ | 'AD'
434
+ | 'AO'
435
+ | 'AI'
436
+ | 'AQ'
437
+ | 'AG'
438
+ | 'AR'
439
+ | 'AM'
440
+ | 'AW'
441
+ | 'AU'
442
+ | 'AT'
443
+ | 'AZ'
444
+ | 'BS'
445
+ | 'BH'
446
+ | 'BD'
447
+ | 'BB'
448
+ | 'BY'
449
+ | 'BE'
450
+ | 'BZ'
451
+ | 'BJ'
452
+ | 'BM'
453
+ | 'BT'
454
+ | 'BO'
455
+ | 'BA'
456
+ | 'BW'
457
+ | 'BV'
458
+ | 'BR'
459
+ | 'IO'
460
+ | 'BN'
461
+ | 'BG'
462
+ | 'BF'
463
+ | 'BI'
464
+ | 'KH'
465
+ | 'CM'
466
+ | 'CA'
467
+ | 'CV'
468
+ | 'KY'
469
+ | 'CF'
470
+ | 'TD'
471
+ | 'CL'
472
+ | 'CN'
473
+ | 'CX'
474
+ | 'CC'
475
+ | 'CO'
476
+ | 'KM'
477
+ | 'CG'
478
+ | 'CD'
479
+ | 'CK'
480
+ | 'CR'
481
+ | 'CI'
482
+ | 'HR'
483
+ | 'CU'
484
+ | 'CY'
485
+ | 'CZ'
486
+ | 'DK'
487
+ | 'DJ'
488
+ | 'DM'
489
+ | 'DO'
490
+ | 'EC'
491
+ | 'EG'
492
+ | 'SV'
493
+ | 'GQ'
494
+ | 'ER'
495
+ | 'EE'
496
+ | 'ET'
497
+ | 'FK'
498
+ | 'FO'
499
+ | 'FJ'
500
+ | 'FI'
501
+ | 'FR'
502
+ | 'GF'
503
+ | 'PF'
504
+ | 'TF'
505
+ | 'GA'
506
+ | 'GM'
507
+ | 'GE'
508
+ | 'DE'
509
+ | 'GH'
510
+ | 'GI'
511
+ | 'GR'
512
+ | 'GL'
513
+ | 'GD'
514
+ | 'GP'
515
+ | 'GU'
516
+ | 'GT'
517
+ | 'GN'
518
+ | 'GW'
519
+ | 'GY'
520
+ | 'HT'
521
+ | 'HM'
522
+ | 'VA'
523
+ | 'HN'
524
+ | 'HK'
525
+ | 'HU'
526
+ | 'IS'
527
+ | 'IN'
528
+ | 'ID'
529
+ | 'IR'
530
+ | 'IQ'
531
+ | 'IE'
532
+ | 'IL'
533
+ | 'IT'
534
+ | 'JM'
535
+ | 'JP'
536
+ | 'JO'
537
+ | 'KZ'
538
+ | 'KE'
539
+ | 'KI'
540
+ | 'KP'
541
+ | 'KR'
542
+ | 'KW'
543
+ | 'KG'
544
+ | 'LA'
545
+ | 'LV'
546
+ | 'LB'
547
+ | 'LS'
548
+ | 'LR'
549
+ | 'LY'
550
+ | 'LI'
551
+ | 'LT'
552
+ | 'LU'
553
+ | 'MO'
554
+ | 'MG'
555
+ | 'MW'
556
+ | 'MY'
557
+ | 'MV'
558
+ | 'ML'
559
+ | 'MT'
560
+ | 'MH'
561
+ | 'MQ'
562
+ | 'MR'
563
+ | 'MU'
564
+ | 'YT'
565
+ | 'MX'
566
+ | 'FM'
567
+ | 'MD'
568
+ | 'MC'
569
+ | 'MN'
570
+ | 'MS'
571
+ | 'MA'
572
+ | 'MZ'
573
+ | 'MM'
574
+ | 'NA'
575
+ | 'NR'
576
+ | 'NP'
577
+ | 'NL'
578
+ | 'NC'
579
+ | 'NZ'
580
+ | 'NI'
581
+ | 'NE'
582
+ | 'NG'
583
+ | 'NU'
584
+ | 'NF'
585
+ | 'MP'
586
+ | 'MK'
587
+ | 'NO'
588
+ | 'OM'
589
+ | 'PK'
590
+ | 'PW'
591
+ | 'PS'
592
+ | 'PA'
593
+ | 'PG'
594
+ | 'PY'
595
+ | 'PE'
596
+ | 'PH'
597
+ | 'PN'
598
+ | 'PL'
599
+ | 'PT'
600
+ | 'PR'
601
+ | 'QA'
602
+ | 'RE'
603
+ | 'RO'
604
+ | 'RU'
605
+ | 'RW'
606
+ | 'SH'
607
+ | 'KN'
608
+ | 'LC'
609
+ | 'PM'
610
+ | 'VC'
611
+ | 'WS'
612
+ | 'SM'
613
+ | 'ST'
614
+ | 'SA'
615
+ | 'SN'
616
+ | 'SC'
617
+ | 'SL'
618
+ | 'SG'
619
+ | 'SK'
620
+ | 'SI'
621
+ | 'SB'
622
+ | 'SO'
623
+ | 'ZA'
624
+ | 'GS'
625
+ | 'ES'
626
+ | 'LK'
627
+ | 'SD'
628
+ | 'SR'
629
+ | 'SJ'
630
+ | 'SZ'
631
+ | 'SE'
632
+ | 'CH'
633
+ | 'SY'
634
+ | 'TW'
635
+ | 'TJ'
636
+ | 'TZ'
637
+ | 'TH'
638
+ | 'TL'
639
+ | 'TG'
640
+ | 'TK'
641
+ | 'TO'
642
+ | 'TT'
643
+ | 'TN'
644
+ | 'TR'
645
+ | 'TM'
646
+ | 'TC'
647
+ | 'TV'
648
+ | 'UG'
649
+ | 'UA'
650
+ | 'AE'
651
+ | 'GB'
652
+ | 'UM'
653
+ | 'UY'
654
+ | 'UZ'
655
+ | 'VU'
656
+ | 'VE'
657
+ | 'VN'
658
+ | 'VG'
659
+ | 'VI'
660
+ | 'WF'
661
+ | 'EH'
662
+ | 'YE'
663
+ | 'ZM'
664
+ | 'ZW'
665
+ | 'AX'
666
+ | 'BQ'
667
+ | 'CW'
668
+ | 'GG'
669
+ | 'IM'
670
+ | 'JE'
671
+ | 'ME'
672
+ | 'BL'
673
+ | 'MF'
674
+ | 'RS'
675
+ | 'SX'
676
+ | 'SS'
677
+ | 'XK';
678
+
679
+ /**
680
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
681
+ */
682
+ date_of_birth: string;
683
+
684
+ /**
685
+ * Government-issued identification with type: "id" (generic government-issued ID).
686
+ */
687
+ identification: NonUsBeneficiaryDataResponse.Identification;
688
+
689
+ /**
690
+ * Full legal name of the account holder.
691
+ */
692
+ legal_name: string;
693
+
694
+ /**
695
+ * Residential address of the account holder.
696
+ */
697
+ residential_address:
698
+ | NonUsBeneficiaryDataResponse.UsResidentialAddressResponse
699
+ | NonUsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
700
+ }
701
+
702
+ export namespace NonUsBeneficiaryDataResponse {
703
+ /**
704
+ * Government-issued identification with type: "id" (generic government-issued ID).
705
+ */
706
+ export interface Identification {
707
+ type: 'id';
708
+
709
+ value: string;
710
+ }
711
+
712
+ export interface UsResidentialAddressResponse {
713
+ /**
714
+ * City name.
715
+ */
716
+ city: string;
717
+
718
+ /**
719
+ * ISO 3166-1 alpha-2 country code.
720
+ */
721
+ country: 'US';
722
+
723
+ /**
724
+ * Postal or ZIP code.
725
+ */
726
+ postal_code: string;
727
+
728
+ /**
729
+ * Two-letter state code.
730
+ */
731
+ state: string;
732
+
733
+ /**
734
+ * Primary street address.
735
+ */
736
+ street_line_1: string;
737
+
738
+ /**
739
+ * Secondary street address (apartment, suite, etc.).
740
+ */
741
+ street_line_2: string | null;
742
+ }
743
+
744
+ export interface NonUsResidentialAddressResponse {
745
+ /**
746
+ * City name.
747
+ */
748
+ city: string;
749
+
750
+ /**
751
+ * ISO 3166-1 alpha-2 country code.
752
+ */
753
+ country:
754
+ | 'AF'
755
+ | 'AL'
756
+ | 'DZ'
757
+ | 'AS'
758
+ | 'AD'
759
+ | 'AO'
760
+ | 'AI'
761
+ | 'AQ'
762
+ | 'AG'
763
+ | 'AR'
764
+ | 'AM'
765
+ | 'AW'
766
+ | 'AU'
767
+ | 'AT'
768
+ | 'AZ'
769
+ | 'BS'
770
+ | 'BH'
771
+ | 'BD'
772
+ | 'BB'
773
+ | 'BY'
774
+ | 'BE'
775
+ | 'BZ'
776
+ | 'BJ'
777
+ | 'BM'
778
+ | 'BT'
779
+ | 'BO'
780
+ | 'BA'
781
+ | 'BW'
782
+ | 'BV'
783
+ | 'BR'
784
+ | 'IO'
785
+ | 'BN'
786
+ | 'BG'
787
+ | 'BF'
788
+ | 'BI'
789
+ | 'KH'
790
+ | 'CM'
791
+ | 'CA'
792
+ | 'CV'
793
+ | 'KY'
794
+ | 'CF'
795
+ | 'TD'
796
+ | 'CL'
797
+ | 'CN'
798
+ | 'CX'
799
+ | 'CC'
800
+ | 'CO'
801
+ | 'KM'
802
+ | 'CG'
803
+ | 'CD'
804
+ | 'CK'
805
+ | 'CR'
806
+ | 'CI'
807
+ | 'HR'
808
+ | 'CU'
809
+ | 'CY'
810
+ | 'CZ'
811
+ | 'DK'
812
+ | 'DJ'
813
+ | 'DM'
814
+ | 'DO'
815
+ | 'EC'
816
+ | 'EG'
817
+ | 'SV'
818
+ | 'GQ'
819
+ | 'ER'
820
+ | 'EE'
821
+ | 'ET'
822
+ | 'FK'
823
+ | 'FO'
824
+ | 'FJ'
825
+ | 'FI'
826
+ | 'FR'
827
+ | 'GF'
828
+ | 'PF'
829
+ | 'TF'
830
+ | 'GA'
831
+ | 'GM'
832
+ | 'GE'
833
+ | 'DE'
834
+ | 'GH'
835
+ | 'GI'
836
+ | 'GR'
837
+ | 'GL'
838
+ | 'GD'
839
+ | 'GP'
840
+ | 'GU'
841
+ | 'GT'
842
+ | 'GN'
843
+ | 'GW'
844
+ | 'GY'
845
+ | 'HT'
846
+ | 'HM'
847
+ | 'VA'
848
+ | 'HN'
849
+ | 'HK'
850
+ | 'HU'
851
+ | 'IS'
852
+ | 'IN'
853
+ | 'ID'
854
+ | 'IR'
855
+ | 'IQ'
856
+ | 'IE'
857
+ | 'IL'
858
+ | 'IT'
859
+ | 'JM'
860
+ | 'JP'
861
+ | 'JO'
862
+ | 'KZ'
863
+ | 'KE'
864
+ | 'KI'
865
+ | 'KP'
866
+ | 'KR'
867
+ | 'KW'
868
+ | 'KG'
869
+ | 'LA'
870
+ | 'LV'
871
+ | 'LB'
872
+ | 'LS'
873
+ | 'LR'
874
+ | 'LY'
875
+ | 'LI'
876
+ | 'LT'
877
+ | 'LU'
878
+ | 'MO'
879
+ | 'MG'
880
+ | 'MW'
881
+ | 'MY'
882
+ | 'MV'
883
+ | 'ML'
884
+ | 'MT'
885
+ | 'MH'
886
+ | 'MQ'
887
+ | 'MR'
888
+ | 'MU'
889
+ | 'YT'
890
+ | 'MX'
891
+ | 'FM'
892
+ | 'MD'
893
+ | 'MC'
894
+ | 'MN'
895
+ | 'MS'
896
+ | 'MA'
897
+ | 'MZ'
898
+ | 'MM'
899
+ | 'NA'
900
+ | 'NR'
901
+ | 'NP'
902
+ | 'NL'
903
+ | 'NC'
904
+ | 'NZ'
905
+ | 'NI'
906
+ | 'NE'
907
+ | 'NG'
908
+ | 'NU'
909
+ | 'NF'
910
+ | 'MP'
911
+ | 'MK'
912
+ | 'NO'
913
+ | 'OM'
914
+ | 'PK'
915
+ | 'PW'
916
+ | 'PS'
917
+ | 'PA'
918
+ | 'PG'
919
+ | 'PY'
920
+ | 'PE'
921
+ | 'PH'
922
+ | 'PN'
923
+ | 'PL'
924
+ | 'PT'
925
+ | 'PR'
926
+ | 'QA'
927
+ | 'RE'
928
+ | 'RO'
929
+ | 'RU'
930
+ | 'RW'
931
+ | 'SH'
932
+ | 'KN'
933
+ | 'LC'
934
+ | 'PM'
935
+ | 'VC'
936
+ | 'WS'
937
+ | 'SM'
938
+ | 'ST'
939
+ | 'SA'
940
+ | 'SN'
941
+ | 'SC'
942
+ | 'SL'
943
+ | 'SG'
944
+ | 'SK'
945
+ | 'SI'
946
+ | 'SB'
947
+ | 'SO'
948
+ | 'ZA'
949
+ | 'GS'
950
+ | 'ES'
951
+ | 'LK'
952
+ | 'SD'
953
+ | 'SR'
954
+ | 'SJ'
955
+ | 'SZ'
956
+ | 'SE'
957
+ | 'CH'
958
+ | 'SY'
959
+ | 'TW'
960
+ | 'TJ'
961
+ | 'TZ'
962
+ | 'TH'
963
+ | 'TL'
964
+ | 'TG'
965
+ | 'TK'
966
+ | 'TO'
967
+ | 'TT'
968
+ | 'TN'
969
+ | 'TR'
970
+ | 'TM'
971
+ | 'TC'
972
+ | 'TV'
973
+ | 'UG'
974
+ | 'UA'
975
+ | 'AE'
976
+ | 'GB'
977
+ | 'UM'
978
+ | 'UY'
979
+ | 'UZ'
980
+ | 'VU'
981
+ | 'VE'
982
+ | 'VN'
983
+ | 'VG'
984
+ | 'VI'
985
+ | 'WF'
986
+ | 'EH'
987
+ | 'YE'
988
+ | 'ZM'
989
+ | 'ZW'
990
+ | 'AX'
991
+ | 'BQ'
992
+ | 'CW'
993
+ | 'GG'
994
+ | 'IM'
995
+ | 'JE'
996
+ | 'ME'
997
+ | 'BL'
998
+ | 'MF'
999
+ | 'RS'
1000
+ | 'SX'
1001
+ | 'SS'
1002
+ | 'XK';
1003
+
1004
+ /**
1005
+ * Postal or ZIP code.
1006
+ */
1007
+ postal_code: string;
1008
+
1009
+ /**
1010
+ * Primary street address.
1011
+ */
1012
+ street_line_1: string;
1013
+
1014
+ /**
1015
+ * Secondary street address (apartment, suite, etc.).
1016
+ */
1017
+ street_line_2: string | null;
1018
+ }
1019
+ }
1020
+ }
1021
+
1022
+ export interface AccountHolderRetrieveResponse {
1023
+ /**
1024
+ * Unique identifier of the account holder.
1025
+ */
1026
+ id: string;
1027
+
1028
+ /**
1029
+ * Beneficiary details used to create this account holder.
1030
+ */
1031
+ beneficiary_data:
1032
+ | AccountHolderRetrieveResponse.UsBeneficiaryDataResponse
1033
+ | AccountHolderRetrieveResponse.NonUsBeneficiaryDataResponse;
1034
+
1035
+ /**
1036
+ * ISO 8601 UTC timestamp when the account holder was created.
1037
+ */
1038
+ created_at: string;
1039
+
1040
+ /**
1041
+ * Current account holder status.
1042
+ */
1043
+ status: 'pending' | 'active' | 'closed';
1044
+
1045
+ /**
1046
+ * Resource type discriminator.
1047
+ */
1048
+ type: 'account_holder';
1049
+ }
1050
+
1051
+ export namespace AccountHolderRetrieveResponse {
1052
+ export interface UsBeneficiaryDataResponse {
1053
+ /**
1054
+ * ISO 3166-1 alpha-2 country code of citizenship.
1055
+ */
1056
+ country_of_citizenship: 'US';
1057
+
1058
+ /**
1059
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
1060
+ */
1061
+ date_of_birth: string;
1062
+
1063
+ /**
1064
+ * Government-issued identification with type: "ssn" (Social Security Number,
1065
+ * format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
1066
+ */
1067
+ identification:
1068
+ | UsBeneficiaryDataResponse.SsnIdentification
1069
+ | UsBeneficiaryDataResponse.ItinIdentification;
1070
+
1071
+ /**
1072
+ * Full legal name of the account holder.
1073
+ */
1074
+ legal_name: string;
1075
+
1076
+ /**
1077
+ * Residential address of the account holder.
1078
+ */
1079
+ residential_address:
1080
+ | UsBeneficiaryDataResponse.UsResidentialAddressResponse
1081
+ | UsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
1082
+ }
1083
+
1084
+ export namespace UsBeneficiaryDataResponse {
1085
+ export interface SsnIdentification {
1086
+ type: 'ssn';
1087
+
1088
+ value: string;
1089
+ }
1090
+
1091
+ export interface ItinIdentification {
1092
+ type: 'itin';
1093
+
1094
+ value: string;
1095
+ }
1096
+
1097
+ export interface UsResidentialAddressResponse {
1098
+ /**
1099
+ * City name.
1100
+ */
1101
+ city: string;
1102
+
1103
+ /**
1104
+ * ISO 3166-1 alpha-2 country code.
1105
+ */
1106
+ country: 'US';
1107
+
1108
+ /**
1109
+ * Postal or ZIP code.
1110
+ */
1111
+ postal_code: string;
1112
+
1113
+ /**
1114
+ * Two-letter state code.
1115
+ */
1116
+ state: string;
1117
+
1118
+ /**
1119
+ * Primary street address.
1120
+ */
1121
+ street_line_1: string;
1122
+
1123
+ /**
1124
+ * Secondary street address (apartment, suite, etc.).
1125
+ */
1126
+ street_line_2: string | null;
1127
+ }
1128
+
1129
+ export interface NonUsResidentialAddressResponse {
1130
+ /**
1131
+ * City name.
1132
+ */
1133
+ city: string;
1134
+
1135
+ /**
1136
+ * ISO 3166-1 alpha-2 country code.
1137
+ */
1138
+ country:
1139
+ | 'AF'
1140
+ | 'AL'
1141
+ | 'DZ'
1142
+ | 'AS'
1143
+ | 'AD'
1144
+ | 'AO'
1145
+ | 'AI'
1146
+ | 'AQ'
1147
+ | 'AG'
1148
+ | 'AR'
1149
+ | 'AM'
1150
+ | 'AW'
1151
+ | 'AU'
1152
+ | 'AT'
1153
+ | 'AZ'
1154
+ | 'BS'
1155
+ | 'BH'
1156
+ | 'BD'
1157
+ | 'BB'
1158
+ | 'BY'
1159
+ | 'BE'
1160
+ | 'BZ'
1161
+ | 'BJ'
1162
+ | 'BM'
1163
+ | 'BT'
1164
+ | 'BO'
1165
+ | 'BA'
1166
+ | 'BW'
1167
+ | 'BV'
1168
+ | 'BR'
1169
+ | 'IO'
1170
+ | 'BN'
1171
+ | 'BG'
1172
+ | 'BF'
1173
+ | 'BI'
1174
+ | 'KH'
1175
+ | 'CM'
1176
+ | 'CA'
1177
+ | 'CV'
1178
+ | 'KY'
1179
+ | 'CF'
1180
+ | 'TD'
1181
+ | 'CL'
1182
+ | 'CN'
1183
+ | 'CX'
1184
+ | 'CC'
1185
+ | 'CO'
1186
+ | 'KM'
1187
+ | 'CG'
1188
+ | 'CD'
1189
+ | 'CK'
1190
+ | 'CR'
1191
+ | 'CI'
1192
+ | 'HR'
1193
+ | 'CU'
1194
+ | 'CY'
1195
+ | 'CZ'
1196
+ | 'DK'
1197
+ | 'DJ'
1198
+ | 'DM'
1199
+ | 'DO'
1200
+ | 'EC'
1201
+ | 'EG'
1202
+ | 'SV'
1203
+ | 'GQ'
1204
+ | 'ER'
1205
+ | 'EE'
1206
+ | 'ET'
1207
+ | 'FK'
1208
+ | 'FO'
1209
+ | 'FJ'
1210
+ | 'FI'
1211
+ | 'FR'
1212
+ | 'GF'
1213
+ | 'PF'
1214
+ | 'TF'
1215
+ | 'GA'
1216
+ | 'GM'
1217
+ | 'GE'
1218
+ | 'DE'
1219
+ | 'GH'
1220
+ | 'GI'
1221
+ | 'GR'
1222
+ | 'GL'
1223
+ | 'GD'
1224
+ | 'GP'
1225
+ | 'GU'
1226
+ | 'GT'
1227
+ | 'GN'
1228
+ | 'GW'
1229
+ | 'GY'
1230
+ | 'HT'
1231
+ | 'HM'
1232
+ | 'VA'
1233
+ | 'HN'
1234
+ | 'HK'
1235
+ | 'HU'
1236
+ | 'IS'
1237
+ | 'IN'
1238
+ | 'ID'
1239
+ | 'IR'
1240
+ | 'IQ'
1241
+ | 'IE'
1242
+ | 'IL'
1243
+ | 'IT'
1244
+ | 'JM'
1245
+ | 'JP'
1246
+ | 'JO'
1247
+ | 'KZ'
1248
+ | 'KE'
1249
+ | 'KI'
1250
+ | 'KP'
1251
+ | 'KR'
1252
+ | 'KW'
1253
+ | 'KG'
1254
+ | 'LA'
1255
+ | 'LV'
1256
+ | 'LB'
1257
+ | 'LS'
1258
+ | 'LR'
1259
+ | 'LY'
1260
+ | 'LI'
1261
+ | 'LT'
1262
+ | 'LU'
1263
+ | 'MO'
1264
+ | 'MG'
1265
+ | 'MW'
1266
+ | 'MY'
1267
+ | 'MV'
1268
+ | 'ML'
1269
+ | 'MT'
1270
+ | 'MH'
1271
+ | 'MQ'
1272
+ | 'MR'
1273
+ | 'MU'
1274
+ | 'YT'
1275
+ | 'MX'
1276
+ | 'FM'
1277
+ | 'MD'
1278
+ | 'MC'
1279
+ | 'MN'
1280
+ | 'MS'
1281
+ | 'MA'
1282
+ | 'MZ'
1283
+ | 'MM'
1284
+ | 'NA'
1285
+ | 'NR'
1286
+ | 'NP'
1287
+ | 'NL'
1288
+ | 'NC'
1289
+ | 'NZ'
1290
+ | 'NI'
1291
+ | 'NE'
1292
+ | 'NG'
1293
+ | 'NU'
1294
+ | 'NF'
1295
+ | 'MP'
1296
+ | 'MK'
1297
+ | 'NO'
1298
+ | 'OM'
1299
+ | 'PK'
1300
+ | 'PW'
1301
+ | 'PS'
1302
+ | 'PA'
1303
+ | 'PG'
1304
+ | 'PY'
1305
+ | 'PE'
1306
+ | 'PH'
1307
+ | 'PN'
1308
+ | 'PL'
1309
+ | 'PT'
1310
+ | 'PR'
1311
+ | 'QA'
1312
+ | 'RE'
1313
+ | 'RO'
1314
+ | 'RU'
1315
+ | 'RW'
1316
+ | 'SH'
1317
+ | 'KN'
1318
+ | 'LC'
1319
+ | 'PM'
1320
+ | 'VC'
1321
+ | 'WS'
1322
+ | 'SM'
1323
+ | 'ST'
1324
+ | 'SA'
1325
+ | 'SN'
1326
+ | 'SC'
1327
+ | 'SL'
1328
+ | 'SG'
1329
+ | 'SK'
1330
+ | 'SI'
1331
+ | 'SB'
1332
+ | 'SO'
1333
+ | 'ZA'
1334
+ | 'GS'
1335
+ | 'ES'
1336
+ | 'LK'
1337
+ | 'SD'
1338
+ | 'SR'
1339
+ | 'SJ'
1340
+ | 'SZ'
1341
+ | 'SE'
1342
+ | 'CH'
1343
+ | 'SY'
1344
+ | 'TW'
1345
+ | 'TJ'
1346
+ | 'TZ'
1347
+ | 'TH'
1348
+ | 'TL'
1349
+ | 'TG'
1350
+ | 'TK'
1351
+ | 'TO'
1352
+ | 'TT'
1353
+ | 'TN'
1354
+ | 'TR'
1355
+ | 'TM'
1356
+ | 'TC'
1357
+ | 'TV'
1358
+ | 'UG'
1359
+ | 'UA'
1360
+ | 'AE'
1361
+ | 'GB'
1362
+ | 'UM'
1363
+ | 'UY'
1364
+ | 'UZ'
1365
+ | 'VU'
1366
+ | 'VE'
1367
+ | 'VN'
1368
+ | 'VG'
1369
+ | 'VI'
1370
+ | 'WF'
1371
+ | 'EH'
1372
+ | 'YE'
1373
+ | 'ZM'
1374
+ | 'ZW'
1375
+ | 'AX'
1376
+ | 'BQ'
1377
+ | 'CW'
1378
+ | 'GG'
1379
+ | 'IM'
1380
+ | 'JE'
1381
+ | 'ME'
1382
+ | 'BL'
1383
+ | 'MF'
1384
+ | 'RS'
1385
+ | 'SX'
1386
+ | 'SS'
1387
+ | 'XK';
1388
+
1389
+ /**
1390
+ * Postal or ZIP code.
1391
+ */
1392
+ postal_code: string;
1393
+
1394
+ /**
1395
+ * Primary street address.
1396
+ */
1397
+ street_line_1: string;
1398
+
1399
+ /**
1400
+ * Secondary street address (apartment, suite, etc.).
1401
+ */
1402
+ street_line_2: string | null;
1403
+ }
1404
+ }
1405
+
1406
+ export interface NonUsBeneficiaryDataResponse {
1407
+ /**
1408
+ * ISO 3166-1 alpha-2 country code of citizenship.
1409
+ */
1410
+ country_of_citizenship:
1411
+ | 'AF'
1412
+ | 'AL'
1413
+ | 'DZ'
1414
+ | 'AS'
1415
+ | 'AD'
1416
+ | 'AO'
1417
+ | 'AI'
1418
+ | 'AQ'
1419
+ | 'AG'
1420
+ | 'AR'
1421
+ | 'AM'
1422
+ | 'AW'
1423
+ | 'AU'
1424
+ | 'AT'
1425
+ | 'AZ'
1426
+ | 'BS'
1427
+ | 'BH'
1428
+ | 'BD'
1429
+ | 'BB'
1430
+ | 'BY'
1431
+ | 'BE'
1432
+ | 'BZ'
1433
+ | 'BJ'
1434
+ | 'BM'
1435
+ | 'BT'
1436
+ | 'BO'
1437
+ | 'BA'
1438
+ | 'BW'
1439
+ | 'BV'
1440
+ | 'BR'
1441
+ | 'IO'
1442
+ | 'BN'
1443
+ | 'BG'
1444
+ | 'BF'
1445
+ | 'BI'
1446
+ | 'KH'
1447
+ | 'CM'
1448
+ | 'CA'
1449
+ | 'CV'
1450
+ | 'KY'
1451
+ | 'CF'
1452
+ | 'TD'
1453
+ | 'CL'
1454
+ | 'CN'
1455
+ | 'CX'
1456
+ | 'CC'
1457
+ | 'CO'
1458
+ | 'KM'
1459
+ | 'CG'
1460
+ | 'CD'
1461
+ | 'CK'
1462
+ | 'CR'
1463
+ | 'CI'
1464
+ | 'HR'
1465
+ | 'CU'
1466
+ | 'CY'
1467
+ | 'CZ'
1468
+ | 'DK'
1469
+ | 'DJ'
1470
+ | 'DM'
1471
+ | 'DO'
1472
+ | 'EC'
1473
+ | 'EG'
1474
+ | 'SV'
1475
+ | 'GQ'
1476
+ | 'ER'
1477
+ | 'EE'
1478
+ | 'ET'
1479
+ | 'FK'
1480
+ | 'FO'
1481
+ | 'FJ'
1482
+ | 'FI'
1483
+ | 'FR'
1484
+ | 'GF'
1485
+ | 'PF'
1486
+ | 'TF'
1487
+ | 'GA'
1488
+ | 'GM'
1489
+ | 'GE'
1490
+ | 'DE'
1491
+ | 'GH'
1492
+ | 'GI'
1493
+ | 'GR'
1494
+ | 'GL'
1495
+ | 'GD'
1496
+ | 'GP'
1497
+ | 'GU'
1498
+ | 'GT'
1499
+ | 'GN'
1500
+ | 'GW'
1501
+ | 'GY'
1502
+ | 'HT'
1503
+ | 'HM'
1504
+ | 'VA'
1505
+ | 'HN'
1506
+ | 'HK'
1507
+ | 'HU'
1508
+ | 'IS'
1509
+ | 'IN'
1510
+ | 'ID'
1511
+ | 'IR'
1512
+ | 'IQ'
1513
+ | 'IE'
1514
+ | 'IL'
1515
+ | 'IT'
1516
+ | 'JM'
1517
+ | 'JP'
1518
+ | 'JO'
1519
+ | 'KZ'
1520
+ | 'KE'
1521
+ | 'KI'
1522
+ | 'KP'
1523
+ | 'KR'
1524
+ | 'KW'
1525
+ | 'KG'
1526
+ | 'LA'
1527
+ | 'LV'
1528
+ | 'LB'
1529
+ | 'LS'
1530
+ | 'LR'
1531
+ | 'LY'
1532
+ | 'LI'
1533
+ | 'LT'
1534
+ | 'LU'
1535
+ | 'MO'
1536
+ | 'MG'
1537
+ | 'MW'
1538
+ | 'MY'
1539
+ | 'MV'
1540
+ | 'ML'
1541
+ | 'MT'
1542
+ | 'MH'
1543
+ | 'MQ'
1544
+ | 'MR'
1545
+ | 'MU'
1546
+ | 'YT'
1547
+ | 'MX'
1548
+ | 'FM'
1549
+ | 'MD'
1550
+ | 'MC'
1551
+ | 'MN'
1552
+ | 'MS'
1553
+ | 'MA'
1554
+ | 'MZ'
1555
+ | 'MM'
1556
+ | 'NA'
1557
+ | 'NR'
1558
+ | 'NP'
1559
+ | 'NL'
1560
+ | 'NC'
1561
+ | 'NZ'
1562
+ | 'NI'
1563
+ | 'NE'
1564
+ | 'NG'
1565
+ | 'NU'
1566
+ | 'NF'
1567
+ | 'MP'
1568
+ | 'MK'
1569
+ | 'NO'
1570
+ | 'OM'
1571
+ | 'PK'
1572
+ | 'PW'
1573
+ | 'PS'
1574
+ | 'PA'
1575
+ | 'PG'
1576
+ | 'PY'
1577
+ | 'PE'
1578
+ | 'PH'
1579
+ | 'PN'
1580
+ | 'PL'
1581
+ | 'PT'
1582
+ | 'PR'
1583
+ | 'QA'
1584
+ | 'RE'
1585
+ | 'RO'
1586
+ | 'RU'
1587
+ | 'RW'
1588
+ | 'SH'
1589
+ | 'KN'
1590
+ | 'LC'
1591
+ | 'PM'
1592
+ | 'VC'
1593
+ | 'WS'
1594
+ | 'SM'
1595
+ | 'ST'
1596
+ | 'SA'
1597
+ | 'SN'
1598
+ | 'SC'
1599
+ | 'SL'
1600
+ | 'SG'
1601
+ | 'SK'
1602
+ | 'SI'
1603
+ | 'SB'
1604
+ | 'SO'
1605
+ | 'ZA'
1606
+ | 'GS'
1607
+ | 'ES'
1608
+ | 'LK'
1609
+ | 'SD'
1610
+ | 'SR'
1611
+ | 'SJ'
1612
+ | 'SZ'
1613
+ | 'SE'
1614
+ | 'CH'
1615
+ | 'SY'
1616
+ | 'TW'
1617
+ | 'TJ'
1618
+ | 'TZ'
1619
+ | 'TH'
1620
+ | 'TL'
1621
+ | 'TG'
1622
+ | 'TK'
1623
+ | 'TO'
1624
+ | 'TT'
1625
+ | 'TN'
1626
+ | 'TR'
1627
+ | 'TM'
1628
+ | 'TC'
1629
+ | 'TV'
1630
+ | 'UG'
1631
+ | 'UA'
1632
+ | 'AE'
1633
+ | 'GB'
1634
+ | 'UM'
1635
+ | 'UY'
1636
+ | 'UZ'
1637
+ | 'VU'
1638
+ | 'VE'
1639
+ | 'VN'
1640
+ | 'VG'
1641
+ | 'VI'
1642
+ | 'WF'
1643
+ | 'EH'
1644
+ | 'YE'
1645
+ | 'ZM'
1646
+ | 'ZW'
1647
+ | 'AX'
1648
+ | 'BQ'
1649
+ | 'CW'
1650
+ | 'GG'
1651
+ | 'IM'
1652
+ | 'JE'
1653
+ | 'ME'
1654
+ | 'BL'
1655
+ | 'MF'
1656
+ | 'RS'
1657
+ | 'SX'
1658
+ | 'SS'
1659
+ | 'XK';
1660
+
1661
+ /**
1662
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
1663
+ */
1664
+ date_of_birth: string;
1665
+
1666
+ /**
1667
+ * Government-issued identification with type: "id" (generic government-issued ID).
1668
+ */
1669
+ identification: NonUsBeneficiaryDataResponse.Identification;
1670
+
1671
+ /**
1672
+ * Full legal name of the account holder.
1673
+ */
1674
+ legal_name: string;
1675
+
1676
+ /**
1677
+ * Residential address of the account holder.
1678
+ */
1679
+ residential_address:
1680
+ | NonUsBeneficiaryDataResponse.UsResidentialAddressResponse
1681
+ | NonUsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
1682
+ }
1683
+
1684
+ export namespace NonUsBeneficiaryDataResponse {
1685
+ /**
1686
+ * Government-issued identification with type: "id" (generic government-issued ID).
1687
+ */
1688
+ export interface Identification {
1689
+ type: 'id';
1690
+
1691
+ value: string;
1692
+ }
1693
+
1694
+ export interface UsResidentialAddressResponse {
1695
+ /**
1696
+ * City name.
1697
+ */
1698
+ city: string;
1699
+
1700
+ /**
1701
+ * ISO 3166-1 alpha-2 country code.
1702
+ */
1703
+ country: 'US';
1704
+
1705
+ /**
1706
+ * Postal or ZIP code.
1707
+ */
1708
+ postal_code: string;
1709
+
1710
+ /**
1711
+ * Two-letter state code.
1712
+ */
1713
+ state: string;
1714
+
1715
+ /**
1716
+ * Primary street address.
1717
+ */
1718
+ street_line_1: string;
1719
+
1720
+ /**
1721
+ * Secondary street address (apartment, suite, etc.).
1722
+ */
1723
+ street_line_2: string | null;
1724
+ }
1725
+
1726
+ export interface NonUsResidentialAddressResponse {
1727
+ /**
1728
+ * City name.
1729
+ */
1730
+ city: string;
1731
+
1732
+ /**
1733
+ * ISO 3166-1 alpha-2 country code.
1734
+ */
1735
+ country:
1736
+ | 'AF'
1737
+ | 'AL'
1738
+ | 'DZ'
1739
+ | 'AS'
1740
+ | 'AD'
1741
+ | 'AO'
1742
+ | 'AI'
1743
+ | 'AQ'
1744
+ | 'AG'
1745
+ | 'AR'
1746
+ | 'AM'
1747
+ | 'AW'
1748
+ | 'AU'
1749
+ | 'AT'
1750
+ | 'AZ'
1751
+ | 'BS'
1752
+ | 'BH'
1753
+ | 'BD'
1754
+ | 'BB'
1755
+ | 'BY'
1756
+ | 'BE'
1757
+ | 'BZ'
1758
+ | 'BJ'
1759
+ | 'BM'
1760
+ | 'BT'
1761
+ | 'BO'
1762
+ | 'BA'
1763
+ | 'BW'
1764
+ | 'BV'
1765
+ | 'BR'
1766
+ | 'IO'
1767
+ | 'BN'
1768
+ | 'BG'
1769
+ | 'BF'
1770
+ | 'BI'
1771
+ | 'KH'
1772
+ | 'CM'
1773
+ | 'CA'
1774
+ | 'CV'
1775
+ | 'KY'
1776
+ | 'CF'
1777
+ | 'TD'
1778
+ | 'CL'
1779
+ | 'CN'
1780
+ | 'CX'
1781
+ | 'CC'
1782
+ | 'CO'
1783
+ | 'KM'
1784
+ | 'CG'
1785
+ | 'CD'
1786
+ | 'CK'
1787
+ | 'CR'
1788
+ | 'CI'
1789
+ | 'HR'
1790
+ | 'CU'
1791
+ | 'CY'
1792
+ | 'CZ'
1793
+ | 'DK'
1794
+ | 'DJ'
1795
+ | 'DM'
1796
+ | 'DO'
1797
+ | 'EC'
1798
+ | 'EG'
1799
+ | 'SV'
1800
+ | 'GQ'
1801
+ | 'ER'
1802
+ | 'EE'
1803
+ | 'ET'
1804
+ | 'FK'
1805
+ | 'FO'
1806
+ | 'FJ'
1807
+ | 'FI'
1808
+ | 'FR'
1809
+ | 'GF'
1810
+ | 'PF'
1811
+ | 'TF'
1812
+ | 'GA'
1813
+ | 'GM'
1814
+ | 'GE'
1815
+ | 'DE'
1816
+ | 'GH'
1817
+ | 'GI'
1818
+ | 'GR'
1819
+ | 'GL'
1820
+ | 'GD'
1821
+ | 'GP'
1822
+ | 'GU'
1823
+ | 'GT'
1824
+ | 'GN'
1825
+ | 'GW'
1826
+ | 'GY'
1827
+ | 'HT'
1828
+ | 'HM'
1829
+ | 'VA'
1830
+ | 'HN'
1831
+ | 'HK'
1832
+ | 'HU'
1833
+ | 'IS'
1834
+ | 'IN'
1835
+ | 'ID'
1836
+ | 'IR'
1837
+ | 'IQ'
1838
+ | 'IE'
1839
+ | 'IL'
1840
+ | 'IT'
1841
+ | 'JM'
1842
+ | 'JP'
1843
+ | 'JO'
1844
+ | 'KZ'
1845
+ | 'KE'
1846
+ | 'KI'
1847
+ | 'KP'
1848
+ | 'KR'
1849
+ | 'KW'
1850
+ | 'KG'
1851
+ | 'LA'
1852
+ | 'LV'
1853
+ | 'LB'
1854
+ | 'LS'
1855
+ | 'LR'
1856
+ | 'LY'
1857
+ | 'LI'
1858
+ | 'LT'
1859
+ | 'LU'
1860
+ | 'MO'
1861
+ | 'MG'
1862
+ | 'MW'
1863
+ | 'MY'
1864
+ | 'MV'
1865
+ | 'ML'
1866
+ | 'MT'
1867
+ | 'MH'
1868
+ | 'MQ'
1869
+ | 'MR'
1870
+ | 'MU'
1871
+ | 'YT'
1872
+ | 'MX'
1873
+ | 'FM'
1874
+ | 'MD'
1875
+ | 'MC'
1876
+ | 'MN'
1877
+ | 'MS'
1878
+ | 'MA'
1879
+ | 'MZ'
1880
+ | 'MM'
1881
+ | 'NA'
1882
+ | 'NR'
1883
+ | 'NP'
1884
+ | 'NL'
1885
+ | 'NC'
1886
+ | 'NZ'
1887
+ | 'NI'
1888
+ | 'NE'
1889
+ | 'NG'
1890
+ | 'NU'
1891
+ | 'NF'
1892
+ | 'MP'
1893
+ | 'MK'
1894
+ | 'NO'
1895
+ | 'OM'
1896
+ | 'PK'
1897
+ | 'PW'
1898
+ | 'PS'
1899
+ | 'PA'
1900
+ | 'PG'
1901
+ | 'PY'
1902
+ | 'PE'
1903
+ | 'PH'
1904
+ | 'PN'
1905
+ | 'PL'
1906
+ | 'PT'
1907
+ | 'PR'
1908
+ | 'QA'
1909
+ | 'RE'
1910
+ | 'RO'
1911
+ | 'RU'
1912
+ | 'RW'
1913
+ | 'SH'
1914
+ | 'KN'
1915
+ | 'LC'
1916
+ | 'PM'
1917
+ | 'VC'
1918
+ | 'WS'
1919
+ | 'SM'
1920
+ | 'ST'
1921
+ | 'SA'
1922
+ | 'SN'
1923
+ | 'SC'
1924
+ | 'SL'
1925
+ | 'SG'
1926
+ | 'SK'
1927
+ | 'SI'
1928
+ | 'SB'
1929
+ | 'SO'
1930
+ | 'ZA'
1931
+ | 'GS'
1932
+ | 'ES'
1933
+ | 'LK'
1934
+ | 'SD'
1935
+ | 'SR'
1936
+ | 'SJ'
1937
+ | 'SZ'
1938
+ | 'SE'
1939
+ | 'CH'
1940
+ | 'SY'
1941
+ | 'TW'
1942
+ | 'TJ'
1943
+ | 'TZ'
1944
+ | 'TH'
1945
+ | 'TL'
1946
+ | 'TG'
1947
+ | 'TK'
1948
+ | 'TO'
1949
+ | 'TT'
1950
+ | 'TN'
1951
+ | 'TR'
1952
+ | 'TM'
1953
+ | 'TC'
1954
+ | 'TV'
1955
+ | 'UG'
1956
+ | 'UA'
1957
+ | 'AE'
1958
+ | 'GB'
1959
+ | 'UM'
1960
+ | 'UY'
1961
+ | 'UZ'
1962
+ | 'VU'
1963
+ | 'VE'
1964
+ | 'VN'
1965
+ | 'VG'
1966
+ | 'VI'
1967
+ | 'WF'
1968
+ | 'EH'
1969
+ | 'YE'
1970
+ | 'ZM'
1971
+ | 'ZW'
1972
+ | 'AX'
1973
+ | 'BQ'
1974
+ | 'CW'
1975
+ | 'GG'
1976
+ | 'IM'
1977
+ | 'JE'
1978
+ | 'ME'
1979
+ | 'BL'
1980
+ | 'MF'
1981
+ | 'RS'
1982
+ | 'SX'
1983
+ | 'SS'
1984
+ | 'XK';
1985
+
1986
+ /**
1987
+ * Postal or ZIP code.
1988
+ */
1989
+ postal_code: string;
1990
+
1991
+ /**
1992
+ * Primary street address.
1993
+ */
1994
+ street_line_1: string;
1995
+
1996
+ /**
1997
+ * Secondary street address (apartment, suite, etc.).
1998
+ */
1999
+ street_line_2: string | null;
2000
+ }
2001
+ }
2002
+ }
2003
+
2004
+ export interface AccountHolderListResponse {
2005
+ /**
2006
+ * Unique identifier of the account holder.
2007
+ */
2008
+ id: string;
2009
+
2010
+ /**
2011
+ * Beneficiary details used to create this account holder.
2012
+ */
2013
+ beneficiary_data:
2014
+ | AccountHolderListResponse.UsBeneficiaryDataResponse
2015
+ | AccountHolderListResponse.NonUsBeneficiaryDataResponse;
2016
+
2017
+ /**
2018
+ * ISO 8601 UTC timestamp when the account holder was created.
2019
+ */
2020
+ created_at: string;
2021
+
2022
+ /**
2023
+ * Current account holder status.
2024
+ */
2025
+ status: 'pending' | 'active' | 'closed';
2026
+
2027
+ /**
2028
+ * Resource type discriminator.
2029
+ */
2030
+ type: 'account_holder';
2031
+ }
2032
+
2033
+ export namespace AccountHolderListResponse {
2034
+ export interface UsBeneficiaryDataResponse {
2035
+ /**
2036
+ * ISO 3166-1 alpha-2 country code of citizenship.
2037
+ */
2038
+ country_of_citizenship: 'US';
2039
+
2040
+ /**
2041
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
2042
+ */
2043
+ date_of_birth: string;
2044
+
2045
+ /**
2046
+ * Government-issued identification with type: "ssn" (Social Security Number,
2047
+ * format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
2048
+ */
2049
+ identification:
2050
+ | UsBeneficiaryDataResponse.SsnIdentification
2051
+ | UsBeneficiaryDataResponse.ItinIdentification;
2052
+
2053
+ /**
2054
+ * Full legal name of the account holder.
2055
+ */
2056
+ legal_name: string;
2057
+
2058
+ /**
2059
+ * Residential address of the account holder.
2060
+ */
2061
+ residential_address:
2062
+ | UsBeneficiaryDataResponse.UsResidentialAddressResponse
2063
+ | UsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
2064
+ }
2065
+
2066
+ export namespace UsBeneficiaryDataResponse {
2067
+ export interface SsnIdentification {
2068
+ type: 'ssn';
2069
+
2070
+ value: string;
2071
+ }
2072
+
2073
+ export interface ItinIdentification {
2074
+ type: 'itin';
2075
+
2076
+ value: string;
2077
+ }
2078
+
2079
+ export interface UsResidentialAddressResponse {
2080
+ /**
2081
+ * City name.
2082
+ */
2083
+ city: string;
2084
+
2085
+ /**
2086
+ * ISO 3166-1 alpha-2 country code.
2087
+ */
2088
+ country: 'US';
2089
+
2090
+ /**
2091
+ * Postal or ZIP code.
2092
+ */
2093
+ postal_code: string;
2094
+
2095
+ /**
2096
+ * Two-letter state code.
2097
+ */
2098
+ state: string;
2099
+
2100
+ /**
2101
+ * Primary street address.
2102
+ */
2103
+ street_line_1: string;
2104
+
2105
+ /**
2106
+ * Secondary street address (apartment, suite, etc.).
2107
+ */
2108
+ street_line_2: string | null;
2109
+ }
2110
+
2111
+ export interface NonUsResidentialAddressResponse {
2112
+ /**
2113
+ * City name.
2114
+ */
2115
+ city: string;
2116
+
2117
+ /**
2118
+ * ISO 3166-1 alpha-2 country code.
2119
+ */
2120
+ country:
2121
+ | 'AF'
2122
+ | 'AL'
2123
+ | 'DZ'
2124
+ | 'AS'
2125
+ | 'AD'
2126
+ | 'AO'
2127
+ | 'AI'
2128
+ | 'AQ'
2129
+ | 'AG'
2130
+ | 'AR'
2131
+ | 'AM'
2132
+ | 'AW'
2133
+ | 'AU'
2134
+ | 'AT'
2135
+ | 'AZ'
2136
+ | 'BS'
2137
+ | 'BH'
2138
+ | 'BD'
2139
+ | 'BB'
2140
+ | 'BY'
2141
+ | 'BE'
2142
+ | 'BZ'
2143
+ | 'BJ'
2144
+ | 'BM'
2145
+ | 'BT'
2146
+ | 'BO'
2147
+ | 'BA'
2148
+ | 'BW'
2149
+ | 'BV'
2150
+ | 'BR'
2151
+ | 'IO'
2152
+ | 'BN'
2153
+ | 'BG'
2154
+ | 'BF'
2155
+ | 'BI'
2156
+ | 'KH'
2157
+ | 'CM'
2158
+ | 'CA'
2159
+ | 'CV'
2160
+ | 'KY'
2161
+ | 'CF'
2162
+ | 'TD'
2163
+ | 'CL'
2164
+ | 'CN'
2165
+ | 'CX'
2166
+ | 'CC'
2167
+ | 'CO'
2168
+ | 'KM'
2169
+ | 'CG'
2170
+ | 'CD'
2171
+ | 'CK'
2172
+ | 'CR'
2173
+ | 'CI'
2174
+ | 'HR'
2175
+ | 'CU'
2176
+ | 'CY'
2177
+ | 'CZ'
2178
+ | 'DK'
2179
+ | 'DJ'
2180
+ | 'DM'
2181
+ | 'DO'
2182
+ | 'EC'
2183
+ | 'EG'
2184
+ | 'SV'
2185
+ | 'GQ'
2186
+ | 'ER'
2187
+ | 'EE'
2188
+ | 'ET'
2189
+ | 'FK'
2190
+ | 'FO'
2191
+ | 'FJ'
2192
+ | 'FI'
2193
+ | 'FR'
2194
+ | 'GF'
2195
+ | 'PF'
2196
+ | 'TF'
2197
+ | 'GA'
2198
+ | 'GM'
2199
+ | 'GE'
2200
+ | 'DE'
2201
+ | 'GH'
2202
+ | 'GI'
2203
+ | 'GR'
2204
+ | 'GL'
2205
+ | 'GD'
2206
+ | 'GP'
2207
+ | 'GU'
2208
+ | 'GT'
2209
+ | 'GN'
2210
+ | 'GW'
2211
+ | 'GY'
2212
+ | 'HT'
2213
+ | 'HM'
2214
+ | 'VA'
2215
+ | 'HN'
2216
+ | 'HK'
2217
+ | 'HU'
2218
+ | 'IS'
2219
+ | 'IN'
2220
+ | 'ID'
2221
+ | 'IR'
2222
+ | 'IQ'
2223
+ | 'IE'
2224
+ | 'IL'
2225
+ | 'IT'
2226
+ | 'JM'
2227
+ | 'JP'
2228
+ | 'JO'
2229
+ | 'KZ'
2230
+ | 'KE'
2231
+ | 'KI'
2232
+ | 'KP'
2233
+ | 'KR'
2234
+ | 'KW'
2235
+ | 'KG'
2236
+ | 'LA'
2237
+ | 'LV'
2238
+ | 'LB'
2239
+ | 'LS'
2240
+ | 'LR'
2241
+ | 'LY'
2242
+ | 'LI'
2243
+ | 'LT'
2244
+ | 'LU'
2245
+ | 'MO'
2246
+ | 'MG'
2247
+ | 'MW'
2248
+ | 'MY'
2249
+ | 'MV'
2250
+ | 'ML'
2251
+ | 'MT'
2252
+ | 'MH'
2253
+ | 'MQ'
2254
+ | 'MR'
2255
+ | 'MU'
2256
+ | 'YT'
2257
+ | 'MX'
2258
+ | 'FM'
2259
+ | 'MD'
2260
+ | 'MC'
2261
+ | 'MN'
2262
+ | 'MS'
2263
+ | 'MA'
2264
+ | 'MZ'
2265
+ | 'MM'
2266
+ | 'NA'
2267
+ | 'NR'
2268
+ | 'NP'
2269
+ | 'NL'
2270
+ | 'NC'
2271
+ | 'NZ'
2272
+ | 'NI'
2273
+ | 'NE'
2274
+ | 'NG'
2275
+ | 'NU'
2276
+ | 'NF'
2277
+ | 'MP'
2278
+ | 'MK'
2279
+ | 'NO'
2280
+ | 'OM'
2281
+ | 'PK'
2282
+ | 'PW'
2283
+ | 'PS'
2284
+ | 'PA'
2285
+ | 'PG'
2286
+ | 'PY'
2287
+ | 'PE'
2288
+ | 'PH'
2289
+ | 'PN'
2290
+ | 'PL'
2291
+ | 'PT'
2292
+ | 'PR'
2293
+ | 'QA'
2294
+ | 'RE'
2295
+ | 'RO'
2296
+ | 'RU'
2297
+ | 'RW'
2298
+ | 'SH'
2299
+ | 'KN'
2300
+ | 'LC'
2301
+ | 'PM'
2302
+ | 'VC'
2303
+ | 'WS'
2304
+ | 'SM'
2305
+ | 'ST'
2306
+ | 'SA'
2307
+ | 'SN'
2308
+ | 'SC'
2309
+ | 'SL'
2310
+ | 'SG'
2311
+ | 'SK'
2312
+ | 'SI'
2313
+ | 'SB'
2314
+ | 'SO'
2315
+ | 'ZA'
2316
+ | 'GS'
2317
+ | 'ES'
2318
+ | 'LK'
2319
+ | 'SD'
2320
+ | 'SR'
2321
+ | 'SJ'
2322
+ | 'SZ'
2323
+ | 'SE'
2324
+ | 'CH'
2325
+ | 'SY'
2326
+ | 'TW'
2327
+ | 'TJ'
2328
+ | 'TZ'
2329
+ | 'TH'
2330
+ | 'TL'
2331
+ | 'TG'
2332
+ | 'TK'
2333
+ | 'TO'
2334
+ | 'TT'
2335
+ | 'TN'
2336
+ | 'TR'
2337
+ | 'TM'
2338
+ | 'TC'
2339
+ | 'TV'
2340
+ | 'UG'
2341
+ | 'UA'
2342
+ | 'AE'
2343
+ | 'GB'
2344
+ | 'UM'
2345
+ | 'UY'
2346
+ | 'UZ'
2347
+ | 'VU'
2348
+ | 'VE'
2349
+ | 'VN'
2350
+ | 'VG'
2351
+ | 'VI'
2352
+ | 'WF'
2353
+ | 'EH'
2354
+ | 'YE'
2355
+ | 'ZM'
2356
+ | 'ZW'
2357
+ | 'AX'
2358
+ | 'BQ'
2359
+ | 'CW'
2360
+ | 'GG'
2361
+ | 'IM'
2362
+ | 'JE'
2363
+ | 'ME'
2364
+ | 'BL'
2365
+ | 'MF'
2366
+ | 'RS'
2367
+ | 'SX'
2368
+ | 'SS'
2369
+ | 'XK';
2370
+
2371
+ /**
2372
+ * Postal or ZIP code.
2373
+ */
2374
+ postal_code: string;
2375
+
2376
+ /**
2377
+ * Primary street address.
2378
+ */
2379
+ street_line_1: string;
2380
+
2381
+ /**
2382
+ * Secondary street address (apartment, suite, etc.).
2383
+ */
2384
+ street_line_2: string | null;
2385
+ }
2386
+ }
2387
+
2388
+ export interface NonUsBeneficiaryDataResponse {
2389
+ /**
2390
+ * ISO 3166-1 alpha-2 country code of citizenship.
2391
+ */
2392
+ country_of_citizenship:
2393
+ | 'AF'
2394
+ | 'AL'
2395
+ | 'DZ'
2396
+ | 'AS'
2397
+ | 'AD'
2398
+ | 'AO'
2399
+ | 'AI'
2400
+ | 'AQ'
2401
+ | 'AG'
2402
+ | 'AR'
2403
+ | 'AM'
2404
+ | 'AW'
2405
+ | 'AU'
2406
+ | 'AT'
2407
+ | 'AZ'
2408
+ | 'BS'
2409
+ | 'BH'
2410
+ | 'BD'
2411
+ | 'BB'
2412
+ | 'BY'
2413
+ | 'BE'
2414
+ | 'BZ'
2415
+ | 'BJ'
2416
+ | 'BM'
2417
+ | 'BT'
2418
+ | 'BO'
2419
+ | 'BA'
2420
+ | 'BW'
2421
+ | 'BV'
2422
+ | 'BR'
2423
+ | 'IO'
2424
+ | 'BN'
2425
+ | 'BG'
2426
+ | 'BF'
2427
+ | 'BI'
2428
+ | 'KH'
2429
+ | 'CM'
2430
+ | 'CA'
2431
+ | 'CV'
2432
+ | 'KY'
2433
+ | 'CF'
2434
+ | 'TD'
2435
+ | 'CL'
2436
+ | 'CN'
2437
+ | 'CX'
2438
+ | 'CC'
2439
+ | 'CO'
2440
+ | 'KM'
2441
+ | 'CG'
2442
+ | 'CD'
2443
+ | 'CK'
2444
+ | 'CR'
2445
+ | 'CI'
2446
+ | 'HR'
2447
+ | 'CU'
2448
+ | 'CY'
2449
+ | 'CZ'
2450
+ | 'DK'
2451
+ | 'DJ'
2452
+ | 'DM'
2453
+ | 'DO'
2454
+ | 'EC'
2455
+ | 'EG'
2456
+ | 'SV'
2457
+ | 'GQ'
2458
+ | 'ER'
2459
+ | 'EE'
2460
+ | 'ET'
2461
+ | 'FK'
2462
+ | 'FO'
2463
+ | 'FJ'
2464
+ | 'FI'
2465
+ | 'FR'
2466
+ | 'GF'
2467
+ | 'PF'
2468
+ | 'TF'
2469
+ | 'GA'
2470
+ | 'GM'
2471
+ | 'GE'
2472
+ | 'DE'
2473
+ | 'GH'
2474
+ | 'GI'
2475
+ | 'GR'
2476
+ | 'GL'
2477
+ | 'GD'
2478
+ | 'GP'
2479
+ | 'GU'
2480
+ | 'GT'
2481
+ | 'GN'
2482
+ | 'GW'
2483
+ | 'GY'
2484
+ | 'HT'
2485
+ | 'HM'
2486
+ | 'VA'
2487
+ | 'HN'
2488
+ | 'HK'
2489
+ | 'HU'
2490
+ | 'IS'
2491
+ | 'IN'
2492
+ | 'ID'
2493
+ | 'IR'
2494
+ | 'IQ'
2495
+ | 'IE'
2496
+ | 'IL'
2497
+ | 'IT'
2498
+ | 'JM'
2499
+ | 'JP'
2500
+ | 'JO'
2501
+ | 'KZ'
2502
+ | 'KE'
2503
+ | 'KI'
2504
+ | 'KP'
2505
+ | 'KR'
2506
+ | 'KW'
2507
+ | 'KG'
2508
+ | 'LA'
2509
+ | 'LV'
2510
+ | 'LB'
2511
+ | 'LS'
2512
+ | 'LR'
2513
+ | 'LY'
2514
+ | 'LI'
2515
+ | 'LT'
2516
+ | 'LU'
2517
+ | 'MO'
2518
+ | 'MG'
2519
+ | 'MW'
2520
+ | 'MY'
2521
+ | 'MV'
2522
+ | 'ML'
2523
+ | 'MT'
2524
+ | 'MH'
2525
+ | 'MQ'
2526
+ | 'MR'
2527
+ | 'MU'
2528
+ | 'YT'
2529
+ | 'MX'
2530
+ | 'FM'
2531
+ | 'MD'
2532
+ | 'MC'
2533
+ | 'MN'
2534
+ | 'MS'
2535
+ | 'MA'
2536
+ | 'MZ'
2537
+ | 'MM'
2538
+ | 'NA'
2539
+ | 'NR'
2540
+ | 'NP'
2541
+ | 'NL'
2542
+ | 'NC'
2543
+ | 'NZ'
2544
+ | 'NI'
2545
+ | 'NE'
2546
+ | 'NG'
2547
+ | 'NU'
2548
+ | 'NF'
2549
+ | 'MP'
2550
+ | 'MK'
2551
+ | 'NO'
2552
+ | 'OM'
2553
+ | 'PK'
2554
+ | 'PW'
2555
+ | 'PS'
2556
+ | 'PA'
2557
+ | 'PG'
2558
+ | 'PY'
2559
+ | 'PE'
2560
+ | 'PH'
2561
+ | 'PN'
2562
+ | 'PL'
2563
+ | 'PT'
2564
+ | 'PR'
2565
+ | 'QA'
2566
+ | 'RE'
2567
+ | 'RO'
2568
+ | 'RU'
2569
+ | 'RW'
2570
+ | 'SH'
2571
+ | 'KN'
2572
+ | 'LC'
2573
+ | 'PM'
2574
+ | 'VC'
2575
+ | 'WS'
2576
+ | 'SM'
2577
+ | 'ST'
2578
+ | 'SA'
2579
+ | 'SN'
2580
+ | 'SC'
2581
+ | 'SL'
2582
+ | 'SG'
2583
+ | 'SK'
2584
+ | 'SI'
2585
+ | 'SB'
2586
+ | 'SO'
2587
+ | 'ZA'
2588
+ | 'GS'
2589
+ | 'ES'
2590
+ | 'LK'
2591
+ | 'SD'
2592
+ | 'SR'
2593
+ | 'SJ'
2594
+ | 'SZ'
2595
+ | 'SE'
2596
+ | 'CH'
2597
+ | 'SY'
2598
+ | 'TW'
2599
+ | 'TJ'
2600
+ | 'TZ'
2601
+ | 'TH'
2602
+ | 'TL'
2603
+ | 'TG'
2604
+ | 'TK'
2605
+ | 'TO'
2606
+ | 'TT'
2607
+ | 'TN'
2608
+ | 'TR'
2609
+ | 'TM'
2610
+ | 'TC'
2611
+ | 'TV'
2612
+ | 'UG'
2613
+ | 'UA'
2614
+ | 'AE'
2615
+ | 'GB'
2616
+ | 'UM'
2617
+ | 'UY'
2618
+ | 'UZ'
2619
+ | 'VU'
2620
+ | 'VE'
2621
+ | 'VN'
2622
+ | 'VG'
2623
+ | 'VI'
2624
+ | 'WF'
2625
+ | 'EH'
2626
+ | 'YE'
2627
+ | 'ZM'
2628
+ | 'ZW'
2629
+ | 'AX'
2630
+ | 'BQ'
2631
+ | 'CW'
2632
+ | 'GG'
2633
+ | 'IM'
2634
+ | 'JE'
2635
+ | 'ME'
2636
+ | 'BL'
2637
+ | 'MF'
2638
+ | 'RS'
2639
+ | 'SX'
2640
+ | 'SS'
2641
+ | 'XK';
2642
+
2643
+ /**
2644
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
2645
+ */
2646
+ date_of_birth: string;
2647
+
2648
+ /**
2649
+ * Government-issued identification with type: "id" (generic government-issued ID).
2650
+ */
2651
+ identification: NonUsBeneficiaryDataResponse.Identification;
2652
+
2653
+ /**
2654
+ * Full legal name of the account holder.
2655
+ */
2656
+ legal_name: string;
2657
+
2658
+ /**
2659
+ * Residential address of the account holder.
2660
+ */
2661
+ residential_address:
2662
+ | NonUsBeneficiaryDataResponse.UsResidentialAddressResponse
2663
+ | NonUsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
2664
+ }
2665
+
2666
+ export namespace NonUsBeneficiaryDataResponse {
2667
+ /**
2668
+ * Government-issued identification with type: "id" (generic government-issued ID).
2669
+ */
2670
+ export interface Identification {
2671
+ type: 'id';
2672
+
2673
+ value: string;
2674
+ }
2675
+
2676
+ export interface UsResidentialAddressResponse {
2677
+ /**
2678
+ * City name.
2679
+ */
2680
+ city: string;
2681
+
2682
+ /**
2683
+ * ISO 3166-1 alpha-2 country code.
2684
+ */
2685
+ country: 'US';
2686
+
2687
+ /**
2688
+ * Postal or ZIP code.
2689
+ */
2690
+ postal_code: string;
2691
+
2692
+ /**
2693
+ * Two-letter state code.
2694
+ */
2695
+ state: string;
2696
+
2697
+ /**
2698
+ * Primary street address.
2699
+ */
2700
+ street_line_1: string;
2701
+
2702
+ /**
2703
+ * Secondary street address (apartment, suite, etc.).
2704
+ */
2705
+ street_line_2: string | null;
2706
+ }
2707
+
2708
+ export interface NonUsResidentialAddressResponse {
2709
+ /**
2710
+ * City name.
2711
+ */
2712
+ city: string;
2713
+
2714
+ /**
2715
+ * ISO 3166-1 alpha-2 country code.
2716
+ */
2717
+ country:
2718
+ | 'AF'
2719
+ | 'AL'
2720
+ | 'DZ'
2721
+ | 'AS'
2722
+ | 'AD'
2723
+ | 'AO'
2724
+ | 'AI'
2725
+ | 'AQ'
2726
+ | 'AG'
2727
+ | 'AR'
2728
+ | 'AM'
2729
+ | 'AW'
2730
+ | 'AU'
2731
+ | 'AT'
2732
+ | 'AZ'
2733
+ | 'BS'
2734
+ | 'BH'
2735
+ | 'BD'
2736
+ | 'BB'
2737
+ | 'BY'
2738
+ | 'BE'
2739
+ | 'BZ'
2740
+ | 'BJ'
2741
+ | 'BM'
2742
+ | 'BT'
2743
+ | 'BO'
2744
+ | 'BA'
2745
+ | 'BW'
2746
+ | 'BV'
2747
+ | 'BR'
2748
+ | 'IO'
2749
+ | 'BN'
2750
+ | 'BG'
2751
+ | 'BF'
2752
+ | 'BI'
2753
+ | 'KH'
2754
+ | 'CM'
2755
+ | 'CA'
2756
+ | 'CV'
2757
+ | 'KY'
2758
+ | 'CF'
2759
+ | 'TD'
2760
+ | 'CL'
2761
+ | 'CN'
2762
+ | 'CX'
2763
+ | 'CC'
2764
+ | 'CO'
2765
+ | 'KM'
2766
+ | 'CG'
2767
+ | 'CD'
2768
+ | 'CK'
2769
+ | 'CR'
2770
+ | 'CI'
2771
+ | 'HR'
2772
+ | 'CU'
2773
+ | 'CY'
2774
+ | 'CZ'
2775
+ | 'DK'
2776
+ | 'DJ'
2777
+ | 'DM'
2778
+ | 'DO'
2779
+ | 'EC'
2780
+ | 'EG'
2781
+ | 'SV'
2782
+ | 'GQ'
2783
+ | 'ER'
2784
+ | 'EE'
2785
+ | 'ET'
2786
+ | 'FK'
2787
+ | 'FO'
2788
+ | 'FJ'
2789
+ | 'FI'
2790
+ | 'FR'
2791
+ | 'GF'
2792
+ | 'PF'
2793
+ | 'TF'
2794
+ | 'GA'
2795
+ | 'GM'
2796
+ | 'GE'
2797
+ | 'DE'
2798
+ | 'GH'
2799
+ | 'GI'
2800
+ | 'GR'
2801
+ | 'GL'
2802
+ | 'GD'
2803
+ | 'GP'
2804
+ | 'GU'
2805
+ | 'GT'
2806
+ | 'GN'
2807
+ | 'GW'
2808
+ | 'GY'
2809
+ | 'HT'
2810
+ | 'HM'
2811
+ | 'VA'
2812
+ | 'HN'
2813
+ | 'HK'
2814
+ | 'HU'
2815
+ | 'IS'
2816
+ | 'IN'
2817
+ | 'ID'
2818
+ | 'IR'
2819
+ | 'IQ'
2820
+ | 'IE'
2821
+ | 'IL'
2822
+ | 'IT'
2823
+ | 'JM'
2824
+ | 'JP'
2825
+ | 'JO'
2826
+ | 'KZ'
2827
+ | 'KE'
2828
+ | 'KI'
2829
+ | 'KP'
2830
+ | 'KR'
2831
+ | 'KW'
2832
+ | 'KG'
2833
+ | 'LA'
2834
+ | 'LV'
2835
+ | 'LB'
2836
+ | 'LS'
2837
+ | 'LR'
2838
+ | 'LY'
2839
+ | 'LI'
2840
+ | 'LT'
2841
+ | 'LU'
2842
+ | 'MO'
2843
+ | 'MG'
2844
+ | 'MW'
2845
+ | 'MY'
2846
+ | 'MV'
2847
+ | 'ML'
2848
+ | 'MT'
2849
+ | 'MH'
2850
+ | 'MQ'
2851
+ | 'MR'
2852
+ | 'MU'
2853
+ | 'YT'
2854
+ | 'MX'
2855
+ | 'FM'
2856
+ | 'MD'
2857
+ | 'MC'
2858
+ | 'MN'
2859
+ | 'MS'
2860
+ | 'MA'
2861
+ | 'MZ'
2862
+ | 'MM'
2863
+ | 'NA'
2864
+ | 'NR'
2865
+ | 'NP'
2866
+ | 'NL'
2867
+ | 'NC'
2868
+ | 'NZ'
2869
+ | 'NI'
2870
+ | 'NE'
2871
+ | 'NG'
2872
+ | 'NU'
2873
+ | 'NF'
2874
+ | 'MP'
2875
+ | 'MK'
2876
+ | 'NO'
2877
+ | 'OM'
2878
+ | 'PK'
2879
+ | 'PW'
2880
+ | 'PS'
2881
+ | 'PA'
2882
+ | 'PG'
2883
+ | 'PY'
2884
+ | 'PE'
2885
+ | 'PH'
2886
+ | 'PN'
2887
+ | 'PL'
2888
+ | 'PT'
2889
+ | 'PR'
2890
+ | 'QA'
2891
+ | 'RE'
2892
+ | 'RO'
2893
+ | 'RU'
2894
+ | 'RW'
2895
+ | 'SH'
2896
+ | 'KN'
2897
+ | 'LC'
2898
+ | 'PM'
2899
+ | 'VC'
2900
+ | 'WS'
2901
+ | 'SM'
2902
+ | 'ST'
2903
+ | 'SA'
2904
+ | 'SN'
2905
+ | 'SC'
2906
+ | 'SL'
2907
+ | 'SG'
2908
+ | 'SK'
2909
+ | 'SI'
2910
+ | 'SB'
2911
+ | 'SO'
2912
+ | 'ZA'
2913
+ | 'GS'
2914
+ | 'ES'
2915
+ | 'LK'
2916
+ | 'SD'
2917
+ | 'SR'
2918
+ | 'SJ'
2919
+ | 'SZ'
2920
+ | 'SE'
2921
+ | 'CH'
2922
+ | 'SY'
2923
+ | 'TW'
2924
+ | 'TJ'
2925
+ | 'TZ'
2926
+ | 'TH'
2927
+ | 'TL'
2928
+ | 'TG'
2929
+ | 'TK'
2930
+ | 'TO'
2931
+ | 'TT'
2932
+ | 'TN'
2933
+ | 'TR'
2934
+ | 'TM'
2935
+ | 'TC'
2936
+ | 'TV'
2937
+ | 'UG'
2938
+ | 'UA'
2939
+ | 'AE'
2940
+ | 'GB'
2941
+ | 'UM'
2942
+ | 'UY'
2943
+ | 'UZ'
2944
+ | 'VU'
2945
+ | 'VE'
2946
+ | 'VN'
2947
+ | 'VG'
2948
+ | 'VI'
2949
+ | 'WF'
2950
+ | 'EH'
2951
+ | 'YE'
2952
+ | 'ZM'
2953
+ | 'ZW'
2954
+ | 'AX'
2955
+ | 'BQ'
2956
+ | 'CW'
2957
+ | 'GG'
2958
+ | 'IM'
2959
+ | 'JE'
2960
+ | 'ME'
2961
+ | 'BL'
2962
+ | 'MF'
2963
+ | 'RS'
2964
+ | 'SX'
2965
+ | 'SS'
2966
+ | 'XK';
2967
+
2968
+ /**
2969
+ * Postal or ZIP code.
2970
+ */
2971
+ postal_code: string;
2972
+
2973
+ /**
2974
+ * Primary street address.
2975
+ */
2976
+ street_line_1: string;
2977
+
2978
+ /**
2979
+ * Secondary street address (apartment, suite, etc.).
2980
+ */
2981
+ street_line_2: string | null;
2982
+ }
2983
+ }
2984
+ }
2985
+
2986
+ export interface AccountHolderCreateParams {
2987
+ /**
2988
+ * ID of the account program to create the account holder under.
2989
+ */
2990
+ account_program_id: string;
2991
+
2992
+ /**
2993
+ * Personal information of the account holder.
2994
+ */
2995
+ beneficiary_data:
2996
+ | AccountHolderCreateParams.UsBeneficiaryData
2997
+ | AccountHolderCreateParams.NonUsBeneficiaryData;
2998
+ }
2999
+
3000
+ export namespace AccountHolderCreateParams {
3001
+ export interface UsBeneficiaryData {
3002
+ /**
3003
+ * ISO 3166-1 alpha-2 country code of citizenship.
3004
+ */
3005
+ country_of_citizenship: 'US';
3006
+
3007
+ /**
3008
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
3009
+ */
3010
+ date_of_birth: string;
3011
+
3012
+ /**
3013
+ * Government-issued identification with type: "ssn" (Social Security Number,
3014
+ * format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
3015
+ */
3016
+ identification: UsBeneficiaryData.SsnIdentification | UsBeneficiaryData.ItinIdentification;
3017
+
3018
+ /**
3019
+ * Full legal name of the account holder.
3020
+ */
3021
+ legal_name: string;
3022
+
3023
+ /**
3024
+ * Residential address of the account holder.
3025
+ */
3026
+ residential_address: UsBeneficiaryData.UsResidentialAddress | UsBeneficiaryData.NonUsResidentialAddress;
3027
+ }
3028
+
3029
+ export namespace UsBeneficiaryData {
3030
+ export interface SsnIdentification {
3031
+ type: 'ssn';
3032
+
3033
+ value: string;
3034
+ }
3035
+
3036
+ export interface ItinIdentification {
3037
+ type: 'itin';
3038
+
3039
+ value: string;
3040
+ }
3041
+
3042
+ export interface UsResidentialAddress {
3043
+ /**
3044
+ * City name.
3045
+ */
3046
+ city: string;
3047
+
3048
+ /**
3049
+ * ISO 3166-1 alpha-2 country code.
3050
+ */
3051
+ country: 'US';
3052
+
3053
+ /**
3054
+ * Postal or ZIP code.
3055
+ */
3056
+ postal_code: string;
3057
+
3058
+ /**
3059
+ * Two-letter state code.
3060
+ */
3061
+ state: string;
3062
+
3063
+ /**
3064
+ * Primary street address.
3065
+ */
3066
+ street_line_1: string;
3067
+
3068
+ /**
3069
+ * Secondary street address (apartment, suite, etc.).
3070
+ */
3071
+ street_line_2?: string;
3072
+ }
3073
+
3074
+ export interface NonUsResidentialAddress {
3075
+ /**
3076
+ * City name.
3077
+ */
3078
+ city: string;
3079
+
3080
+ /**
3081
+ * ISO 3166-1 alpha-2 country code.
3082
+ */
3083
+ country:
3084
+ | 'AF'
3085
+ | 'AL'
3086
+ | 'DZ'
3087
+ | 'AS'
3088
+ | 'AD'
3089
+ | 'AO'
3090
+ | 'AI'
3091
+ | 'AQ'
3092
+ | 'AG'
3093
+ | 'AR'
3094
+ | 'AM'
3095
+ | 'AW'
3096
+ | 'AU'
3097
+ | 'AT'
3098
+ | 'AZ'
3099
+ | 'BS'
3100
+ | 'BH'
3101
+ | 'BD'
3102
+ | 'BB'
3103
+ | 'BY'
3104
+ | 'BE'
3105
+ | 'BZ'
3106
+ | 'BJ'
3107
+ | 'BM'
3108
+ | 'BT'
3109
+ | 'BO'
3110
+ | 'BA'
3111
+ | 'BW'
3112
+ | 'BV'
3113
+ | 'BR'
3114
+ | 'IO'
3115
+ | 'BN'
3116
+ | 'BG'
3117
+ | 'BF'
3118
+ | 'BI'
3119
+ | 'KH'
3120
+ | 'CM'
3121
+ | 'CA'
3122
+ | 'CV'
3123
+ | 'KY'
3124
+ | 'CF'
3125
+ | 'TD'
3126
+ | 'CL'
3127
+ | 'CN'
3128
+ | 'CX'
3129
+ | 'CC'
3130
+ | 'CO'
3131
+ | 'KM'
3132
+ | 'CG'
3133
+ | 'CD'
3134
+ | 'CK'
3135
+ | 'CR'
3136
+ | 'CI'
3137
+ | 'HR'
3138
+ | 'CU'
3139
+ | 'CY'
3140
+ | 'CZ'
3141
+ | 'DK'
3142
+ | 'DJ'
3143
+ | 'DM'
3144
+ | 'DO'
3145
+ | 'EC'
3146
+ | 'EG'
3147
+ | 'SV'
3148
+ | 'GQ'
3149
+ | 'ER'
3150
+ | 'EE'
3151
+ | 'ET'
3152
+ | 'FK'
3153
+ | 'FO'
3154
+ | 'FJ'
3155
+ | 'FI'
3156
+ | 'FR'
3157
+ | 'GF'
3158
+ | 'PF'
3159
+ | 'TF'
3160
+ | 'GA'
3161
+ | 'GM'
3162
+ | 'GE'
3163
+ | 'DE'
3164
+ | 'GH'
3165
+ | 'GI'
3166
+ | 'GR'
3167
+ | 'GL'
3168
+ | 'GD'
3169
+ | 'GP'
3170
+ | 'GU'
3171
+ | 'GT'
3172
+ | 'GN'
3173
+ | 'GW'
3174
+ | 'GY'
3175
+ | 'HT'
3176
+ | 'HM'
3177
+ | 'VA'
3178
+ | 'HN'
3179
+ | 'HK'
3180
+ | 'HU'
3181
+ | 'IS'
3182
+ | 'IN'
3183
+ | 'ID'
3184
+ | 'IR'
3185
+ | 'IQ'
3186
+ | 'IE'
3187
+ | 'IL'
3188
+ | 'IT'
3189
+ | 'JM'
3190
+ | 'JP'
3191
+ | 'JO'
3192
+ | 'KZ'
3193
+ | 'KE'
3194
+ | 'KI'
3195
+ | 'KP'
3196
+ | 'KR'
3197
+ | 'KW'
3198
+ | 'KG'
3199
+ | 'LA'
3200
+ | 'LV'
3201
+ | 'LB'
3202
+ | 'LS'
3203
+ | 'LR'
3204
+ | 'LY'
3205
+ | 'LI'
3206
+ | 'LT'
3207
+ | 'LU'
3208
+ | 'MO'
3209
+ | 'MG'
3210
+ | 'MW'
3211
+ | 'MY'
3212
+ | 'MV'
3213
+ | 'ML'
3214
+ | 'MT'
3215
+ | 'MH'
3216
+ | 'MQ'
3217
+ | 'MR'
3218
+ | 'MU'
3219
+ | 'YT'
3220
+ | 'MX'
3221
+ | 'FM'
3222
+ | 'MD'
3223
+ | 'MC'
3224
+ | 'MN'
3225
+ | 'MS'
3226
+ | 'MA'
3227
+ | 'MZ'
3228
+ | 'MM'
3229
+ | 'NA'
3230
+ | 'NR'
3231
+ | 'NP'
3232
+ | 'NL'
3233
+ | 'NC'
3234
+ | 'NZ'
3235
+ | 'NI'
3236
+ | 'NE'
3237
+ | 'NG'
3238
+ | 'NU'
3239
+ | 'NF'
3240
+ | 'MP'
3241
+ | 'MK'
3242
+ | 'NO'
3243
+ | 'OM'
3244
+ | 'PK'
3245
+ | 'PW'
3246
+ | 'PS'
3247
+ | 'PA'
3248
+ | 'PG'
3249
+ | 'PY'
3250
+ | 'PE'
3251
+ | 'PH'
3252
+ | 'PN'
3253
+ | 'PL'
3254
+ | 'PT'
3255
+ | 'PR'
3256
+ | 'QA'
3257
+ | 'RE'
3258
+ | 'RO'
3259
+ | 'RU'
3260
+ | 'RW'
3261
+ | 'SH'
3262
+ | 'KN'
3263
+ | 'LC'
3264
+ | 'PM'
3265
+ | 'VC'
3266
+ | 'WS'
3267
+ | 'SM'
3268
+ | 'ST'
3269
+ | 'SA'
3270
+ | 'SN'
3271
+ | 'SC'
3272
+ | 'SL'
3273
+ | 'SG'
3274
+ | 'SK'
3275
+ | 'SI'
3276
+ | 'SB'
3277
+ | 'SO'
3278
+ | 'ZA'
3279
+ | 'GS'
3280
+ | 'ES'
3281
+ | 'LK'
3282
+ | 'SD'
3283
+ | 'SR'
3284
+ | 'SJ'
3285
+ | 'SZ'
3286
+ | 'SE'
3287
+ | 'CH'
3288
+ | 'SY'
3289
+ | 'TW'
3290
+ | 'TJ'
3291
+ | 'TZ'
3292
+ | 'TH'
3293
+ | 'TL'
3294
+ | 'TG'
3295
+ | 'TK'
3296
+ | 'TO'
3297
+ | 'TT'
3298
+ | 'TN'
3299
+ | 'TR'
3300
+ | 'TM'
3301
+ | 'TC'
3302
+ | 'TV'
3303
+ | 'UG'
3304
+ | 'UA'
3305
+ | 'AE'
3306
+ | 'GB'
3307
+ | 'UM'
3308
+ | 'UY'
3309
+ | 'UZ'
3310
+ | 'VU'
3311
+ | 'VE'
3312
+ | 'VN'
3313
+ | 'VG'
3314
+ | 'VI'
3315
+ | 'WF'
3316
+ | 'EH'
3317
+ | 'YE'
3318
+ | 'ZM'
3319
+ | 'ZW'
3320
+ | 'AX'
3321
+ | 'BQ'
3322
+ | 'CW'
3323
+ | 'GG'
3324
+ | 'IM'
3325
+ | 'JE'
3326
+ | 'ME'
3327
+ | 'BL'
3328
+ | 'MF'
3329
+ | 'RS'
3330
+ | 'SX'
3331
+ | 'SS'
3332
+ | 'XK';
3333
+
3334
+ /**
3335
+ * Postal or ZIP code.
3336
+ */
3337
+ postal_code: string;
3338
+
3339
+ /**
3340
+ * Primary street address.
3341
+ */
3342
+ street_line_1: string;
3343
+
3344
+ /**
3345
+ * Secondary street address (apartment, suite, etc.).
3346
+ */
3347
+ street_line_2?: string;
3348
+ }
3349
+ }
3350
+
3351
+ export interface NonUsBeneficiaryData {
3352
+ /**
3353
+ * ISO 3166-1 alpha-2 country code of citizenship.
3354
+ */
3355
+ country_of_citizenship:
3356
+ | 'AF'
3357
+ | 'AL'
3358
+ | 'DZ'
3359
+ | 'AS'
3360
+ | 'AD'
3361
+ | 'AO'
3362
+ | 'AI'
3363
+ | 'AQ'
3364
+ | 'AG'
3365
+ | 'AR'
3366
+ | 'AM'
3367
+ | 'AW'
3368
+ | 'AU'
3369
+ | 'AT'
3370
+ | 'AZ'
3371
+ | 'BS'
3372
+ | 'BH'
3373
+ | 'BD'
3374
+ | 'BB'
3375
+ | 'BY'
3376
+ | 'BE'
3377
+ | 'BZ'
3378
+ | 'BJ'
3379
+ | 'BM'
3380
+ | 'BT'
3381
+ | 'BO'
3382
+ | 'BA'
3383
+ | 'BW'
3384
+ | 'BV'
3385
+ | 'BR'
3386
+ | 'IO'
3387
+ | 'BN'
3388
+ | 'BG'
3389
+ | 'BF'
3390
+ | 'BI'
3391
+ | 'KH'
3392
+ | 'CM'
3393
+ | 'CA'
3394
+ | 'CV'
3395
+ | 'KY'
3396
+ | 'CF'
3397
+ | 'TD'
3398
+ | 'CL'
3399
+ | 'CN'
3400
+ | 'CX'
3401
+ | 'CC'
3402
+ | 'CO'
3403
+ | 'KM'
3404
+ | 'CG'
3405
+ | 'CD'
3406
+ | 'CK'
3407
+ | 'CR'
3408
+ | 'CI'
3409
+ | 'HR'
3410
+ | 'CU'
3411
+ | 'CY'
3412
+ | 'CZ'
3413
+ | 'DK'
3414
+ | 'DJ'
3415
+ | 'DM'
3416
+ | 'DO'
3417
+ | 'EC'
3418
+ | 'EG'
3419
+ | 'SV'
3420
+ | 'GQ'
3421
+ | 'ER'
3422
+ | 'EE'
3423
+ | 'ET'
3424
+ | 'FK'
3425
+ | 'FO'
3426
+ | 'FJ'
3427
+ | 'FI'
3428
+ | 'FR'
3429
+ | 'GF'
3430
+ | 'PF'
3431
+ | 'TF'
3432
+ | 'GA'
3433
+ | 'GM'
3434
+ | 'GE'
3435
+ | 'DE'
3436
+ | 'GH'
3437
+ | 'GI'
3438
+ | 'GR'
3439
+ | 'GL'
3440
+ | 'GD'
3441
+ | 'GP'
3442
+ | 'GU'
3443
+ | 'GT'
3444
+ | 'GN'
3445
+ | 'GW'
3446
+ | 'GY'
3447
+ | 'HT'
3448
+ | 'HM'
3449
+ | 'VA'
3450
+ | 'HN'
3451
+ | 'HK'
3452
+ | 'HU'
3453
+ | 'IS'
3454
+ | 'IN'
3455
+ | 'ID'
3456
+ | 'IR'
3457
+ | 'IQ'
3458
+ | 'IE'
3459
+ | 'IL'
3460
+ | 'IT'
3461
+ | 'JM'
3462
+ | 'JP'
3463
+ | 'JO'
3464
+ | 'KZ'
3465
+ | 'KE'
3466
+ | 'KI'
3467
+ | 'KP'
3468
+ | 'KR'
3469
+ | 'KW'
3470
+ | 'KG'
3471
+ | 'LA'
3472
+ | 'LV'
3473
+ | 'LB'
3474
+ | 'LS'
3475
+ | 'LR'
3476
+ | 'LY'
3477
+ | 'LI'
3478
+ | 'LT'
3479
+ | 'LU'
3480
+ | 'MO'
3481
+ | 'MG'
3482
+ | 'MW'
3483
+ | 'MY'
3484
+ | 'MV'
3485
+ | 'ML'
3486
+ | 'MT'
3487
+ | 'MH'
3488
+ | 'MQ'
3489
+ | 'MR'
3490
+ | 'MU'
3491
+ | 'YT'
3492
+ | 'MX'
3493
+ | 'FM'
3494
+ | 'MD'
3495
+ | 'MC'
3496
+ | 'MN'
3497
+ | 'MS'
3498
+ | 'MA'
3499
+ | 'MZ'
3500
+ | 'MM'
3501
+ | 'NA'
3502
+ | 'NR'
3503
+ | 'NP'
3504
+ | 'NL'
3505
+ | 'NC'
3506
+ | 'NZ'
3507
+ | 'NI'
3508
+ | 'NE'
3509
+ | 'NG'
3510
+ | 'NU'
3511
+ | 'NF'
3512
+ | 'MP'
3513
+ | 'MK'
3514
+ | 'NO'
3515
+ | 'OM'
3516
+ | 'PK'
3517
+ | 'PW'
3518
+ | 'PS'
3519
+ | 'PA'
3520
+ | 'PG'
3521
+ | 'PY'
3522
+ | 'PE'
3523
+ | 'PH'
3524
+ | 'PN'
3525
+ | 'PL'
3526
+ | 'PT'
3527
+ | 'PR'
3528
+ | 'QA'
3529
+ | 'RE'
3530
+ | 'RO'
3531
+ | 'RU'
3532
+ | 'RW'
3533
+ | 'SH'
3534
+ | 'KN'
3535
+ | 'LC'
3536
+ | 'PM'
3537
+ | 'VC'
3538
+ | 'WS'
3539
+ | 'SM'
3540
+ | 'ST'
3541
+ | 'SA'
3542
+ | 'SN'
3543
+ | 'SC'
3544
+ | 'SL'
3545
+ | 'SG'
3546
+ | 'SK'
3547
+ | 'SI'
3548
+ | 'SB'
3549
+ | 'SO'
3550
+ | 'ZA'
3551
+ | 'GS'
3552
+ | 'ES'
3553
+ | 'LK'
3554
+ | 'SD'
3555
+ | 'SR'
3556
+ | 'SJ'
3557
+ | 'SZ'
3558
+ | 'SE'
3559
+ | 'CH'
3560
+ | 'SY'
3561
+ | 'TW'
3562
+ | 'TJ'
3563
+ | 'TZ'
3564
+ | 'TH'
3565
+ | 'TL'
3566
+ | 'TG'
3567
+ | 'TK'
3568
+ | 'TO'
3569
+ | 'TT'
3570
+ | 'TN'
3571
+ | 'TR'
3572
+ | 'TM'
3573
+ | 'TC'
3574
+ | 'TV'
3575
+ | 'UG'
3576
+ | 'UA'
3577
+ | 'AE'
3578
+ | 'GB'
3579
+ | 'UM'
3580
+ | 'UY'
3581
+ | 'UZ'
3582
+ | 'VU'
3583
+ | 'VE'
3584
+ | 'VN'
3585
+ | 'VG'
3586
+ | 'VI'
3587
+ | 'WF'
3588
+ | 'EH'
3589
+ | 'YE'
3590
+ | 'ZM'
3591
+ | 'ZW'
3592
+ | 'AX'
3593
+ | 'BQ'
3594
+ | 'CW'
3595
+ | 'GG'
3596
+ | 'IM'
3597
+ | 'JE'
3598
+ | 'ME'
3599
+ | 'BL'
3600
+ | 'MF'
3601
+ | 'RS'
3602
+ | 'SX'
3603
+ | 'SS'
3604
+ | 'XK';
3605
+
3606
+ /**
3607
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
3608
+ */
3609
+ date_of_birth: string;
3610
+
3611
+ /**
3612
+ * Government-issued identification with type: "id" (generic government-issued ID).
3613
+ */
3614
+ identification: NonUsBeneficiaryData.Identification;
3615
+
3616
+ /**
3617
+ * Full legal name of the account holder.
3618
+ */
3619
+ legal_name: string;
3620
+
3621
+ /**
3622
+ * Residential address of the account holder.
3623
+ */
3624
+ residential_address:
3625
+ | NonUsBeneficiaryData.UsResidentialAddress
3626
+ | NonUsBeneficiaryData.NonUsResidentialAddress;
3627
+ }
3628
+
3629
+ export namespace NonUsBeneficiaryData {
3630
+ /**
3631
+ * Government-issued identification with type: "id" (generic government-issued ID).
3632
+ */
3633
+ export interface Identification {
3634
+ type: 'id';
3635
+
3636
+ value: string;
3637
+ }
3638
+
3639
+ export interface UsResidentialAddress {
3640
+ /**
3641
+ * City name.
3642
+ */
3643
+ city: string;
3644
+
3645
+ /**
3646
+ * ISO 3166-1 alpha-2 country code.
3647
+ */
3648
+ country: 'US';
3649
+
3650
+ /**
3651
+ * Postal or ZIP code.
3652
+ */
3653
+ postal_code: string;
3654
+
3655
+ /**
3656
+ * Two-letter state code.
3657
+ */
3658
+ state: string;
3659
+
3660
+ /**
3661
+ * Primary street address.
3662
+ */
3663
+ street_line_1: string;
3664
+
3665
+ /**
3666
+ * Secondary street address (apartment, suite, etc.).
3667
+ */
3668
+ street_line_2?: string;
3669
+ }
3670
+
3671
+ export interface NonUsResidentialAddress {
3672
+ /**
3673
+ * City name.
3674
+ */
3675
+ city: string;
3676
+
3677
+ /**
3678
+ * ISO 3166-1 alpha-2 country code.
3679
+ */
3680
+ country:
3681
+ | 'AF'
3682
+ | 'AL'
3683
+ | 'DZ'
3684
+ | 'AS'
3685
+ | 'AD'
3686
+ | 'AO'
3687
+ | 'AI'
3688
+ | 'AQ'
3689
+ | 'AG'
3690
+ | 'AR'
3691
+ | 'AM'
3692
+ | 'AW'
3693
+ | 'AU'
3694
+ | 'AT'
3695
+ | 'AZ'
3696
+ | 'BS'
3697
+ | 'BH'
3698
+ | 'BD'
3699
+ | 'BB'
3700
+ | 'BY'
3701
+ | 'BE'
3702
+ | 'BZ'
3703
+ | 'BJ'
3704
+ | 'BM'
3705
+ | 'BT'
3706
+ | 'BO'
3707
+ | 'BA'
3708
+ | 'BW'
3709
+ | 'BV'
3710
+ | 'BR'
3711
+ | 'IO'
3712
+ | 'BN'
3713
+ | 'BG'
3714
+ | 'BF'
3715
+ | 'BI'
3716
+ | 'KH'
3717
+ | 'CM'
3718
+ | 'CA'
3719
+ | 'CV'
3720
+ | 'KY'
3721
+ | 'CF'
3722
+ | 'TD'
3723
+ | 'CL'
3724
+ | 'CN'
3725
+ | 'CX'
3726
+ | 'CC'
3727
+ | 'CO'
3728
+ | 'KM'
3729
+ | 'CG'
3730
+ | 'CD'
3731
+ | 'CK'
3732
+ | 'CR'
3733
+ | 'CI'
3734
+ | 'HR'
3735
+ | 'CU'
3736
+ | 'CY'
3737
+ | 'CZ'
3738
+ | 'DK'
3739
+ | 'DJ'
3740
+ | 'DM'
3741
+ | 'DO'
3742
+ | 'EC'
3743
+ | 'EG'
3744
+ | 'SV'
3745
+ | 'GQ'
3746
+ | 'ER'
3747
+ | 'EE'
3748
+ | 'ET'
3749
+ | 'FK'
3750
+ | 'FO'
3751
+ | 'FJ'
3752
+ | 'FI'
3753
+ | 'FR'
3754
+ | 'GF'
3755
+ | 'PF'
3756
+ | 'TF'
3757
+ | 'GA'
3758
+ | 'GM'
3759
+ | 'GE'
3760
+ | 'DE'
3761
+ | 'GH'
3762
+ | 'GI'
3763
+ | 'GR'
3764
+ | 'GL'
3765
+ | 'GD'
3766
+ | 'GP'
3767
+ | 'GU'
3768
+ | 'GT'
3769
+ | 'GN'
3770
+ | 'GW'
3771
+ | 'GY'
3772
+ | 'HT'
3773
+ | 'HM'
3774
+ | 'VA'
3775
+ | 'HN'
3776
+ | 'HK'
3777
+ | 'HU'
3778
+ | 'IS'
3779
+ | 'IN'
3780
+ | 'ID'
3781
+ | 'IR'
3782
+ | 'IQ'
3783
+ | 'IE'
3784
+ | 'IL'
3785
+ | 'IT'
3786
+ | 'JM'
3787
+ | 'JP'
3788
+ | 'JO'
3789
+ | 'KZ'
3790
+ | 'KE'
3791
+ | 'KI'
3792
+ | 'KP'
3793
+ | 'KR'
3794
+ | 'KW'
3795
+ | 'KG'
3796
+ | 'LA'
3797
+ | 'LV'
3798
+ | 'LB'
3799
+ | 'LS'
3800
+ | 'LR'
3801
+ | 'LY'
3802
+ | 'LI'
3803
+ | 'LT'
3804
+ | 'LU'
3805
+ | 'MO'
3806
+ | 'MG'
3807
+ | 'MW'
3808
+ | 'MY'
3809
+ | 'MV'
3810
+ | 'ML'
3811
+ | 'MT'
3812
+ | 'MH'
3813
+ | 'MQ'
3814
+ | 'MR'
3815
+ | 'MU'
3816
+ | 'YT'
3817
+ | 'MX'
3818
+ | 'FM'
3819
+ | 'MD'
3820
+ | 'MC'
3821
+ | 'MN'
3822
+ | 'MS'
3823
+ | 'MA'
3824
+ | 'MZ'
3825
+ | 'MM'
3826
+ | 'NA'
3827
+ | 'NR'
3828
+ | 'NP'
3829
+ | 'NL'
3830
+ | 'NC'
3831
+ | 'NZ'
3832
+ | 'NI'
3833
+ | 'NE'
3834
+ | 'NG'
3835
+ | 'NU'
3836
+ | 'NF'
3837
+ | 'MP'
3838
+ | 'MK'
3839
+ | 'NO'
3840
+ | 'OM'
3841
+ | 'PK'
3842
+ | 'PW'
3843
+ | 'PS'
3844
+ | 'PA'
3845
+ | 'PG'
3846
+ | 'PY'
3847
+ | 'PE'
3848
+ | 'PH'
3849
+ | 'PN'
3850
+ | 'PL'
3851
+ | 'PT'
3852
+ | 'PR'
3853
+ | 'QA'
3854
+ | 'RE'
3855
+ | 'RO'
3856
+ | 'RU'
3857
+ | 'RW'
3858
+ | 'SH'
3859
+ | 'KN'
3860
+ | 'LC'
3861
+ | 'PM'
3862
+ | 'VC'
3863
+ | 'WS'
3864
+ | 'SM'
3865
+ | 'ST'
3866
+ | 'SA'
3867
+ | 'SN'
3868
+ | 'SC'
3869
+ | 'SL'
3870
+ | 'SG'
3871
+ | 'SK'
3872
+ | 'SI'
3873
+ | 'SB'
3874
+ | 'SO'
3875
+ | 'ZA'
3876
+ | 'GS'
3877
+ | 'ES'
3878
+ | 'LK'
3879
+ | 'SD'
3880
+ | 'SR'
3881
+ | 'SJ'
3882
+ | 'SZ'
3883
+ | 'SE'
3884
+ | 'CH'
3885
+ | 'SY'
3886
+ | 'TW'
3887
+ | 'TJ'
3888
+ | 'TZ'
3889
+ | 'TH'
3890
+ | 'TL'
3891
+ | 'TG'
3892
+ | 'TK'
3893
+ | 'TO'
3894
+ | 'TT'
3895
+ | 'TN'
3896
+ | 'TR'
3897
+ | 'TM'
3898
+ | 'TC'
3899
+ | 'TV'
3900
+ | 'UG'
3901
+ | 'UA'
3902
+ | 'AE'
3903
+ | 'GB'
3904
+ | 'UM'
3905
+ | 'UY'
3906
+ | 'UZ'
3907
+ | 'VU'
3908
+ | 'VE'
3909
+ | 'VN'
3910
+ | 'VG'
3911
+ | 'VI'
3912
+ | 'WF'
3913
+ | 'EH'
3914
+ | 'YE'
3915
+ | 'ZM'
3916
+ | 'ZW'
3917
+ | 'AX'
3918
+ | 'BQ'
3919
+ | 'CW'
3920
+ | 'GG'
3921
+ | 'IM'
3922
+ | 'JE'
3923
+ | 'ME'
3924
+ | 'BL'
3925
+ | 'MF'
3926
+ | 'RS'
3927
+ | 'SX'
3928
+ | 'SS'
3929
+ | 'XK';
3930
+
3931
+ /**
3932
+ * Postal or ZIP code.
3933
+ */
3934
+ postal_code: string;
3935
+
3936
+ /**
3937
+ * Primary street address.
3938
+ */
3939
+ street_line_1: string;
3940
+
3941
+ /**
3942
+ * Secondary street address (apartment, suite, etc.).
3943
+ */
3944
+ street_line_2?: string;
3945
+ }
3946
+ }
3947
+ }
3948
+
3949
+ export interface AccountHolderListParams extends CursorPageParams {}
3950
+
3951
+ export declare namespace AccountHolders {
3952
+ export {
3953
+ type AccountHolderCreateResponse as AccountHolderCreateResponse,
3954
+ type AccountHolderRetrieveResponse as AccountHolderRetrieveResponse,
3955
+ type AccountHolderListResponse as AccountHolderListResponse,
3956
+ type AccountHolderListResponsesCursorPage as AccountHolderListResponsesCursorPage,
3957
+ type AccountHolderCreateParams as AccountHolderCreateParams,
3958
+ type AccountHolderListParams as AccountHolderListParams,
3959
+ };
3960
+ }