@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,749 @@
1
+ import { APIResource } from "../core/resource.mjs";
2
+ import { APIPromise } from "../core/api-promise.mjs";
3
+ import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
4
+ import { RequestOptions } from "../internal/request-options.mjs";
5
+ export declare class AccountHolders extends APIResource {
6
+ /**
7
+ * Creates a new account holder and starts asynchronous processing.
8
+ */
9
+ create(body: AccountHolderCreateParams, options?: RequestOptions): APIPromise<AccountHolderCreateResponse>;
10
+ /**
11
+ * Retrieves an account holder by ID.
12
+ */
13
+ retrieve(id: string, options?: RequestOptions): APIPromise<AccountHolderRetrieveResponse>;
14
+ /**
15
+ * Lists account holders for the merchant with cursor-based pagination.
16
+ */
17
+ list(query?: AccountHolderListParams | null | undefined, options?: RequestOptions): PagePromise<AccountHolderListResponsesCursorPage, AccountHolderListResponse>;
18
+ }
19
+ export type AccountHolderListResponsesCursorPage = CursorPage<AccountHolderListResponse>;
20
+ export interface AccountHolderCreateResponse {
21
+ /**
22
+ * Unique identifier of the account holder.
23
+ */
24
+ id: string;
25
+ /**
26
+ * Beneficiary details used to create this account holder.
27
+ */
28
+ beneficiary_data: AccountHolderCreateResponse.UsBeneficiaryDataResponse | AccountHolderCreateResponse.NonUsBeneficiaryDataResponse;
29
+ /**
30
+ * ISO 8601 UTC timestamp when the account holder was created.
31
+ */
32
+ created_at: string;
33
+ /**
34
+ * Current account holder status.
35
+ */
36
+ status: 'pending' | 'active' | 'closed';
37
+ /**
38
+ * Resource type discriminator.
39
+ */
40
+ type: 'account_holder';
41
+ }
42
+ export declare namespace AccountHolderCreateResponse {
43
+ interface UsBeneficiaryDataResponse {
44
+ /**
45
+ * ISO 3166-1 alpha-2 country code of citizenship.
46
+ */
47
+ country_of_citizenship: 'US';
48
+ /**
49
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
50
+ */
51
+ date_of_birth: string;
52
+ /**
53
+ * Government-issued identification with type: "ssn" (Social Security Number,
54
+ * format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
55
+ */
56
+ identification: UsBeneficiaryDataResponse.SsnIdentification | UsBeneficiaryDataResponse.ItinIdentification;
57
+ /**
58
+ * Full legal name of the account holder.
59
+ */
60
+ legal_name: string;
61
+ /**
62
+ * Residential address of the account holder.
63
+ */
64
+ residential_address: UsBeneficiaryDataResponse.UsResidentialAddressResponse | UsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
65
+ }
66
+ namespace UsBeneficiaryDataResponse {
67
+ interface SsnIdentification {
68
+ type: 'ssn';
69
+ value: string;
70
+ }
71
+ interface ItinIdentification {
72
+ type: 'itin';
73
+ value: string;
74
+ }
75
+ interface UsResidentialAddressResponse {
76
+ /**
77
+ * City name.
78
+ */
79
+ city: string;
80
+ /**
81
+ * ISO 3166-1 alpha-2 country code.
82
+ */
83
+ country: 'US';
84
+ /**
85
+ * Postal or ZIP code.
86
+ */
87
+ postal_code: string;
88
+ /**
89
+ * Two-letter state code.
90
+ */
91
+ state: string;
92
+ /**
93
+ * Primary street address.
94
+ */
95
+ street_line_1: string;
96
+ /**
97
+ * Secondary street address (apartment, suite, etc.).
98
+ */
99
+ street_line_2: string | null;
100
+ }
101
+ interface NonUsResidentialAddressResponse {
102
+ /**
103
+ * City name.
104
+ */
105
+ city: string;
106
+ /**
107
+ * ISO 3166-1 alpha-2 country code.
108
+ */
109
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
110
+ /**
111
+ * Postal or ZIP code.
112
+ */
113
+ postal_code: string;
114
+ /**
115
+ * Primary street address.
116
+ */
117
+ street_line_1: string;
118
+ /**
119
+ * Secondary street address (apartment, suite, etc.).
120
+ */
121
+ street_line_2: string | null;
122
+ }
123
+ }
124
+ interface NonUsBeneficiaryDataResponse {
125
+ /**
126
+ * ISO 3166-1 alpha-2 country code of citizenship.
127
+ */
128
+ country_of_citizenship: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
129
+ /**
130
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
131
+ */
132
+ date_of_birth: string;
133
+ /**
134
+ * Government-issued identification with type: "id" (generic government-issued ID).
135
+ */
136
+ identification: NonUsBeneficiaryDataResponse.Identification;
137
+ /**
138
+ * Full legal name of the account holder.
139
+ */
140
+ legal_name: string;
141
+ /**
142
+ * Residential address of the account holder.
143
+ */
144
+ residential_address: NonUsBeneficiaryDataResponse.UsResidentialAddressResponse | NonUsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
145
+ }
146
+ namespace NonUsBeneficiaryDataResponse {
147
+ /**
148
+ * Government-issued identification with type: "id" (generic government-issued ID).
149
+ */
150
+ interface Identification {
151
+ type: 'id';
152
+ value: string;
153
+ }
154
+ interface UsResidentialAddressResponse {
155
+ /**
156
+ * City name.
157
+ */
158
+ city: string;
159
+ /**
160
+ * ISO 3166-1 alpha-2 country code.
161
+ */
162
+ country: 'US';
163
+ /**
164
+ * Postal or ZIP code.
165
+ */
166
+ postal_code: string;
167
+ /**
168
+ * Two-letter state code.
169
+ */
170
+ state: string;
171
+ /**
172
+ * Primary street address.
173
+ */
174
+ street_line_1: string;
175
+ /**
176
+ * Secondary street address (apartment, suite, etc.).
177
+ */
178
+ street_line_2: string | null;
179
+ }
180
+ interface NonUsResidentialAddressResponse {
181
+ /**
182
+ * City name.
183
+ */
184
+ city: string;
185
+ /**
186
+ * ISO 3166-1 alpha-2 country code.
187
+ */
188
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
189
+ /**
190
+ * Postal or ZIP code.
191
+ */
192
+ postal_code: string;
193
+ /**
194
+ * Primary street address.
195
+ */
196
+ street_line_1: string;
197
+ /**
198
+ * Secondary street address (apartment, suite, etc.).
199
+ */
200
+ street_line_2: string | null;
201
+ }
202
+ }
203
+ }
204
+ export interface AccountHolderRetrieveResponse {
205
+ /**
206
+ * Unique identifier of the account holder.
207
+ */
208
+ id: string;
209
+ /**
210
+ * Beneficiary details used to create this account holder.
211
+ */
212
+ beneficiary_data: AccountHolderRetrieveResponse.UsBeneficiaryDataResponse | AccountHolderRetrieveResponse.NonUsBeneficiaryDataResponse;
213
+ /**
214
+ * ISO 8601 UTC timestamp when the account holder was created.
215
+ */
216
+ created_at: string;
217
+ /**
218
+ * Current account holder status.
219
+ */
220
+ status: 'pending' | 'active' | 'closed';
221
+ /**
222
+ * Resource type discriminator.
223
+ */
224
+ type: 'account_holder';
225
+ }
226
+ export declare namespace AccountHolderRetrieveResponse {
227
+ interface UsBeneficiaryDataResponse {
228
+ /**
229
+ * ISO 3166-1 alpha-2 country code of citizenship.
230
+ */
231
+ country_of_citizenship: 'US';
232
+ /**
233
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
234
+ */
235
+ date_of_birth: string;
236
+ /**
237
+ * Government-issued identification with type: "ssn" (Social Security Number,
238
+ * format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
239
+ */
240
+ identification: UsBeneficiaryDataResponse.SsnIdentification | UsBeneficiaryDataResponse.ItinIdentification;
241
+ /**
242
+ * Full legal name of the account holder.
243
+ */
244
+ legal_name: string;
245
+ /**
246
+ * Residential address of the account holder.
247
+ */
248
+ residential_address: UsBeneficiaryDataResponse.UsResidentialAddressResponse | UsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
249
+ }
250
+ namespace UsBeneficiaryDataResponse {
251
+ interface SsnIdentification {
252
+ type: 'ssn';
253
+ value: string;
254
+ }
255
+ interface ItinIdentification {
256
+ type: 'itin';
257
+ value: string;
258
+ }
259
+ interface UsResidentialAddressResponse {
260
+ /**
261
+ * City name.
262
+ */
263
+ city: string;
264
+ /**
265
+ * ISO 3166-1 alpha-2 country code.
266
+ */
267
+ country: 'US';
268
+ /**
269
+ * Postal or ZIP code.
270
+ */
271
+ postal_code: string;
272
+ /**
273
+ * Two-letter state code.
274
+ */
275
+ state: string;
276
+ /**
277
+ * Primary street address.
278
+ */
279
+ street_line_1: string;
280
+ /**
281
+ * Secondary street address (apartment, suite, etc.).
282
+ */
283
+ street_line_2: string | null;
284
+ }
285
+ interface NonUsResidentialAddressResponse {
286
+ /**
287
+ * City name.
288
+ */
289
+ city: string;
290
+ /**
291
+ * ISO 3166-1 alpha-2 country code.
292
+ */
293
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
294
+ /**
295
+ * Postal or ZIP code.
296
+ */
297
+ postal_code: string;
298
+ /**
299
+ * Primary street address.
300
+ */
301
+ street_line_1: string;
302
+ /**
303
+ * Secondary street address (apartment, suite, etc.).
304
+ */
305
+ street_line_2: string | null;
306
+ }
307
+ }
308
+ interface NonUsBeneficiaryDataResponse {
309
+ /**
310
+ * ISO 3166-1 alpha-2 country code of citizenship.
311
+ */
312
+ country_of_citizenship: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
313
+ /**
314
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
315
+ */
316
+ date_of_birth: string;
317
+ /**
318
+ * Government-issued identification with type: "id" (generic government-issued ID).
319
+ */
320
+ identification: NonUsBeneficiaryDataResponse.Identification;
321
+ /**
322
+ * Full legal name of the account holder.
323
+ */
324
+ legal_name: string;
325
+ /**
326
+ * Residential address of the account holder.
327
+ */
328
+ residential_address: NonUsBeneficiaryDataResponse.UsResidentialAddressResponse | NonUsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
329
+ }
330
+ namespace NonUsBeneficiaryDataResponse {
331
+ /**
332
+ * Government-issued identification with type: "id" (generic government-issued ID).
333
+ */
334
+ interface Identification {
335
+ type: 'id';
336
+ value: string;
337
+ }
338
+ interface UsResidentialAddressResponse {
339
+ /**
340
+ * City name.
341
+ */
342
+ city: string;
343
+ /**
344
+ * ISO 3166-1 alpha-2 country code.
345
+ */
346
+ country: 'US';
347
+ /**
348
+ * Postal or ZIP code.
349
+ */
350
+ postal_code: string;
351
+ /**
352
+ * Two-letter state code.
353
+ */
354
+ state: string;
355
+ /**
356
+ * Primary street address.
357
+ */
358
+ street_line_1: string;
359
+ /**
360
+ * Secondary street address (apartment, suite, etc.).
361
+ */
362
+ street_line_2: string | null;
363
+ }
364
+ interface NonUsResidentialAddressResponse {
365
+ /**
366
+ * City name.
367
+ */
368
+ city: string;
369
+ /**
370
+ * ISO 3166-1 alpha-2 country code.
371
+ */
372
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
373
+ /**
374
+ * Postal or ZIP code.
375
+ */
376
+ postal_code: string;
377
+ /**
378
+ * Primary street address.
379
+ */
380
+ street_line_1: string;
381
+ /**
382
+ * Secondary street address (apartment, suite, etc.).
383
+ */
384
+ street_line_2: string | null;
385
+ }
386
+ }
387
+ }
388
+ export interface AccountHolderListResponse {
389
+ /**
390
+ * Unique identifier of the account holder.
391
+ */
392
+ id: string;
393
+ /**
394
+ * Beneficiary details used to create this account holder.
395
+ */
396
+ beneficiary_data: AccountHolderListResponse.UsBeneficiaryDataResponse | AccountHolderListResponse.NonUsBeneficiaryDataResponse;
397
+ /**
398
+ * ISO 8601 UTC timestamp when the account holder was created.
399
+ */
400
+ created_at: string;
401
+ /**
402
+ * Current account holder status.
403
+ */
404
+ status: 'pending' | 'active' | 'closed';
405
+ /**
406
+ * Resource type discriminator.
407
+ */
408
+ type: 'account_holder';
409
+ }
410
+ export declare namespace AccountHolderListResponse {
411
+ interface UsBeneficiaryDataResponse {
412
+ /**
413
+ * ISO 3166-1 alpha-2 country code of citizenship.
414
+ */
415
+ country_of_citizenship: 'US';
416
+ /**
417
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
418
+ */
419
+ date_of_birth: string;
420
+ /**
421
+ * Government-issued identification with type: "ssn" (Social Security Number,
422
+ * format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
423
+ */
424
+ identification: UsBeneficiaryDataResponse.SsnIdentification | UsBeneficiaryDataResponse.ItinIdentification;
425
+ /**
426
+ * Full legal name of the account holder.
427
+ */
428
+ legal_name: string;
429
+ /**
430
+ * Residential address of the account holder.
431
+ */
432
+ residential_address: UsBeneficiaryDataResponse.UsResidentialAddressResponse | UsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
433
+ }
434
+ namespace UsBeneficiaryDataResponse {
435
+ interface SsnIdentification {
436
+ type: 'ssn';
437
+ value: string;
438
+ }
439
+ interface ItinIdentification {
440
+ type: 'itin';
441
+ value: string;
442
+ }
443
+ interface UsResidentialAddressResponse {
444
+ /**
445
+ * City name.
446
+ */
447
+ city: string;
448
+ /**
449
+ * ISO 3166-1 alpha-2 country code.
450
+ */
451
+ country: 'US';
452
+ /**
453
+ * Postal or ZIP code.
454
+ */
455
+ postal_code: string;
456
+ /**
457
+ * Two-letter state code.
458
+ */
459
+ state: string;
460
+ /**
461
+ * Primary street address.
462
+ */
463
+ street_line_1: string;
464
+ /**
465
+ * Secondary street address (apartment, suite, etc.).
466
+ */
467
+ street_line_2: string | null;
468
+ }
469
+ interface NonUsResidentialAddressResponse {
470
+ /**
471
+ * City name.
472
+ */
473
+ city: string;
474
+ /**
475
+ * ISO 3166-1 alpha-2 country code.
476
+ */
477
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
478
+ /**
479
+ * Postal or ZIP code.
480
+ */
481
+ postal_code: string;
482
+ /**
483
+ * Primary street address.
484
+ */
485
+ street_line_1: string;
486
+ /**
487
+ * Secondary street address (apartment, suite, etc.).
488
+ */
489
+ street_line_2: string | null;
490
+ }
491
+ }
492
+ interface NonUsBeneficiaryDataResponse {
493
+ /**
494
+ * ISO 3166-1 alpha-2 country code of citizenship.
495
+ */
496
+ country_of_citizenship: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
497
+ /**
498
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
499
+ */
500
+ date_of_birth: string;
501
+ /**
502
+ * Government-issued identification with type: "id" (generic government-issued ID).
503
+ */
504
+ identification: NonUsBeneficiaryDataResponse.Identification;
505
+ /**
506
+ * Full legal name of the account holder.
507
+ */
508
+ legal_name: string;
509
+ /**
510
+ * Residential address of the account holder.
511
+ */
512
+ residential_address: NonUsBeneficiaryDataResponse.UsResidentialAddressResponse | NonUsBeneficiaryDataResponse.NonUsResidentialAddressResponse;
513
+ }
514
+ namespace NonUsBeneficiaryDataResponse {
515
+ /**
516
+ * Government-issued identification with type: "id" (generic government-issued ID).
517
+ */
518
+ interface Identification {
519
+ type: 'id';
520
+ value: string;
521
+ }
522
+ interface UsResidentialAddressResponse {
523
+ /**
524
+ * City name.
525
+ */
526
+ city: string;
527
+ /**
528
+ * ISO 3166-1 alpha-2 country code.
529
+ */
530
+ country: 'US';
531
+ /**
532
+ * Postal or ZIP code.
533
+ */
534
+ postal_code: string;
535
+ /**
536
+ * Two-letter state code.
537
+ */
538
+ state: string;
539
+ /**
540
+ * Primary street address.
541
+ */
542
+ street_line_1: string;
543
+ /**
544
+ * Secondary street address (apartment, suite, etc.).
545
+ */
546
+ street_line_2: string | null;
547
+ }
548
+ interface NonUsResidentialAddressResponse {
549
+ /**
550
+ * City name.
551
+ */
552
+ city: string;
553
+ /**
554
+ * ISO 3166-1 alpha-2 country code.
555
+ */
556
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
557
+ /**
558
+ * Postal or ZIP code.
559
+ */
560
+ postal_code: string;
561
+ /**
562
+ * Primary street address.
563
+ */
564
+ street_line_1: string;
565
+ /**
566
+ * Secondary street address (apartment, suite, etc.).
567
+ */
568
+ street_line_2: string | null;
569
+ }
570
+ }
571
+ }
572
+ export interface AccountHolderCreateParams {
573
+ /**
574
+ * ID of the account program to create the account holder under.
575
+ */
576
+ account_program_id: string;
577
+ /**
578
+ * Personal information of the account holder.
579
+ */
580
+ beneficiary_data: AccountHolderCreateParams.UsBeneficiaryData | AccountHolderCreateParams.NonUsBeneficiaryData;
581
+ }
582
+ export declare namespace AccountHolderCreateParams {
583
+ interface UsBeneficiaryData {
584
+ /**
585
+ * ISO 3166-1 alpha-2 country code of citizenship.
586
+ */
587
+ country_of_citizenship: 'US';
588
+ /**
589
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
590
+ */
591
+ date_of_birth: string;
592
+ /**
593
+ * Government-issued identification with type: "ssn" (Social Security Number,
594
+ * format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
595
+ */
596
+ identification: UsBeneficiaryData.SsnIdentification | UsBeneficiaryData.ItinIdentification;
597
+ /**
598
+ * Full legal name of the account holder.
599
+ */
600
+ legal_name: string;
601
+ /**
602
+ * Residential address of the account holder.
603
+ */
604
+ residential_address: UsBeneficiaryData.UsResidentialAddress | UsBeneficiaryData.NonUsResidentialAddress;
605
+ }
606
+ namespace UsBeneficiaryData {
607
+ interface SsnIdentification {
608
+ type: 'ssn';
609
+ value: string;
610
+ }
611
+ interface ItinIdentification {
612
+ type: 'itin';
613
+ value: string;
614
+ }
615
+ interface UsResidentialAddress {
616
+ /**
617
+ * City name.
618
+ */
619
+ city: string;
620
+ /**
621
+ * ISO 3166-1 alpha-2 country code.
622
+ */
623
+ country: 'US';
624
+ /**
625
+ * Postal or ZIP code.
626
+ */
627
+ postal_code: string;
628
+ /**
629
+ * Two-letter state code.
630
+ */
631
+ state: string;
632
+ /**
633
+ * Primary street address.
634
+ */
635
+ street_line_1: string;
636
+ /**
637
+ * Secondary street address (apartment, suite, etc.).
638
+ */
639
+ street_line_2?: string;
640
+ }
641
+ interface NonUsResidentialAddress {
642
+ /**
643
+ * City name.
644
+ */
645
+ city: string;
646
+ /**
647
+ * ISO 3166-1 alpha-2 country code.
648
+ */
649
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
650
+ /**
651
+ * Postal or ZIP code.
652
+ */
653
+ postal_code: string;
654
+ /**
655
+ * Primary street address.
656
+ */
657
+ street_line_1: string;
658
+ /**
659
+ * Secondary street address (apartment, suite, etc.).
660
+ */
661
+ street_line_2?: string;
662
+ }
663
+ }
664
+ interface NonUsBeneficiaryData {
665
+ /**
666
+ * ISO 3166-1 alpha-2 country code of citizenship.
667
+ */
668
+ country_of_citizenship: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
669
+ /**
670
+ * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
671
+ */
672
+ date_of_birth: string;
673
+ /**
674
+ * Government-issued identification with type: "id" (generic government-issued ID).
675
+ */
676
+ identification: NonUsBeneficiaryData.Identification;
677
+ /**
678
+ * Full legal name of the account holder.
679
+ */
680
+ legal_name: string;
681
+ /**
682
+ * Residential address of the account holder.
683
+ */
684
+ residential_address: NonUsBeneficiaryData.UsResidentialAddress | NonUsBeneficiaryData.NonUsResidentialAddress;
685
+ }
686
+ namespace NonUsBeneficiaryData {
687
+ /**
688
+ * Government-issued identification with type: "id" (generic government-issued ID).
689
+ */
690
+ interface Identification {
691
+ type: 'id';
692
+ value: string;
693
+ }
694
+ interface UsResidentialAddress {
695
+ /**
696
+ * City name.
697
+ */
698
+ city: string;
699
+ /**
700
+ * ISO 3166-1 alpha-2 country code.
701
+ */
702
+ country: 'US';
703
+ /**
704
+ * Postal or ZIP code.
705
+ */
706
+ postal_code: string;
707
+ /**
708
+ * Two-letter state code.
709
+ */
710
+ state: string;
711
+ /**
712
+ * Primary street address.
713
+ */
714
+ street_line_1: string;
715
+ /**
716
+ * Secondary street address (apartment, suite, etc.).
717
+ */
718
+ street_line_2?: string;
719
+ }
720
+ interface NonUsResidentialAddress {
721
+ /**
722
+ * City name.
723
+ */
724
+ city: string;
725
+ /**
726
+ * ISO 3166-1 alpha-2 country code.
727
+ */
728
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
729
+ /**
730
+ * Postal or ZIP code.
731
+ */
732
+ postal_code: string;
733
+ /**
734
+ * Primary street address.
735
+ */
736
+ street_line_1: string;
737
+ /**
738
+ * Secondary street address (apartment, suite, etc.).
739
+ */
740
+ street_line_2?: string;
741
+ }
742
+ }
743
+ }
744
+ export interface AccountHolderListParams extends CursorPageParams {
745
+ }
746
+ export declare namespace AccountHolders {
747
+ export { type AccountHolderCreateResponse as AccountHolderCreateResponse, type AccountHolderRetrieveResponse as AccountHolderRetrieveResponse, type AccountHolderListResponse as AccountHolderListResponse, type AccountHolderListResponsesCursorPage as AccountHolderListResponsesCursorPage, type AccountHolderCreateParams as AccountHolderCreateParams, type AccountHolderListParams as AccountHolderListParams, };
748
+ }
749
+ //# sourceMappingURL=account-holders.d.mts.map