@privy-io/api-types 0.22.0 → 0.24.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.
- package/CHANGELOG.md +41 -0
- package/client.d.mts +16 -16
- package/client.d.mts.map +1 -1
- package/client.d.ts +16 -16
- package/client.d.ts.map +1 -1
- package/client.js +1 -1
- package/client.js.map +1 -1
- package/client.mjs +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/accounts.d.mts +0 -8
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +0 -8
- package/resources/accounts.d.ts.map +1 -1
- package/resources/aggregations.d.mts +1 -1
- package/resources/aggregations.d.mts.map +1 -1
- package/resources/aggregations.d.ts +1 -1
- package/resources/aggregations.d.ts.map +1 -1
- package/resources/apps.d.mts +88 -1
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +88 -1
- package/resources/apps.d.ts.map +1 -1
- package/resources/cards.d.mts +87 -6
- package/resources/cards.d.mts.map +1 -1
- package/resources/cards.d.ts +87 -6
- package/resources/cards.d.ts.map +1 -1
- package/resources/client-auth.d.mts +1 -1
- package/resources/client-auth.d.mts.map +1 -1
- package/resources/client-auth.d.ts +1 -1
- package/resources/client-auth.d.ts.map +1 -1
- package/resources/fiat.d.mts +701 -61
- package/resources/fiat.d.mts.map +1 -1
- package/resources/fiat.d.ts +701 -61
- package/resources/fiat.d.ts.map +1 -1
- package/resources/index.d.mts +8 -8
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +8 -8
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/intents.d.mts +82 -4
- package/resources/intents.d.mts.map +1 -1
- package/resources/intents.d.ts +82 -4
- package/resources/intents.d.ts.map +1 -1
- package/resources/key-quorums.d.mts +14 -1
- package/resources/key-quorums.d.mts.map +1 -1
- package/resources/key-quorums.d.ts +14 -1
- package/resources/key-quorums.d.ts.map +1 -1
- package/resources/policies/condition-sets.d.mts +21 -0
- package/resources/policies/condition-sets.d.mts.map +1 -0
- package/resources/policies/condition-sets.d.ts +21 -0
- package/resources/policies/condition-sets.d.ts.map +1 -0
- package/resources/policies/condition-sets.js +9 -0
- package/resources/policies/condition-sets.js.map +1 -0
- package/resources/policies/condition-sets.mjs +5 -0
- package/resources/policies/condition-sets.mjs.map +1 -0
- package/resources/policies/index.d.mts +3 -0
- package/resources/policies/index.d.mts.map +1 -0
- package/resources/policies/index.d.ts +3 -0
- package/resources/policies/index.d.ts.map +1 -0
- package/resources/policies/index.js +9 -0
- package/resources/policies/index.js.map +1 -0
- package/resources/policies/index.mjs +4 -0
- package/resources/policies/index.mjs.map +1 -0
- package/resources/policies/policies.d.mts +775 -0
- package/resources/policies/policies.d.mts.map +1 -0
- package/resources/policies/policies.d.ts +775 -0
- package/resources/policies/policies.d.ts.map +1 -0
- package/resources/policies/policies.js +17 -0
- package/resources/policies/policies.js.map +1 -0
- package/resources/policies/policies.mjs +12 -0
- package/resources/policies/policies.mjs.map +1 -0
- package/resources/policies.d.mts +1 -698
- package/resources/policies.d.mts.map +1 -1
- package/resources/policies.d.ts +1 -698
- package/resources/policies.d.ts.map +1 -1
- package/resources/policies.js +2 -5
- package/resources/policies.js.map +1 -1
- package/resources/policies.mjs +1 -3
- package/resources/policies.mjs.map +1 -1
- package/resources/users.d.mts +25 -20
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +25 -20
- package/resources/users.d.ts.map +1 -1
- package/resources/wallet-automations.d.mts +14 -8
- package/resources/wallet-automations.d.mts.map +1 -1
- package/resources/wallet-automations.d.ts +14 -8
- package/resources/wallet-automations.d.ts.map +1 -1
- package/resources/wallets/actions.d.mts +45 -11
- package/resources/wallets/actions.d.mts.map +1 -1
- package/resources/wallets/actions.d.ts +45 -11
- package/resources/wallets/actions.d.ts.map +1 -1
- package/resources/wallets/balance.d.mts +3 -3
- package/resources/wallets/balance.d.mts.map +1 -1
- package/resources/wallets/balance.d.ts +3 -3
- package/resources/wallets/balance.d.ts.map +1 -1
- package/resources/wallets/index.d.mts +2 -2
- package/resources/wallets/index.d.mts.map +1 -1
- package/resources/wallets/index.d.ts +2 -2
- package/resources/wallets/index.d.ts.map +1 -1
- package/resources/wallets/index.js.map +1 -1
- package/resources/wallets/index.mjs.map +1 -1
- package/resources/wallets/transactions.d.mts +4 -1
- package/resources/wallets/transactions.d.mts.map +1 -1
- package/resources/wallets/transactions.d.ts +4 -1
- package/resources/wallets/transactions.d.ts.map +1 -1
- package/resources/wallets/wallets.d.mts +287 -17
- package/resources/wallets/wallets.d.mts.map +1 -1
- package/resources/wallets/wallets.d.ts +287 -17
- package/resources/wallets/wallets.d.ts.map +1 -1
- package/resources/wallets/wallets.js.map +1 -1
- package/resources/wallets/wallets.mjs.map +1 -1
- package/resources/webhooks.d.mts +76 -14
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +76 -14
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/yield.d.mts +2 -2
- package/resources/yield.d.ts +2 -2
- package/src/client.ts +196 -62
- package/src/resources/accounts.ts +0 -10
- package/src/resources/aggregations.ts +1 -1
- package/src/resources/apps.ts +126 -0
- package/src/resources/cards.ts +112 -5
- package/src/resources/client-auth.ts +1 -1
- package/src/resources/fiat.ts +938 -136
- package/src/resources/index.ts +71 -4
- package/src/resources/intents.ts +114 -3
- package/src/resources/key-quorums.ts +16 -0
- package/src/resources/policies/condition-sets.ts +25 -0
- package/src/resources/policies/index.ts +63 -0
- package/src/resources/policies/policies.ts +1122 -0
- package/src/resources/policies.ts +1 -1023
- package/src/resources/users.ts +31 -25
- package/src/resources/wallet-automations.ts +16 -9
- package/src/resources/wallets/actions.ts +54 -10
- package/src/resources/wallets/balance.ts +3 -0
- package/src/resources/wallets/index.ts +18 -0
- package/src/resources/wallets/transactions.ts +4 -0
- package/src/resources/wallets/wallets.ts +358 -10
- package/src/resources/webhooks.ts +93 -15
- package/src/resources/yield.ts +2 -2
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/fiat.d.mts
CHANGED
|
@@ -16,6 +16,11 @@ export interface BridgeCreateExternalFiatAccountRequestBody {
|
|
|
16
16
|
* Discriminator: the external fiat account is orchestrated via Bridge.
|
|
17
17
|
*/
|
|
18
18
|
provider: 'bridge';
|
|
19
|
+
/**
|
|
20
|
+
* The individual or business that owns the account. Required for `iban`, `gb`, and
|
|
21
|
+
* `swift` accounts.
|
|
22
|
+
*/
|
|
23
|
+
account_owner?: ExternalFiatAccountOwner;
|
|
19
24
|
/**
|
|
20
25
|
* Physical address associated with an external fiat account.
|
|
21
26
|
*/
|
|
@@ -42,6 +47,11 @@ export interface BridgeCreateFiatDepositAccountRequestBody {
|
|
|
42
47
|
* The source fiat currency for a fiat deposit account.
|
|
43
48
|
*/
|
|
44
49
|
source: CreateFiatDepositAccountSource;
|
|
50
|
+
/**
|
|
51
|
+
* A developer fee as a percentage string from 0 up to (not including) 100, e.g.
|
|
52
|
+
* "1.5" for 1.5%.
|
|
53
|
+
*/
|
|
54
|
+
developer_fee_percent?: DeveloperFeePercent;
|
|
45
55
|
/**
|
|
46
56
|
* The Privy API environment.
|
|
47
57
|
*/
|
|
@@ -83,6 +93,11 @@ export interface BridgeFiatDepositAccount {
|
|
|
83
93
|
* The destination crypto asset and chain for a fiat deposit account.
|
|
84
94
|
*/
|
|
85
95
|
destination: FiatDepositAccountDestination;
|
|
96
|
+
/**
|
|
97
|
+
* A developer fee as a percentage string from 0 up to (not including) 100, e.g.
|
|
98
|
+
* "1.5" for 1.5%.
|
|
99
|
+
*/
|
|
100
|
+
developer_fee_percent: DeveloperFeePercent;
|
|
86
101
|
/**
|
|
87
102
|
* The Privy API environment.
|
|
88
103
|
*/
|
|
@@ -136,6 +151,11 @@ export interface CreateExternalFiatAccountRequestBody {
|
|
|
136
151
|
* Discriminator: the external fiat account is orchestrated via Bridge.
|
|
137
152
|
*/
|
|
138
153
|
provider: 'bridge';
|
|
154
|
+
/**
|
|
155
|
+
* The individual or business that owns the account. Required for `iban`, `gb`, and
|
|
156
|
+
* `swift` accounts.
|
|
157
|
+
*/
|
|
158
|
+
account_owner?: ExternalFiatAccountOwner;
|
|
139
159
|
/**
|
|
140
160
|
* Physical address associated with an external fiat account.
|
|
141
161
|
*/
|
|
@@ -162,6 +182,11 @@ export interface CreateFiatDepositAccountRequestBody {
|
|
|
162
182
|
* The source fiat currency for a fiat deposit account.
|
|
163
183
|
*/
|
|
164
184
|
source: CreateFiatDepositAccountSource;
|
|
185
|
+
/**
|
|
186
|
+
* A developer fee as a percentage string from 0 up to (not including) 100, e.g.
|
|
187
|
+
* "1.5" for 1.5%.
|
|
188
|
+
*/
|
|
189
|
+
developer_fee_percent?: DeveloperFeePercent;
|
|
165
190
|
/**
|
|
166
191
|
* The Privy API environment.
|
|
167
192
|
*/
|
|
@@ -185,7 +210,17 @@ export interface CreatePayoutRequestBody {
|
|
|
185
210
|
* The source crypto asset, chain, and amount for a payout.
|
|
186
211
|
*/
|
|
187
212
|
source: PayoutSource;
|
|
213
|
+
/**
|
|
214
|
+
* A developer fee as a percentage string from 0 up to (not including) 100, e.g.
|
|
215
|
+
* "1.5" for 1.5%.
|
|
216
|
+
*/
|
|
217
|
+
developer_fee_percent?: DeveloperFeePercent;
|
|
188
218
|
}
|
|
219
|
+
/**
|
|
220
|
+
* A developer fee as a percentage string from 0 up to (not including) 100, e.g.
|
|
221
|
+
* "1.5" for 1.5%.
|
|
222
|
+
*/
|
|
223
|
+
export type DeveloperFeePercent = string;
|
|
189
224
|
/**
|
|
190
225
|
* A Bridge external fiat account linked to a user.
|
|
191
226
|
*/
|
|
@@ -218,6 +253,13 @@ export interface ExternalFiatAccountAddress {
|
|
|
218
253
|
state?: string;
|
|
219
254
|
street_line_2?: string;
|
|
220
255
|
}
|
|
256
|
+
/**
|
|
257
|
+
* A business that owns an external fiat account.
|
|
258
|
+
*/
|
|
259
|
+
export interface ExternalFiatAccountBusinessOwner {
|
|
260
|
+
business_name: string;
|
|
261
|
+
type: 'business';
|
|
262
|
+
}
|
|
221
263
|
/**
|
|
222
264
|
* Bank account details. The `type` field discriminates which shape applies.
|
|
223
265
|
*/
|
|
@@ -255,6 +297,19 @@ export interface ExternalFiatAccountIbanData {
|
|
|
255
297
|
country: string;
|
|
256
298
|
type: 'iban';
|
|
257
299
|
}
|
|
300
|
+
/**
|
|
301
|
+
* An individual who owns an external fiat account.
|
|
302
|
+
*/
|
|
303
|
+
export interface ExternalFiatAccountIndividualOwner {
|
|
304
|
+
first_name: string;
|
|
305
|
+
last_name: string;
|
|
306
|
+
type: 'individual';
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* The individual or business that owns the account. Required for `iban`, `gb`, and
|
|
310
|
+
* `swift` accounts.
|
|
311
|
+
*/
|
|
312
|
+
export type ExternalFiatAccountOwner = ExternalFiatAccountIndividualOwner | ExternalFiatAccountBusinessOwner;
|
|
258
313
|
/**
|
|
259
314
|
* Brazilian Pix account data for an external fiat account. Provide exactly one of
|
|
260
315
|
* `pix_key` or `br_code`.
|
|
@@ -343,6 +398,11 @@ export interface FiatDepositAccount {
|
|
|
343
398
|
* The destination crypto asset and chain for a fiat deposit account.
|
|
344
399
|
*/
|
|
345
400
|
destination: FiatDepositAccountDestination;
|
|
401
|
+
/**
|
|
402
|
+
* A developer fee as a percentage string from 0 up to (not including) 100, e.g.
|
|
403
|
+
* "1.5" for 1.5%.
|
|
404
|
+
*/
|
|
405
|
+
developer_fee_percent: DeveloperFeePercent;
|
|
346
406
|
/**
|
|
347
407
|
* The Privy API environment.
|
|
348
408
|
*/
|
|
@@ -420,6 +480,203 @@ export interface FiatDepositInstructions {
|
|
|
420
480
|
* Supported fiat payment rails.
|
|
421
481
|
*/
|
|
422
482
|
export type FiatPaymentRail = 'sepa' | 'ach_push' | 'wire' | 'fednow' | 'faster_payments';
|
|
483
|
+
/**
|
|
484
|
+
* Primary purpose the business will use the account for. Passthrough to the
|
|
485
|
+
* provider. See the
|
|
486
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
487
|
+
* for accepted values.
|
|
488
|
+
*/
|
|
489
|
+
export type KYBAccountPurpose = string;
|
|
490
|
+
/**
|
|
491
|
+
* A beneficial owner, control person, or signer associated with the business. At
|
|
492
|
+
* least one of has_ownership, has_control, or is_signer must be true, and the
|
|
493
|
+
* business must have at least one control person and one signer.
|
|
494
|
+
*/
|
|
495
|
+
export interface KYBAssociatedPerson {
|
|
496
|
+
/**
|
|
497
|
+
* Date of birth in YYYY-MM-DD format. Must be 18 years or older.
|
|
498
|
+
*/
|
|
499
|
+
date_of_birth: string;
|
|
500
|
+
/**
|
|
501
|
+
* Email address.
|
|
502
|
+
*/
|
|
503
|
+
email: string;
|
|
504
|
+
/**
|
|
505
|
+
* Legal first name.
|
|
506
|
+
*/
|
|
507
|
+
first_name: string;
|
|
508
|
+
/**
|
|
509
|
+
* Whether this person is a control person.
|
|
510
|
+
*/
|
|
511
|
+
has_control: boolean;
|
|
512
|
+
/**
|
|
513
|
+
* Whether this person owns 25% or more of the business.
|
|
514
|
+
*/
|
|
515
|
+
has_ownership: boolean;
|
|
516
|
+
/**
|
|
517
|
+
* Identifying documents for this person.
|
|
518
|
+
*/
|
|
519
|
+
identifying_information: Array<VerificationDocument>;
|
|
520
|
+
/**
|
|
521
|
+
* Whether this person is a signer for the business.
|
|
522
|
+
*/
|
|
523
|
+
is_signer: boolean;
|
|
524
|
+
/**
|
|
525
|
+
* Legal last name.
|
|
526
|
+
*/
|
|
527
|
+
last_name: string;
|
|
528
|
+
/**
|
|
529
|
+
* A postal address used in KYC and KYB data submission.
|
|
530
|
+
*/
|
|
531
|
+
residential_address: VerificationAddress;
|
|
532
|
+
/**
|
|
533
|
+
* When this person (a control person) attested to having verified the business
|
|
534
|
+
* ownership structure (ISO 8601).
|
|
535
|
+
*/
|
|
536
|
+
attested_ownership_structure_at?: (string & {}) | (string & {});
|
|
537
|
+
/**
|
|
538
|
+
* Supporting documents for this person, such as proof of address.
|
|
539
|
+
*/
|
|
540
|
+
documents?: Array<KYBIndividualDocument>;
|
|
541
|
+
/**
|
|
542
|
+
* Whether this person is a director.
|
|
543
|
+
*/
|
|
544
|
+
is_director?: boolean;
|
|
545
|
+
/**
|
|
546
|
+
* Result of a KYC/AML or OFAC screen you performed and are relying on the provider
|
|
547
|
+
* to accept, honoured only for developers enrolled in reliance.
|
|
548
|
+
*/
|
|
549
|
+
kyc_screen?: KyxScreen;
|
|
550
|
+
/**
|
|
551
|
+
* Legal middle name.
|
|
552
|
+
*/
|
|
553
|
+
middle_name?: string;
|
|
554
|
+
/**
|
|
555
|
+
* ISO 3166-1 alpha-3 codes for all nationalities held.
|
|
556
|
+
*/
|
|
557
|
+
nationalities?: Array<string>;
|
|
558
|
+
/**
|
|
559
|
+
* Result of a KYC/AML or OFAC screen you performed and are relying on the provider
|
|
560
|
+
* to accept, honoured only for developers enrolled in reliance.
|
|
561
|
+
*/
|
|
562
|
+
ofac_screen?: KyxScreen;
|
|
563
|
+
/**
|
|
564
|
+
* Percentage of the business this person owns.
|
|
565
|
+
*/
|
|
566
|
+
ownership_percentage?: number;
|
|
567
|
+
/**
|
|
568
|
+
* Phone number in E.164 format.
|
|
569
|
+
*/
|
|
570
|
+
phone?: string;
|
|
571
|
+
/**
|
|
572
|
+
* Place of birth for an associated person.
|
|
573
|
+
*/
|
|
574
|
+
place_of_birth?: KYBPlaceOfBirth;
|
|
575
|
+
/**
|
|
576
|
+
* Date the relationship with the business was established, in YYYY-MM-DD format.
|
|
577
|
+
*/
|
|
578
|
+
relationship_established_at?: string;
|
|
579
|
+
/**
|
|
580
|
+
* Job title. Required when has_control is true.
|
|
581
|
+
*/
|
|
582
|
+
title?: string;
|
|
583
|
+
/**
|
|
584
|
+
* Latin-1 transliteration of the first name. Required for non-Latin-1 names.
|
|
585
|
+
*/
|
|
586
|
+
transliterated_first_name?: string;
|
|
587
|
+
/**
|
|
588
|
+
* Latin-1 transliteration of the last name. Required for non-Latin-1 names.
|
|
589
|
+
*/
|
|
590
|
+
transliterated_last_name?: string;
|
|
591
|
+
/**
|
|
592
|
+
* Latin-1 transliteration of the middle name. Required for non-Latin-1 names.
|
|
593
|
+
*/
|
|
594
|
+
transliterated_middle_name?: string;
|
|
595
|
+
/**
|
|
596
|
+
* A postal address used in KYC and KYB data submission.
|
|
597
|
+
*/
|
|
598
|
+
transliterated_residential_address?: VerificationAddress;
|
|
599
|
+
/**
|
|
600
|
+
* When you verified this person against a database source (ISO 8601).
|
|
601
|
+
*/
|
|
602
|
+
verified_database_at?: (string & {}) | (string & {});
|
|
603
|
+
/**
|
|
604
|
+
* When you verified the government ID for this person (ISO 8601).
|
|
605
|
+
*/
|
|
606
|
+
verified_govid_at?: (string & {}) | (string & {});
|
|
607
|
+
/**
|
|
608
|
+
* When you verified proof of address for this person (ISO 8601).
|
|
609
|
+
*/
|
|
610
|
+
verified_proof_of_address_at?: (string & {}) | (string & {});
|
|
611
|
+
}
|
|
612
|
+
/**
|
|
613
|
+
* A supporting document for business verification.
|
|
614
|
+
*/
|
|
615
|
+
export interface KYBBusinessDocument {
|
|
616
|
+
/**
|
|
617
|
+
* Base64-encoded data URI of the document.
|
|
618
|
+
*/
|
|
619
|
+
file: string;
|
|
620
|
+
/**
|
|
621
|
+
* What this document evidences. Supports multiple purposes per file.
|
|
622
|
+
*/
|
|
623
|
+
purposes: Array<KYBDocumentPurpose>;
|
|
624
|
+
/**
|
|
625
|
+
* Document description. Required when "other" is one of the purposes.
|
|
626
|
+
*/
|
|
627
|
+
description?: string;
|
|
628
|
+
}
|
|
629
|
+
/**
|
|
630
|
+
* Legal structure of the business. Passthrough to the provider. See the
|
|
631
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
632
|
+
* for accepted values.
|
|
633
|
+
*/
|
|
634
|
+
export type KYBBusinessType = string;
|
|
635
|
+
/**
|
|
636
|
+
* What a supporting business document evidences. Passthrough to the provider. See
|
|
637
|
+
* the
|
|
638
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
639
|
+
* for accepted values.
|
|
640
|
+
*/
|
|
641
|
+
export type KYBDocumentPurpose = string;
|
|
642
|
+
/**
|
|
643
|
+
* Estimated annual revenue of the business, in USD buckets. Passthrough to the
|
|
644
|
+
* provider. See the
|
|
645
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
646
|
+
* for accepted values.
|
|
647
|
+
*/
|
|
648
|
+
export type KYBEstimatedAnnualRevenue = string;
|
|
649
|
+
/**
|
|
650
|
+
* A high-risk activity the business engages in. Passthrough to the provider. See
|
|
651
|
+
* the
|
|
652
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
653
|
+
* for accepted values.
|
|
654
|
+
*/
|
|
655
|
+
export type KYBHighRiskActivity = string;
|
|
656
|
+
/**
|
|
657
|
+
* A supporting document for an associated person.
|
|
658
|
+
*/
|
|
659
|
+
export interface KYBIndividualDocument {
|
|
660
|
+
/**
|
|
661
|
+
* Base64-encoded data URI of the document.
|
|
662
|
+
*/
|
|
663
|
+
file: string;
|
|
664
|
+
/**
|
|
665
|
+
* What this document evidences. Supports multiple purposes per file.
|
|
666
|
+
*/
|
|
667
|
+
purposes: Array<KYBIndividualDocumentPurpose>;
|
|
668
|
+
/**
|
|
669
|
+
* Document description. Required when "other" is one of the purposes.
|
|
670
|
+
*/
|
|
671
|
+
description?: string;
|
|
672
|
+
}
|
|
673
|
+
/**
|
|
674
|
+
* What a supporting document for an associated person evidences. Passthrough to
|
|
675
|
+
* the provider. See the
|
|
676
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
677
|
+
* for accepted values.
|
|
678
|
+
*/
|
|
679
|
+
export type KYBIndividualDocumentPurpose = string;
|
|
423
680
|
/**
|
|
424
681
|
* Request body for initiating a hosted KYB flow for an organization.
|
|
425
682
|
*/
|
|
@@ -453,6 +710,64 @@ export interface KYBLinksRequestBody {
|
|
|
453
710
|
*/
|
|
454
711
|
redirect_uri?: string;
|
|
455
712
|
}
|
|
713
|
+
/**
|
|
714
|
+
* Place of birth for an associated person.
|
|
715
|
+
*/
|
|
716
|
+
export interface KYBPlaceOfBirth {
|
|
717
|
+
/**
|
|
718
|
+
* ISO 3166-1 alpha-3 country code.
|
|
719
|
+
*/
|
|
720
|
+
country: string;
|
|
721
|
+
/**
|
|
722
|
+
* City of birth.
|
|
723
|
+
*/
|
|
724
|
+
city?: string;
|
|
725
|
+
}
|
|
726
|
+
/**
|
|
727
|
+
* A public exchange listing for the business.
|
|
728
|
+
*/
|
|
729
|
+
export interface KYBPubliclyTradedListing {
|
|
730
|
+
/**
|
|
731
|
+
* ISO 10383 market identifier code of the listing venue.
|
|
732
|
+
*/
|
|
733
|
+
market_identifier_code: string;
|
|
734
|
+
/**
|
|
735
|
+
* ISIN with dashes removed.
|
|
736
|
+
*/
|
|
737
|
+
stock_number: string;
|
|
738
|
+
/**
|
|
739
|
+
* Exchange ticker symbol.
|
|
740
|
+
*/
|
|
741
|
+
ticker: string;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* Details of the regulated activity a business is licensed to perform.
|
|
745
|
+
*/
|
|
746
|
+
export interface KYBRegulatedActivity {
|
|
747
|
+
/**
|
|
748
|
+
* License number issued by the regulator.
|
|
749
|
+
*/
|
|
750
|
+
license_number: string;
|
|
751
|
+
/**
|
|
752
|
+
* ISO 3166-1 alpha-3 country code of the primary regulator.
|
|
753
|
+
*/
|
|
754
|
+
primary_regulatory_authority_country: string;
|
|
755
|
+
/**
|
|
756
|
+
* Name of the primary regulator.
|
|
757
|
+
*/
|
|
758
|
+
primary_regulatory_authority_name: string;
|
|
759
|
+
/**
|
|
760
|
+
* Description of the regulated activities performed.
|
|
761
|
+
*/
|
|
762
|
+
regulated_activities_description: string;
|
|
763
|
+
}
|
|
764
|
+
/**
|
|
765
|
+
* Primary source of the funds the business will transact with. Passthrough to the
|
|
766
|
+
* provider. See the
|
|
767
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
768
|
+
* for accepted values.
|
|
769
|
+
*/
|
|
770
|
+
export type KYBSourceOfFunds = string;
|
|
456
771
|
/**
|
|
457
772
|
* List of KYB status snapshots, one per configured provider/environment.
|
|
458
773
|
*/
|
|
@@ -499,63 +814,216 @@ export interface KYBStatusResponse {
|
|
|
499
814
|
tos: KyxTosStatusDetail;
|
|
500
815
|
}
|
|
501
816
|
/**
|
|
502
|
-
*
|
|
817
|
+
* KYB verification data for headless submission. Fields are individually optional
|
|
818
|
+
* because the provider accepts partial submissions and grants endorsements once
|
|
819
|
+
* enough data has arrived; a partial submission can be completed by calling the
|
|
820
|
+
* endpoint again.
|
|
503
821
|
*/
|
|
504
|
-
export interface
|
|
822
|
+
export interface KYBSubmitData {
|
|
505
823
|
/**
|
|
506
|
-
*
|
|
824
|
+
* Primary purpose the business will use the account for. Passthrough to the
|
|
825
|
+
* provider. See the
|
|
826
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
827
|
+
* for accepted values.
|
|
507
828
|
*/
|
|
508
|
-
|
|
829
|
+
account_purpose?: KYBAccountPurpose;
|
|
509
830
|
/**
|
|
510
|
-
*
|
|
831
|
+
* Free-text purpose. Required when account_purpose is "other".
|
|
511
832
|
*/
|
|
512
|
-
|
|
833
|
+
account_purpose_other?: string;
|
|
513
834
|
/**
|
|
514
|
-
*
|
|
835
|
+
* Whether the business moves funds on behalf of third parties.
|
|
515
836
|
*/
|
|
516
|
-
|
|
837
|
+
acting_as_intermediary?: boolean;
|
|
517
838
|
/**
|
|
518
|
-
*
|
|
839
|
+
* Beneficial owners, control persons, and signers.
|
|
519
840
|
*/
|
|
520
|
-
|
|
521
|
-
}
|
|
522
|
-
/**
|
|
523
|
-
* An identity document for KYC verification.
|
|
524
|
-
*/
|
|
525
|
-
export interface KYCIdentifyingDocument {
|
|
841
|
+
associated_persons?: Array<KYBAssociatedPerson>;
|
|
526
842
|
/**
|
|
527
|
-
*
|
|
843
|
+
* Short summary of what the business does.
|
|
528
844
|
*/
|
|
529
|
-
|
|
845
|
+
business_description?: string;
|
|
530
846
|
/**
|
|
531
|
-
*
|
|
847
|
+
* 2022 NAICS codes describing the industries the business operates in.
|
|
532
848
|
*/
|
|
533
|
-
|
|
849
|
+
business_industry?: Array<string>;
|
|
534
850
|
/**
|
|
535
|
-
*
|
|
851
|
+
* Registered legal name as filed with government authorities.
|
|
536
852
|
*/
|
|
537
|
-
|
|
853
|
+
business_legal_name?: string;
|
|
538
854
|
/**
|
|
539
|
-
*
|
|
855
|
+
* Public trading name (DBA), if different from the legal name.
|
|
540
856
|
*/
|
|
541
|
-
|
|
857
|
+
business_trade_name?: string;
|
|
542
858
|
/**
|
|
543
|
-
*
|
|
859
|
+
* Legal structure of the business. Passthrough to the provider. See the
|
|
860
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
861
|
+
* for accepted values.
|
|
544
862
|
*/
|
|
545
|
-
|
|
863
|
+
business_type?: KYBBusinessType;
|
|
546
864
|
/**
|
|
547
|
-
*
|
|
865
|
+
* Description of the AML and sanctions screening controls in place.
|
|
548
866
|
*/
|
|
549
|
-
|
|
867
|
+
compliance_screening_explanation?: string;
|
|
550
868
|
/**
|
|
551
|
-
*
|
|
869
|
+
* Whether the business conducts money services.
|
|
552
870
|
*/
|
|
553
|
-
|
|
871
|
+
conducts_money_services?: boolean;
|
|
872
|
+
/**
|
|
873
|
+
* Description of the money services conducted.
|
|
874
|
+
*/
|
|
875
|
+
conducts_money_services_description?: string;
|
|
876
|
+
/**
|
|
877
|
+
* Whether money services are conducted through the provider. Requires a
|
|
878
|
+
* flow_of_funds document when true.
|
|
879
|
+
*/
|
|
880
|
+
conducts_money_services_using_bridge?: boolean;
|
|
881
|
+
/**
|
|
882
|
+
* Supporting documents for verification.
|
|
883
|
+
*/
|
|
884
|
+
documents?: Array<KYBBusinessDocument>;
|
|
885
|
+
/**
|
|
886
|
+
* Primary business email address.
|
|
887
|
+
*/
|
|
888
|
+
email?: string;
|
|
889
|
+
/**
|
|
890
|
+
* Estimated annual revenue of the business, in USD buckets. Passthrough to the
|
|
891
|
+
* provider. See the
|
|
892
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
893
|
+
* for accepted values.
|
|
894
|
+
*/
|
|
895
|
+
estimated_annual_revenue_usd?: KYBEstimatedAnnualRevenue;
|
|
896
|
+
/**
|
|
897
|
+
* Expected monthly payment volume in USD. Required for high-risk businesses.
|
|
898
|
+
*/
|
|
899
|
+
expected_monthly_payments_usd?: number;
|
|
900
|
+
/**
|
|
901
|
+
* Whether the business is tax-registered outside its country of incorporation.
|
|
902
|
+
*/
|
|
903
|
+
has_foreign_tax_registration?: boolean;
|
|
904
|
+
/**
|
|
905
|
+
* Whether an intermediate entity owner holds 25% or more of the business.
|
|
906
|
+
*/
|
|
907
|
+
has_material_intermediary_ownership?: boolean;
|
|
908
|
+
/**
|
|
909
|
+
* High-risk activities the business engages in.
|
|
910
|
+
*/
|
|
911
|
+
high_risk_activities?: Array<KYBHighRiskActivity>;
|
|
912
|
+
/**
|
|
913
|
+
* Explanation of the high-risk activities. Required unless the only value is
|
|
914
|
+
* "none_of_the_above".
|
|
915
|
+
*/
|
|
916
|
+
high_risk_activities_explanation?: string;
|
|
917
|
+
/**
|
|
918
|
+
* Business tax and registration identifiers.
|
|
919
|
+
*/
|
|
920
|
+
identifying_information?: Array<VerificationDocument>;
|
|
921
|
+
/**
|
|
922
|
+
* Date of incorporation in YYYY-MM-DD format.
|
|
923
|
+
*/
|
|
924
|
+
incorporation_date?: string;
|
|
925
|
+
/**
|
|
926
|
+
* Whether the business is a decentralized autonomous organization.
|
|
927
|
+
*/
|
|
928
|
+
is_dao?: boolean;
|
|
929
|
+
/**
|
|
930
|
+
* Result of a KYC/AML or OFAC screen you performed and are relying on the provider
|
|
931
|
+
* to accept, honoured only for developers enrolled in reliance.
|
|
932
|
+
*/
|
|
933
|
+
kyb_screen?: KyxScreen;
|
|
934
|
+
/**
|
|
935
|
+
* Result of a KYC/AML or OFAC screen you performed and are relying on the provider
|
|
936
|
+
* to accept, honoured only for developers enrolled in reliance.
|
|
937
|
+
*/
|
|
938
|
+
ofac_screen?: KyxScreen;
|
|
939
|
+
/**
|
|
940
|
+
* Whether the business operates in prohibited jurisdictions.
|
|
941
|
+
*/
|
|
942
|
+
operates_in_prohibited_countries?: boolean;
|
|
943
|
+
/**
|
|
944
|
+
* Additional websites and social handles.
|
|
945
|
+
*/
|
|
946
|
+
other_websites?: Array<string>;
|
|
947
|
+
/**
|
|
948
|
+
* Ownership percentage at which a person is treated as a beneficial owner.
|
|
949
|
+
*/
|
|
950
|
+
ownership_threshold?: number;
|
|
951
|
+
/**
|
|
952
|
+
* Business phone number in E.164 format.
|
|
953
|
+
*/
|
|
954
|
+
phone?: string;
|
|
955
|
+
/**
|
|
956
|
+
* A postal address used in KYC and KYB data submission.
|
|
957
|
+
*/
|
|
958
|
+
physical_address?: VerificationAddress;
|
|
959
|
+
/**
|
|
960
|
+
* Primary website. If omitted, a proof_of_nature_of_business document is required.
|
|
961
|
+
*/
|
|
962
|
+
primary_website?: string;
|
|
963
|
+
/**
|
|
964
|
+
* Public exchange listings for the business.
|
|
965
|
+
*/
|
|
966
|
+
publicly_traded_listings?: Array<KYBPubliclyTradedListing>;
|
|
967
|
+
/**
|
|
968
|
+
* A postal address used in KYC and KYB data submission.
|
|
969
|
+
*/
|
|
970
|
+
registered_address?: VerificationAddress;
|
|
971
|
+
/**
|
|
972
|
+
* Details of the regulated activity a business is licensed to perform.
|
|
973
|
+
*/
|
|
974
|
+
regulated_activity?: KYBRegulatedActivity;
|
|
975
|
+
/**
|
|
976
|
+
* Primary source of the funds the business will transact with. Passthrough to the
|
|
977
|
+
* provider. See the
|
|
978
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
979
|
+
* for accepted values.
|
|
980
|
+
*/
|
|
981
|
+
source_of_funds?: KYBSourceOfFunds;
|
|
982
|
+
/**
|
|
983
|
+
* Free-text detail on the source of funds. Required for high-risk businesses.
|
|
984
|
+
*/
|
|
985
|
+
source_of_funds_description?: string;
|
|
986
|
+
/**
|
|
987
|
+
* Latin-1 transliteration of the legal name. Required for non-Latin-1 names.
|
|
988
|
+
*/
|
|
989
|
+
transliterated_business_legal_name?: string;
|
|
990
|
+
/**
|
|
991
|
+
* Latin-1 transliteration of the trade name. Required for non-Latin-1 names.
|
|
992
|
+
*/
|
|
993
|
+
transliterated_business_trade_name?: string;
|
|
994
|
+
/**
|
|
995
|
+
* A postal address used in KYC and KYB data submission.
|
|
996
|
+
*/
|
|
997
|
+
transliterated_physical_address?: VerificationAddress;
|
|
998
|
+
/**
|
|
999
|
+
* A postal address used in KYC and KYB data submission.
|
|
1000
|
+
*/
|
|
1001
|
+
transliterated_registered_address?: VerificationAddress;
|
|
1002
|
+
/**
|
|
1003
|
+
* When you verified the business against a database source (ISO 8601).
|
|
1004
|
+
*/
|
|
1005
|
+
verified_database_at?: (string & {}) | (string & {});
|
|
1006
|
+
/**
|
|
1007
|
+
* When you verified the business registration documents (ISO 8601).
|
|
1008
|
+
*/
|
|
1009
|
+
verified_govid_at?: (string & {}) | (string & {});
|
|
1010
|
+
/**
|
|
1011
|
+
* When you verified the business proof of address (ISO 8601), required for EEA
|
|
1012
|
+
* customers and SEPA rails under reliance.
|
|
1013
|
+
*/
|
|
1014
|
+
verified_proof_of_address_at?: (string & {}) | (string & {});
|
|
554
1015
|
}
|
|
555
1016
|
/**
|
|
556
|
-
* Request body for
|
|
1017
|
+
* Request body for headless KYB data submission.
|
|
557
1018
|
*/
|
|
558
|
-
export interface
|
|
1019
|
+
export interface KYBSubmitRequestBody {
|
|
1020
|
+
/**
|
|
1021
|
+
* KYB verification data for headless submission. Fields are individually optional
|
|
1022
|
+
* because the provider accepts partial submissions and grants endorsements once
|
|
1023
|
+
* enough data has arrived; a partial submission can be completed by calling the
|
|
1024
|
+
* endpoint again.
|
|
1025
|
+
*/
|
|
1026
|
+
data: KYBSubmitData;
|
|
559
1027
|
/**
|
|
560
1028
|
* KYC/KYB provider identifier.
|
|
561
1029
|
*/
|
|
@@ -565,50 +1033,63 @@ export interface KYCLinksRequestBody {
|
|
|
565
1033
|
*/
|
|
566
1034
|
client_agreement_id?: string;
|
|
567
1035
|
/**
|
|
568
|
-
*
|
|
569
|
-
*/
|
|
570
|
-
email?: string;
|
|
571
|
-
/**
|
|
572
|
-
* Endorsements to request during KYC.
|
|
1036
|
+
* Endorsements to request during KYB.
|
|
573
1037
|
*/
|
|
574
1038
|
endorsements?: Array<KyxEndorsementName>;
|
|
575
1039
|
/**
|
|
576
1040
|
* Provider environment (production or sandbox).
|
|
577
1041
|
*/
|
|
578
1042
|
environment?: KyxEnvironment;
|
|
1043
|
+
}
|
|
1044
|
+
/**
|
|
1045
|
+
* Request body for initiating Terms of Service acceptance for an organization.
|
|
1046
|
+
*/
|
|
1047
|
+
export interface KYBTosRequestBody {
|
|
579
1048
|
/**
|
|
580
|
-
*
|
|
1049
|
+
* Email address for the organization.
|
|
581
1050
|
*/
|
|
582
|
-
|
|
1051
|
+
email: string;
|
|
1052
|
+
/**
|
|
1053
|
+
* KYC/KYB provider identifier.
|
|
1054
|
+
*/
|
|
1055
|
+
provider: KyxProvider;
|
|
1056
|
+
/**
|
|
1057
|
+
* Legal name of the business.
|
|
1058
|
+
*/
|
|
1059
|
+
business_name?: string;
|
|
1060
|
+
/**
|
|
1061
|
+
* Provider environment (production or sandbox).
|
|
1062
|
+
*/
|
|
1063
|
+
environment?: KyxEnvironment;
|
|
583
1064
|
}
|
|
584
1065
|
/**
|
|
585
|
-
*
|
|
1066
|
+
* Request body for initiating a hosted KYC flow.
|
|
586
1067
|
*/
|
|
587
|
-
export interface
|
|
1068
|
+
export interface KYCLinksRequestBody {
|
|
588
1069
|
/**
|
|
589
|
-
*
|
|
1070
|
+
* KYC/KYB provider identifier.
|
|
590
1071
|
*/
|
|
591
|
-
|
|
1072
|
+
provider: KyxProvider;
|
|
592
1073
|
/**
|
|
593
|
-
*
|
|
1074
|
+
* Client-side agreement ID for ToS acceptance.
|
|
594
1075
|
*/
|
|
595
|
-
|
|
1076
|
+
client_agreement_id?: string;
|
|
596
1077
|
/**
|
|
597
|
-
*
|
|
1078
|
+
* Email address for the KYC session.
|
|
598
1079
|
*/
|
|
599
|
-
|
|
1080
|
+
email?: string;
|
|
600
1081
|
/**
|
|
601
|
-
*
|
|
1082
|
+
* Endorsements to request during KYC.
|
|
602
1083
|
*/
|
|
603
|
-
|
|
1084
|
+
endorsements?: Array<KyxEndorsementName>;
|
|
604
1085
|
/**
|
|
605
|
-
*
|
|
1086
|
+
* Provider environment (production or sandbox).
|
|
606
1087
|
*/
|
|
607
|
-
|
|
1088
|
+
environment?: KyxEnvironment;
|
|
608
1089
|
/**
|
|
609
|
-
*
|
|
1090
|
+
* URI to redirect the user after completing KYC.
|
|
610
1091
|
*/
|
|
611
|
-
|
|
1092
|
+
redirect_uri?: string;
|
|
612
1093
|
}
|
|
613
1094
|
/**
|
|
614
1095
|
* List of KYC status snapshots, one per configured provider/environment.
|
|
@@ -654,6 +1135,10 @@ export interface KYCStatusResponse {
|
|
|
654
1135
|
* Terms of Service acceptance status for a KYC or KYB flow.
|
|
655
1136
|
*/
|
|
656
1137
|
tos: KyxTosStatusDetail;
|
|
1138
|
+
/**
|
|
1139
|
+
* Stripe Issuing cardholder ID assigned by Bridge for this user.
|
|
1140
|
+
*/
|
|
1141
|
+
stripe_cardholder_id?: string;
|
|
657
1142
|
}
|
|
658
1143
|
/**
|
|
659
1144
|
* KYC verification data for headless submission.
|
|
@@ -662,31 +1147,90 @@ export interface KYCSubmitData {
|
|
|
662
1147
|
/**
|
|
663
1148
|
* Date of birth in YYYY-MM-DD format.
|
|
664
1149
|
*/
|
|
665
|
-
date_of_birth
|
|
1150
|
+
date_of_birth?: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* Email address.
|
|
1153
|
+
*/
|
|
1154
|
+
email?: string;
|
|
666
1155
|
/**
|
|
667
1156
|
* Legal first name.
|
|
668
1157
|
*/
|
|
669
|
-
first_name
|
|
1158
|
+
first_name?: string;
|
|
670
1159
|
/**
|
|
671
1160
|
* Identifying documents.
|
|
672
1161
|
*/
|
|
673
|
-
identifying_information
|
|
1162
|
+
identifying_information?: Array<VerificationDocument>;
|
|
1163
|
+
/**
|
|
1164
|
+
* Result of a KYC/AML or OFAC screen you performed and are relying on the provider
|
|
1165
|
+
* to accept, honoured only for developers enrolled in reliance.
|
|
1166
|
+
*/
|
|
1167
|
+
kyc_screen?: KyxScreen;
|
|
674
1168
|
/**
|
|
675
1169
|
* Legal last name.
|
|
676
1170
|
*/
|
|
677
|
-
last_name
|
|
1171
|
+
last_name?: string;
|
|
678
1172
|
/**
|
|
679
|
-
*
|
|
1173
|
+
* Legal middle name.
|
|
680
1174
|
*/
|
|
681
|
-
|
|
1175
|
+
middle_name?: string;
|
|
682
1176
|
/**
|
|
683
|
-
*
|
|
1177
|
+
* ISO 3166-1 alpha-3 codes for all nationalities held.
|
|
684
1178
|
*/
|
|
685
|
-
|
|
1179
|
+
nationalities?: Array<string>;
|
|
1180
|
+
/**
|
|
1181
|
+
* Attests the user is a nonresident alien to satisfy identification without a US
|
|
1182
|
+
* tax ID (must be enabled for you).
|
|
1183
|
+
*/
|
|
1184
|
+
nonresident_alien_attestation?: boolean;
|
|
1185
|
+
/**
|
|
1186
|
+
* Result of a KYC/AML or OFAC screen you performed and are relying on the provider
|
|
1187
|
+
* to accept, honoured only for developers enrolled in reliance.
|
|
1188
|
+
*/
|
|
1189
|
+
ofac_screen?: KyxScreen;
|
|
686
1190
|
/**
|
|
687
1191
|
* Phone number in E.164 format.
|
|
688
1192
|
*/
|
|
689
1193
|
phone?: string;
|
|
1194
|
+
/**
|
|
1195
|
+
* A postal address used in KYC and KYB data submission.
|
|
1196
|
+
*/
|
|
1197
|
+
residential_address?: VerificationAddress;
|
|
1198
|
+
/**
|
|
1199
|
+
* Stripe Link shared data ID that supplies name, date of birth, address, and US
|
|
1200
|
+
* SSN (omit those fields); retrieval errors surface in endorsements[].issues.
|
|
1201
|
+
*/
|
|
1202
|
+
stripe_link_shared_data_id?: string;
|
|
1203
|
+
/**
|
|
1204
|
+
* Latin-1 transliteration of the first name. Required for non-Latin-1 names.
|
|
1205
|
+
*/
|
|
1206
|
+
transliterated_first_name?: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* Latin-1 transliteration of the last name. Required for non-Latin-1 names.
|
|
1209
|
+
*/
|
|
1210
|
+
transliterated_last_name?: string;
|
|
1211
|
+
/**
|
|
1212
|
+
* Latin-1 transliteration of the middle name. Required for non-Latin-1 names.
|
|
1213
|
+
*/
|
|
1214
|
+
transliterated_middle_name?: string;
|
|
1215
|
+
/**
|
|
1216
|
+
* A postal address used in KYC and KYB data submission.
|
|
1217
|
+
*/
|
|
1218
|
+
transliterated_residential_address?: VerificationAddress;
|
|
1219
|
+
/**
|
|
1220
|
+
* When you verified the user against a database source (ISO 8601), which loosens
|
|
1221
|
+
* the identifying-document requirement under reliance.
|
|
1222
|
+
*/
|
|
1223
|
+
verified_database_at?: (string & {}) | (string & {});
|
|
1224
|
+
/**
|
|
1225
|
+
* When you verified the government ID (ISO 8601), which loosens the
|
|
1226
|
+
* identifying-document requirement under reliance.
|
|
1227
|
+
*/
|
|
1228
|
+
verified_govid_at?: (string & {}) | (string & {});
|
|
1229
|
+
/**
|
|
1230
|
+
* When you verified proof of address (ISO 8601), required for EEA customers and
|
|
1231
|
+
* SEPA rails under reliance.
|
|
1232
|
+
*/
|
|
1233
|
+
verified_proof_of_address_at?: (string & {}) | (string & {});
|
|
690
1234
|
}
|
|
691
1235
|
/**
|
|
692
1236
|
* Request body for headless KYC data submission.
|
|
@@ -742,6 +1286,10 @@ export type KyxCapabilityStatus = string;
|
|
|
742
1286
|
* An endorsement with its approval status and missing requirements.
|
|
743
1287
|
*/
|
|
744
1288
|
export interface KyxEndorsement {
|
|
1289
|
+
/**
|
|
1290
|
+
* Provider issue codes, or null if none.
|
|
1291
|
+
*/
|
|
1292
|
+
issues: Array<string> | null;
|
|
745
1293
|
/**
|
|
746
1294
|
* Missing requirements, or null if complete.
|
|
747
1295
|
*/
|
|
@@ -775,6 +1323,24 @@ export type KyxProvider = 'bridge';
|
|
|
775
1323
|
* KYC/KYB status for the user.
|
|
776
1324
|
*/
|
|
777
1325
|
export type KyxProviderStatus = string;
|
|
1326
|
+
/**
|
|
1327
|
+
* Result of a KYC/AML or OFAC screen you performed and are relying on the provider
|
|
1328
|
+
* to accept, honoured only for developers enrolled in reliance.
|
|
1329
|
+
*/
|
|
1330
|
+
export interface KyxScreen {
|
|
1331
|
+
/**
|
|
1332
|
+
* Outcome of a screen performed under KYC/KYB reliance.
|
|
1333
|
+
*/
|
|
1334
|
+
result: KyxScreenResult;
|
|
1335
|
+
/**
|
|
1336
|
+
* When the screen was performed (ISO 8601 date or date-time).
|
|
1337
|
+
*/
|
|
1338
|
+
screened_at: (string & {}) | (string & {});
|
|
1339
|
+
}
|
|
1340
|
+
/**
|
|
1341
|
+
* Outcome of a screen performed under KYC/KYB reliance.
|
|
1342
|
+
*/
|
|
1343
|
+
export type KyxScreenResult = 'passed' | 'failed';
|
|
778
1344
|
/**
|
|
779
1345
|
* Request body for initiating Terms of Service acceptance.
|
|
780
1346
|
*/
|
|
@@ -1005,7 +1571,17 @@ export interface PayoutDestination {
|
|
|
1005
1571
|
* The ID of a previously registered external fiat account to pay out to.
|
|
1006
1572
|
*/
|
|
1007
1573
|
fiat_account_id: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* A fiat payment rail a payout can settle over. `ach` is a standard ACH credit to
|
|
1576
|
+
* the destination account.
|
|
1577
|
+
*/
|
|
1578
|
+
payment_rail?: PayoutPaymentRail;
|
|
1008
1579
|
}
|
|
1580
|
+
/**
|
|
1581
|
+
* A fiat payment rail a payout can settle over. `ach` is a standard ACH credit to
|
|
1582
|
+
* the destination account.
|
|
1583
|
+
*/
|
|
1584
|
+
export type PayoutPaymentRail = 'ach' | 'ach_same_day' | 'wire' | 'fednow' | 'sepa' | 'faster_payments' | 'pix';
|
|
1009
1585
|
/**
|
|
1010
1586
|
* The source crypto asset, chain, and amount for a payout.
|
|
1011
1587
|
*/
|
|
@@ -1023,7 +1599,71 @@ export interface PayoutSource {
|
|
|
1023
1599
|
*/
|
|
1024
1600
|
chain: string;
|
|
1025
1601
|
}
|
|
1602
|
+
/**
|
|
1603
|
+
* A postal address used in KYC and KYB data submission.
|
|
1604
|
+
*/
|
|
1605
|
+
export interface VerificationAddress {
|
|
1606
|
+
/**
|
|
1607
|
+
* City.
|
|
1608
|
+
*/
|
|
1609
|
+
city: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* ISO 3166-1 alpha-3 country code.
|
|
1612
|
+
*/
|
|
1613
|
+
country: string;
|
|
1614
|
+
/**
|
|
1615
|
+
* Street address line 1.
|
|
1616
|
+
*/
|
|
1617
|
+
street_line_1: string;
|
|
1618
|
+
/**
|
|
1619
|
+
* Postal code. Required for countries that use them.
|
|
1620
|
+
*/
|
|
1621
|
+
postal_code?: string;
|
|
1622
|
+
/**
|
|
1623
|
+
* Street address line 2.
|
|
1624
|
+
*/
|
|
1625
|
+
street_line_2?: string;
|
|
1626
|
+
/**
|
|
1627
|
+
* ISO 3166-2 state or province code. Required for US addresses.
|
|
1628
|
+
*/
|
|
1629
|
+
subdivision?: string;
|
|
1630
|
+
}
|
|
1631
|
+
/**
|
|
1632
|
+
* An identifying document for KYC or KYB verification. Also used for business
|
|
1633
|
+
* identifiers such as tax and registration numbers, for which the image and
|
|
1634
|
+
* expiration fields do not apply.
|
|
1635
|
+
*/
|
|
1636
|
+
export interface VerificationDocument {
|
|
1637
|
+
/**
|
|
1638
|
+
* ISO 3166-1 alpha-3 issuing country code.
|
|
1639
|
+
*/
|
|
1640
|
+
issuing_country: string;
|
|
1641
|
+
/**
|
|
1642
|
+
* Document type identifier.
|
|
1643
|
+
*/
|
|
1644
|
+
type: string;
|
|
1645
|
+
/**
|
|
1646
|
+
* Document description.
|
|
1647
|
+
*/
|
|
1648
|
+
description?: string;
|
|
1649
|
+
/**
|
|
1650
|
+
* Document expiration date.
|
|
1651
|
+
*/
|
|
1652
|
+
expiration?: string;
|
|
1653
|
+
/**
|
|
1654
|
+
* Base64-encoded back image.
|
|
1655
|
+
*/
|
|
1656
|
+
image_back?: string;
|
|
1657
|
+
/**
|
|
1658
|
+
* Base64-encoded front image.
|
|
1659
|
+
*/
|
|
1660
|
+
image_front?: string;
|
|
1661
|
+
/**
|
|
1662
|
+
* Document number.
|
|
1663
|
+
*/
|
|
1664
|
+
number?: string;
|
|
1665
|
+
}
|
|
1026
1666
|
export declare namespace Fiat {
|
|
1027
|
-
export { type BridgeCreateExternalFiatAccountRequestBody as BridgeCreateExternalFiatAccountRequestBody, type BridgeCreateFiatDepositAccountRequestBody as BridgeCreateFiatDepositAccountRequestBody, type BridgeExternalFiatAccount as BridgeExternalFiatAccount, type BridgeFiatDepositAccount as BridgeFiatDepositAccount, type BridgeOrganizationExternalFiatAccount as BridgeOrganizationExternalFiatAccount, type CreateExternalFiatAccountRequestBody as CreateExternalFiatAccountRequestBody, type CreateFiatDepositAccountRequestBody as CreateFiatDepositAccountRequestBody, type CreateFiatDepositAccountSource as CreateFiatDepositAccountSource, type CreatePayoutRequestBody as CreatePayoutRequestBody, type ExternalFiatAccount as ExternalFiatAccount, type ExternalFiatAccountAddress as ExternalFiatAccountAddress, type ExternalFiatAccountData as ExternalFiatAccountData, type ExternalFiatAccountGBData as ExternalFiatAccountGBData, type ExternalFiatAccountIbanData as ExternalFiatAccountIbanData, type ExternalFiatAccountPixData as ExternalFiatAccountPixData, type ExternalFiatAccountResponse as ExternalFiatAccountResponse, type ExternalFiatAccountSwiftCategory as ExternalFiatAccountSwiftCategory, type ExternalFiatAccountSwiftData as ExternalFiatAccountSwiftData, type ExternalFiatAccountSwiftPurposeOfFunds as ExternalFiatAccountSwiftPurposeOfFunds, type ExternalFiatAccountUsData as ExternalFiatAccountUsData, type FiatCurrency as FiatCurrency, type FiatDepositAccount as FiatDepositAccount, type FiatDepositAccountDestination as FiatDepositAccountDestination, type FiatDepositAccountResponse as FiatDepositAccountResponse, type FiatDepositAccountSource as FiatDepositAccountSource, type FiatDepositAccountStatus as FiatDepositAccountStatus, type FiatDepositInstructions as FiatDepositInstructions, type FiatPaymentRail as FiatPaymentRail, type KYBLinksRequestBody as KYBLinksRequestBody, type KYBStatusListResponse as KYBStatusListResponse, type KYBStatusResponse as KYBStatusResponse, type
|
|
1667
|
+
export { type BridgeCreateExternalFiatAccountRequestBody as BridgeCreateExternalFiatAccountRequestBody, type BridgeCreateFiatDepositAccountRequestBody as BridgeCreateFiatDepositAccountRequestBody, type BridgeExternalFiatAccount as BridgeExternalFiatAccount, type BridgeFiatDepositAccount as BridgeFiatDepositAccount, type BridgeOrganizationExternalFiatAccount as BridgeOrganizationExternalFiatAccount, type CreateExternalFiatAccountRequestBody as CreateExternalFiatAccountRequestBody, type CreateFiatDepositAccountRequestBody as CreateFiatDepositAccountRequestBody, type CreateFiatDepositAccountSource as CreateFiatDepositAccountSource, type CreatePayoutRequestBody as CreatePayoutRequestBody, type DeveloperFeePercent as DeveloperFeePercent, type ExternalFiatAccount as ExternalFiatAccount, type ExternalFiatAccountAddress as ExternalFiatAccountAddress, type ExternalFiatAccountBusinessOwner as ExternalFiatAccountBusinessOwner, type ExternalFiatAccountData as ExternalFiatAccountData, type ExternalFiatAccountGBData as ExternalFiatAccountGBData, type ExternalFiatAccountIbanData as ExternalFiatAccountIbanData, type ExternalFiatAccountIndividualOwner as ExternalFiatAccountIndividualOwner, type ExternalFiatAccountOwner as ExternalFiatAccountOwner, type ExternalFiatAccountPixData as ExternalFiatAccountPixData, type ExternalFiatAccountResponse as ExternalFiatAccountResponse, type ExternalFiatAccountSwiftCategory as ExternalFiatAccountSwiftCategory, type ExternalFiatAccountSwiftData as ExternalFiatAccountSwiftData, type ExternalFiatAccountSwiftPurposeOfFunds as ExternalFiatAccountSwiftPurposeOfFunds, type ExternalFiatAccountUsData as ExternalFiatAccountUsData, type FiatCurrency as FiatCurrency, type FiatDepositAccount as FiatDepositAccount, type FiatDepositAccountDestination as FiatDepositAccountDestination, type FiatDepositAccountResponse as FiatDepositAccountResponse, type FiatDepositAccountSource as FiatDepositAccountSource, type FiatDepositAccountStatus as FiatDepositAccountStatus, type FiatDepositInstructions as FiatDepositInstructions, type FiatPaymentRail as FiatPaymentRail, type KYBAccountPurpose as KYBAccountPurpose, type KYBAssociatedPerson as KYBAssociatedPerson, type KYBBusinessDocument as KYBBusinessDocument, type KYBBusinessType as KYBBusinessType, type KYBDocumentPurpose as KYBDocumentPurpose, type KYBEstimatedAnnualRevenue as KYBEstimatedAnnualRevenue, type KYBHighRiskActivity as KYBHighRiskActivity, type KYBIndividualDocument as KYBIndividualDocument, type KYBIndividualDocumentPurpose as KYBIndividualDocumentPurpose, type KYBLinksRequestBody as KYBLinksRequestBody, type KYBPlaceOfBirth as KYBPlaceOfBirth, type KYBPubliclyTradedListing as KYBPubliclyTradedListing, type KYBRegulatedActivity as KYBRegulatedActivity, type KYBSourceOfFunds as KYBSourceOfFunds, type KYBStatusListResponse as KYBStatusListResponse, type KYBStatusResponse as KYBStatusResponse, type KYBSubmitData as KYBSubmitData, type KYBSubmitRequestBody as KYBSubmitRequestBody, type KYBTosRequestBody as KYBTosRequestBody, type KYCLinksRequestBody as KYCLinksRequestBody, type KYCStatusListResponse as KYCStatusListResponse, type KYCStatusResponse as KYCStatusResponse, type KYCSubmitData as KYCSubmitData, type KYCSubmitRequestBody as KYCSubmitRequestBody, type KyxCapabilities as KyxCapabilities, type KyxCapabilityStatus as KyxCapabilityStatus, type KyxEndorsement as KyxEndorsement, type KyxEndorsementName as KyxEndorsementName, type KyxEndorsementStatus as KyxEndorsementStatus, type KyxEnvironment as KyxEnvironment, type KyxProvider as KyxProvider, type KyxProviderStatus as KyxProviderStatus, type KyxScreen as KyxScreen, type KyxScreenResult as KyxScreenResult, type KyxTosRequestBody as KyxTosRequestBody, type KyxTosResponse as KyxTosResponse, type KyxTosStatus as KyxTosStatus, type KyxTosStatusDetail as KyxTosStatusDetail, type KyxVerificationStatus as KyxVerificationStatus, type KyxVerificationStatusDetail as KyxVerificationStatusDetail, type ListExternalFiatAccountsResponse as ListExternalFiatAccountsResponse, type ListFiatDepositAccountsResponse as ListFiatDepositAccountsResponse, type ListOrganizationExternalFiatAccountsResponse as ListOrganizationExternalFiatAccountsResponse, type OfframpDepositInstructions as OfframpDepositInstructions, type OfframpResponse as OfframpResponse, type OnrampAsset as OnrampAsset, type OnrampChain as OnrampChain, type OnrampDepositInstructions as OnrampDepositInstructions, type OnrampKYCResponse as OnrampKYCResponse, type OnrampKYCStatus as OnrampKYCStatus, type OnrampResponse as OnrampResponse, type OnrampTransferStatus as OnrampTransferStatus, type OrganizationExternalFiatAccount as OrganizationExternalFiatAccount, type OrganizationExternalFiatAccountResponse as OrganizationExternalFiatAccountResponse, type PayoutDestination as PayoutDestination, type PayoutPaymentRail as PayoutPaymentRail, type PayoutSource as PayoutSource, type VerificationAddress as VerificationAddress, type VerificationDocument as VerificationDocument, };
|
|
1028
1668
|
}
|
|
1029
1669
|
//# sourceMappingURL=fiat.d.mts.map
|