@privy-io/api-types 0.22.0 → 0.23.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 +11 -0
- package/client.d.mts +6 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +6 -6
- package/client.d.ts.map +1 -1
- package/client.js.map +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/cards.d.mts +4 -0
- package/resources/cards.d.mts.map +1 -1
- package/resources/cards.d.ts +4 -0
- package/resources/cards.d.ts.map +1 -1
- package/resources/fiat.d.mts +525 -61
- package/resources/fiat.d.mts.map +1 -1
- package/resources/fiat.d.ts +525 -61
- package/resources/fiat.d.ts.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/wallet-automations.d.mts +10 -8
- package/resources/wallet-automations.d.mts.map +1 -1
- package/resources/wallet-automations.d.ts +10 -8
- package/resources/wallet-automations.d.ts.map +1 -1
- package/resources/wallets/actions.d.mts +7 -0
- package/resources/wallets/actions.d.mts.map +1 -1
- package/resources/wallets/actions.d.ts +7 -0
- package/resources/wallets/actions.d.ts.map +1 -1
- package/resources/wallets/index.d.mts +1 -1
- package/resources/wallets/index.d.mts.map +1 -1
- package/resources/wallets/index.d.ts +1 -1
- 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/wallets.d.mts +228 -9
- package/resources/wallets/wallets.d.mts.map +1 -1
- package/resources/wallets/wallets.d.ts +228 -9
- 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 +14 -14
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +14 -14
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +64 -6
- package/src/resources/accounts.ts +0 -10
- package/src/resources/cards.ts +5 -0
- package/src/resources/fiat.ts +637 -63
- package/src/resources/index.ts +32 -3
- package/src/resources/wallet-automations.ts +11 -9
- package/src/resources/wallets/actions.ts +8 -0
- package/src/resources/wallets/index.ts +14 -0
- package/src/resources/wallets/wallets.ts +287 -10
- package/src/resources/webhooks.ts +15 -15
- 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.ts
CHANGED
|
@@ -420,6 +420,176 @@ export interface FiatDepositInstructions {
|
|
|
420
420
|
* Supported fiat payment rails.
|
|
421
421
|
*/
|
|
422
422
|
export type FiatPaymentRail = 'sepa' | 'ach_push' | 'wire' | 'fednow' | 'faster_payments';
|
|
423
|
+
/**
|
|
424
|
+
* Primary purpose the business will use the account for. Passthrough to the
|
|
425
|
+
* provider. See the
|
|
426
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
427
|
+
* for accepted values.
|
|
428
|
+
*/
|
|
429
|
+
export type KYBAccountPurpose = string;
|
|
430
|
+
/**
|
|
431
|
+
* A beneficial owner, control person, or signer associated with the business. At
|
|
432
|
+
* least one of has_ownership, has_control, or is_signer must be true, and the
|
|
433
|
+
* business must have at least one control person and one signer.
|
|
434
|
+
*/
|
|
435
|
+
export interface KYBAssociatedPerson {
|
|
436
|
+
/**
|
|
437
|
+
* Date of birth in YYYY-MM-DD format. Must be 18 years or older.
|
|
438
|
+
*/
|
|
439
|
+
date_of_birth: string;
|
|
440
|
+
/**
|
|
441
|
+
* Email address.
|
|
442
|
+
*/
|
|
443
|
+
email: string;
|
|
444
|
+
/**
|
|
445
|
+
* Legal first name.
|
|
446
|
+
*/
|
|
447
|
+
first_name: string;
|
|
448
|
+
/**
|
|
449
|
+
* Whether this person is a control person.
|
|
450
|
+
*/
|
|
451
|
+
has_control: boolean;
|
|
452
|
+
/**
|
|
453
|
+
* Whether this person owns 25% or more of the business.
|
|
454
|
+
*/
|
|
455
|
+
has_ownership: boolean;
|
|
456
|
+
/**
|
|
457
|
+
* Identifying documents for this person.
|
|
458
|
+
*/
|
|
459
|
+
identifying_information: Array<VerificationDocument>;
|
|
460
|
+
/**
|
|
461
|
+
* Whether this person is a signer for the business.
|
|
462
|
+
*/
|
|
463
|
+
is_signer: boolean;
|
|
464
|
+
/**
|
|
465
|
+
* Legal last name.
|
|
466
|
+
*/
|
|
467
|
+
last_name: string;
|
|
468
|
+
/**
|
|
469
|
+
* A postal address used in KYC and KYB data submission.
|
|
470
|
+
*/
|
|
471
|
+
residential_address: VerificationAddress;
|
|
472
|
+
/**
|
|
473
|
+
* Supporting documents for this person, such as proof of address.
|
|
474
|
+
*/
|
|
475
|
+
documents?: Array<KYBIndividualDocument>;
|
|
476
|
+
/**
|
|
477
|
+
* Whether this person is a director.
|
|
478
|
+
*/
|
|
479
|
+
is_director?: boolean;
|
|
480
|
+
/**
|
|
481
|
+
* Legal middle name.
|
|
482
|
+
*/
|
|
483
|
+
middle_name?: string;
|
|
484
|
+
/**
|
|
485
|
+
* ISO 3166-1 alpha-3 codes for all nationalities held.
|
|
486
|
+
*/
|
|
487
|
+
nationalities?: Array<string>;
|
|
488
|
+
/**
|
|
489
|
+
* Percentage of the business this person owns.
|
|
490
|
+
*/
|
|
491
|
+
ownership_percentage?: number;
|
|
492
|
+
/**
|
|
493
|
+
* Phone number in E.164 format.
|
|
494
|
+
*/
|
|
495
|
+
phone?: string;
|
|
496
|
+
/**
|
|
497
|
+
* Place of birth for an associated person.
|
|
498
|
+
*/
|
|
499
|
+
place_of_birth?: KYBPlaceOfBirth;
|
|
500
|
+
/**
|
|
501
|
+
* Date the relationship with the business was established, in YYYY-MM-DD format.
|
|
502
|
+
*/
|
|
503
|
+
relationship_established_at?: string;
|
|
504
|
+
/**
|
|
505
|
+
* Job title. Required when has_control is true.
|
|
506
|
+
*/
|
|
507
|
+
title?: string;
|
|
508
|
+
/**
|
|
509
|
+
* Latin-1 transliteration of the first name. Required for non-Latin-1 names.
|
|
510
|
+
*/
|
|
511
|
+
transliterated_first_name?: string;
|
|
512
|
+
/**
|
|
513
|
+
* Latin-1 transliteration of the last name. Required for non-Latin-1 names.
|
|
514
|
+
*/
|
|
515
|
+
transliterated_last_name?: string;
|
|
516
|
+
/**
|
|
517
|
+
* Latin-1 transliteration of the middle name. Required for non-Latin-1 names.
|
|
518
|
+
*/
|
|
519
|
+
transliterated_middle_name?: string;
|
|
520
|
+
/**
|
|
521
|
+
* A postal address used in KYC and KYB data submission.
|
|
522
|
+
*/
|
|
523
|
+
transliterated_residential_address?: VerificationAddress;
|
|
524
|
+
}
|
|
525
|
+
/**
|
|
526
|
+
* A supporting document for business verification.
|
|
527
|
+
*/
|
|
528
|
+
export interface KYBBusinessDocument {
|
|
529
|
+
/**
|
|
530
|
+
* Base64-encoded data URI of the document.
|
|
531
|
+
*/
|
|
532
|
+
file: string;
|
|
533
|
+
/**
|
|
534
|
+
* What this document evidences. Supports multiple purposes per file.
|
|
535
|
+
*/
|
|
536
|
+
purposes: Array<KYBDocumentPurpose>;
|
|
537
|
+
/**
|
|
538
|
+
* Document description. Required when "other" is one of the purposes.
|
|
539
|
+
*/
|
|
540
|
+
description?: string;
|
|
541
|
+
}
|
|
542
|
+
/**
|
|
543
|
+
* Legal structure of the business. Passthrough to the provider. See the
|
|
544
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
545
|
+
* for accepted values.
|
|
546
|
+
*/
|
|
547
|
+
export type KYBBusinessType = string;
|
|
548
|
+
/**
|
|
549
|
+
* What a supporting business document evidences. Passthrough to the provider. See
|
|
550
|
+
* the
|
|
551
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
552
|
+
* for accepted values.
|
|
553
|
+
*/
|
|
554
|
+
export type KYBDocumentPurpose = string;
|
|
555
|
+
/**
|
|
556
|
+
* Estimated annual revenue of the business, in USD buckets. Passthrough to the
|
|
557
|
+
* provider. See the
|
|
558
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
559
|
+
* for accepted values.
|
|
560
|
+
*/
|
|
561
|
+
export type KYBEstimatedAnnualRevenue = string;
|
|
562
|
+
/**
|
|
563
|
+
* A high-risk activity the business engages in. Passthrough to the provider. See
|
|
564
|
+
* the
|
|
565
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
566
|
+
* for accepted values.
|
|
567
|
+
*/
|
|
568
|
+
export type KYBHighRiskActivity = string;
|
|
569
|
+
/**
|
|
570
|
+
* A supporting document for an associated person.
|
|
571
|
+
*/
|
|
572
|
+
export interface KYBIndividualDocument {
|
|
573
|
+
/**
|
|
574
|
+
* Base64-encoded data URI of the document.
|
|
575
|
+
*/
|
|
576
|
+
file: string;
|
|
577
|
+
/**
|
|
578
|
+
* What this document evidences. Supports multiple purposes per file.
|
|
579
|
+
*/
|
|
580
|
+
purposes: Array<KYBIndividualDocumentPurpose>;
|
|
581
|
+
/**
|
|
582
|
+
* Document description. Required when "other" is one of the purposes.
|
|
583
|
+
*/
|
|
584
|
+
description?: string;
|
|
585
|
+
}
|
|
586
|
+
/**
|
|
587
|
+
* What a supporting document for an associated person evidences. Passthrough to
|
|
588
|
+
* the provider. See the
|
|
589
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
590
|
+
* for accepted values.
|
|
591
|
+
*/
|
|
592
|
+
export type KYBIndividualDocumentPurpose = string;
|
|
423
593
|
/**
|
|
424
594
|
* Request body for initiating a hosted KYB flow for an organization.
|
|
425
595
|
*/
|
|
@@ -453,6 +623,64 @@ export interface KYBLinksRequestBody {
|
|
|
453
623
|
*/
|
|
454
624
|
redirect_uri?: string;
|
|
455
625
|
}
|
|
626
|
+
/**
|
|
627
|
+
* Place of birth for an associated person.
|
|
628
|
+
*/
|
|
629
|
+
export interface KYBPlaceOfBirth {
|
|
630
|
+
/**
|
|
631
|
+
* ISO 3166-1 alpha-3 country code.
|
|
632
|
+
*/
|
|
633
|
+
country: string;
|
|
634
|
+
/**
|
|
635
|
+
* City of birth.
|
|
636
|
+
*/
|
|
637
|
+
city?: string;
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* A public exchange listing for the business.
|
|
641
|
+
*/
|
|
642
|
+
export interface KYBPubliclyTradedListing {
|
|
643
|
+
/**
|
|
644
|
+
* ISO 10383 market identifier code of the listing venue.
|
|
645
|
+
*/
|
|
646
|
+
market_identifier_code: string;
|
|
647
|
+
/**
|
|
648
|
+
* ISIN with dashes removed.
|
|
649
|
+
*/
|
|
650
|
+
stock_number: string;
|
|
651
|
+
/**
|
|
652
|
+
* Exchange ticker symbol.
|
|
653
|
+
*/
|
|
654
|
+
ticker: string;
|
|
655
|
+
}
|
|
656
|
+
/**
|
|
657
|
+
* Details of the regulated activity a business is licensed to perform.
|
|
658
|
+
*/
|
|
659
|
+
export interface KYBRegulatedActivity {
|
|
660
|
+
/**
|
|
661
|
+
* License number issued by the regulator.
|
|
662
|
+
*/
|
|
663
|
+
license_number: string;
|
|
664
|
+
/**
|
|
665
|
+
* ISO 3166-1 alpha-3 country code of the primary regulator.
|
|
666
|
+
*/
|
|
667
|
+
primary_regulatory_authority_country: string;
|
|
668
|
+
/**
|
|
669
|
+
* Name of the primary regulator.
|
|
670
|
+
*/
|
|
671
|
+
primary_regulatory_authority_name: string;
|
|
672
|
+
/**
|
|
673
|
+
* Description of the regulated activities performed.
|
|
674
|
+
*/
|
|
675
|
+
regulated_activities_description: string;
|
|
676
|
+
}
|
|
677
|
+
/**
|
|
678
|
+
* Primary source of the funds the business will transact with. Passthrough to the
|
|
679
|
+
* provider. See the
|
|
680
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
681
|
+
* for accepted values.
|
|
682
|
+
*/
|
|
683
|
+
export type KYBSourceOfFunds = string;
|
|
456
684
|
/**
|
|
457
685
|
* List of KYB status snapshots, one per configured provider/environment.
|
|
458
686
|
*/
|
|
@@ -499,63 +727,193 @@ export interface KYBStatusResponse {
|
|
|
499
727
|
tos: KyxTosStatusDetail;
|
|
500
728
|
}
|
|
501
729
|
/**
|
|
502
|
-
*
|
|
730
|
+
* KYB verification data for headless submission. Fields are individually optional
|
|
731
|
+
* because the provider accepts partial submissions and grants endorsements once
|
|
732
|
+
* enough data has arrived; a partial submission can be completed by calling the
|
|
733
|
+
* endpoint again.
|
|
503
734
|
*/
|
|
504
|
-
export interface
|
|
735
|
+
export interface KYBSubmitData {
|
|
505
736
|
/**
|
|
506
|
-
*
|
|
737
|
+
* Primary purpose the business will use the account for. Passthrough to the
|
|
738
|
+
* provider. See the
|
|
739
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
740
|
+
* for accepted values.
|
|
507
741
|
*/
|
|
508
|
-
|
|
742
|
+
account_purpose?: KYBAccountPurpose;
|
|
509
743
|
/**
|
|
510
|
-
*
|
|
744
|
+
* Free-text purpose. Required when account_purpose is "other".
|
|
511
745
|
*/
|
|
512
|
-
|
|
746
|
+
account_purpose_other?: string;
|
|
513
747
|
/**
|
|
514
|
-
*
|
|
748
|
+
* Whether the business moves funds on behalf of third parties.
|
|
515
749
|
*/
|
|
516
|
-
|
|
750
|
+
acting_as_intermediary?: boolean;
|
|
517
751
|
/**
|
|
518
|
-
*
|
|
752
|
+
* Beneficial owners, control persons, and signers.
|
|
519
753
|
*/
|
|
520
|
-
|
|
521
|
-
}
|
|
522
|
-
/**
|
|
523
|
-
* An identity document for KYC verification.
|
|
524
|
-
*/
|
|
525
|
-
export interface KYCIdentifyingDocument {
|
|
754
|
+
associated_persons?: Array<KYBAssociatedPerson>;
|
|
526
755
|
/**
|
|
527
|
-
*
|
|
756
|
+
* Short summary of what the business does.
|
|
528
757
|
*/
|
|
529
|
-
|
|
758
|
+
business_description?: string;
|
|
530
759
|
/**
|
|
531
|
-
*
|
|
760
|
+
* 2022 NAICS codes describing the industries the business operates in.
|
|
532
761
|
*/
|
|
533
|
-
|
|
762
|
+
business_industry?: Array<string>;
|
|
534
763
|
/**
|
|
535
|
-
*
|
|
764
|
+
* Registered legal name as filed with government authorities.
|
|
536
765
|
*/
|
|
537
|
-
|
|
766
|
+
business_legal_name?: string;
|
|
538
767
|
/**
|
|
539
|
-
*
|
|
768
|
+
* Public trading name (DBA), if different from the legal name.
|
|
540
769
|
*/
|
|
541
|
-
|
|
770
|
+
business_trade_name?: string;
|
|
542
771
|
/**
|
|
543
|
-
*
|
|
772
|
+
* Legal structure of the business. Passthrough to the provider. See the
|
|
773
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
774
|
+
* for accepted values.
|
|
544
775
|
*/
|
|
545
|
-
|
|
776
|
+
business_type?: KYBBusinessType;
|
|
546
777
|
/**
|
|
547
|
-
*
|
|
778
|
+
* Description of the AML and sanctions screening controls in place.
|
|
548
779
|
*/
|
|
549
|
-
|
|
780
|
+
compliance_screening_explanation?: string;
|
|
550
781
|
/**
|
|
551
|
-
*
|
|
782
|
+
* Whether the business conducts money services.
|
|
552
783
|
*/
|
|
553
|
-
|
|
784
|
+
conducts_money_services?: boolean;
|
|
785
|
+
/**
|
|
786
|
+
* Description of the money services conducted.
|
|
787
|
+
*/
|
|
788
|
+
conducts_money_services_description?: string;
|
|
789
|
+
/**
|
|
790
|
+
* Whether money services are conducted through the provider. Requires a
|
|
791
|
+
* flow_of_funds document when true.
|
|
792
|
+
*/
|
|
793
|
+
conducts_money_services_using_bridge?: boolean;
|
|
794
|
+
/**
|
|
795
|
+
* Supporting documents for verification.
|
|
796
|
+
*/
|
|
797
|
+
documents?: Array<KYBBusinessDocument>;
|
|
798
|
+
/**
|
|
799
|
+
* Primary business email address.
|
|
800
|
+
*/
|
|
801
|
+
email?: string;
|
|
802
|
+
/**
|
|
803
|
+
* Estimated annual revenue of the business, in USD buckets. Passthrough to the
|
|
804
|
+
* provider. See the
|
|
805
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
806
|
+
* for accepted values.
|
|
807
|
+
*/
|
|
808
|
+
estimated_annual_revenue_usd?: KYBEstimatedAnnualRevenue;
|
|
809
|
+
/**
|
|
810
|
+
* Expected monthly payment volume in USD. Required for high-risk businesses.
|
|
811
|
+
*/
|
|
812
|
+
expected_monthly_payments_usd?: number;
|
|
813
|
+
/**
|
|
814
|
+
* Whether the business is tax-registered outside its country of incorporation.
|
|
815
|
+
*/
|
|
816
|
+
has_foreign_tax_registration?: boolean;
|
|
817
|
+
/**
|
|
818
|
+
* Whether an intermediate entity owner holds 25% or more of the business.
|
|
819
|
+
*/
|
|
820
|
+
has_material_intermediary_ownership?: boolean;
|
|
821
|
+
/**
|
|
822
|
+
* High-risk activities the business engages in.
|
|
823
|
+
*/
|
|
824
|
+
high_risk_activities?: Array<KYBHighRiskActivity>;
|
|
825
|
+
/**
|
|
826
|
+
* Explanation of the high-risk activities. Required unless the only value is
|
|
827
|
+
* "none_of_the_above".
|
|
828
|
+
*/
|
|
829
|
+
high_risk_activities_explanation?: string;
|
|
830
|
+
/**
|
|
831
|
+
* Business tax and registration identifiers.
|
|
832
|
+
*/
|
|
833
|
+
identifying_information?: Array<VerificationDocument>;
|
|
834
|
+
/**
|
|
835
|
+
* Date of incorporation in YYYY-MM-DD format.
|
|
836
|
+
*/
|
|
837
|
+
incorporation_date?: string;
|
|
838
|
+
/**
|
|
839
|
+
* Whether the business is a decentralized autonomous organization.
|
|
840
|
+
*/
|
|
841
|
+
is_dao?: boolean;
|
|
842
|
+
/**
|
|
843
|
+
* Whether the business operates in prohibited jurisdictions.
|
|
844
|
+
*/
|
|
845
|
+
operates_in_prohibited_countries?: boolean;
|
|
846
|
+
/**
|
|
847
|
+
* Additional websites and social handles.
|
|
848
|
+
*/
|
|
849
|
+
other_websites?: Array<string>;
|
|
850
|
+
/**
|
|
851
|
+
* Ownership percentage at which a person is treated as a beneficial owner.
|
|
852
|
+
*/
|
|
853
|
+
ownership_threshold?: number;
|
|
854
|
+
/**
|
|
855
|
+
* Business phone number in E.164 format.
|
|
856
|
+
*/
|
|
857
|
+
phone?: string;
|
|
858
|
+
/**
|
|
859
|
+
* A postal address used in KYC and KYB data submission.
|
|
860
|
+
*/
|
|
861
|
+
physical_address?: VerificationAddress;
|
|
862
|
+
/**
|
|
863
|
+
* Primary website. If omitted, a proof_of_nature_of_business document is required.
|
|
864
|
+
*/
|
|
865
|
+
primary_website?: string;
|
|
866
|
+
/**
|
|
867
|
+
* Public exchange listings for the business.
|
|
868
|
+
*/
|
|
869
|
+
publicly_traded_listings?: Array<KYBPubliclyTradedListing>;
|
|
870
|
+
/**
|
|
871
|
+
* A postal address used in KYC and KYB data submission.
|
|
872
|
+
*/
|
|
873
|
+
registered_address?: VerificationAddress;
|
|
874
|
+
/**
|
|
875
|
+
* Details of the regulated activity a business is licensed to perform.
|
|
876
|
+
*/
|
|
877
|
+
regulated_activity?: KYBRegulatedActivity;
|
|
878
|
+
/**
|
|
879
|
+
* Primary source of the funds the business will transact with. Passthrough to the
|
|
880
|
+
* provider. See the
|
|
881
|
+
* [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
|
|
882
|
+
* for accepted values.
|
|
883
|
+
*/
|
|
884
|
+
source_of_funds?: KYBSourceOfFunds;
|
|
885
|
+
/**
|
|
886
|
+
* Free-text detail on the source of funds. Required for high-risk businesses.
|
|
887
|
+
*/
|
|
888
|
+
source_of_funds_description?: string;
|
|
889
|
+
/**
|
|
890
|
+
* Latin-1 transliteration of the legal name. Required for non-Latin-1 names.
|
|
891
|
+
*/
|
|
892
|
+
transliterated_business_legal_name?: string;
|
|
893
|
+
/**
|
|
894
|
+
* Latin-1 transliteration of the trade name. Required for non-Latin-1 names.
|
|
895
|
+
*/
|
|
896
|
+
transliterated_business_trade_name?: string;
|
|
897
|
+
/**
|
|
898
|
+
* A postal address used in KYC and KYB data submission.
|
|
899
|
+
*/
|
|
900
|
+
transliterated_physical_address?: VerificationAddress;
|
|
901
|
+
/**
|
|
902
|
+
* A postal address used in KYC and KYB data submission.
|
|
903
|
+
*/
|
|
904
|
+
transliterated_registered_address?: VerificationAddress;
|
|
554
905
|
}
|
|
555
906
|
/**
|
|
556
|
-
* Request body for
|
|
907
|
+
* Request body for headless KYB data submission.
|
|
557
908
|
*/
|
|
558
|
-
export interface
|
|
909
|
+
export interface KYBSubmitRequestBody {
|
|
910
|
+
/**
|
|
911
|
+
* KYB verification data for headless submission. Fields are individually optional
|
|
912
|
+
* because the provider accepts partial submissions and grants endorsements once
|
|
913
|
+
* enough data has arrived; a partial submission can be completed by calling the
|
|
914
|
+
* endpoint again.
|
|
915
|
+
*/
|
|
916
|
+
data: KYBSubmitData;
|
|
559
917
|
/**
|
|
560
918
|
* KYC/KYB provider identifier.
|
|
561
919
|
*/
|
|
@@ -565,50 +923,63 @@ export interface KYCLinksRequestBody {
|
|
|
565
923
|
*/
|
|
566
924
|
client_agreement_id?: string;
|
|
567
925
|
/**
|
|
568
|
-
*
|
|
569
|
-
*/
|
|
570
|
-
email?: string;
|
|
571
|
-
/**
|
|
572
|
-
* Endorsements to request during KYC.
|
|
926
|
+
* Endorsements to request during KYB.
|
|
573
927
|
*/
|
|
574
928
|
endorsements?: Array<KyxEndorsementName>;
|
|
575
929
|
/**
|
|
576
930
|
* Provider environment (production or sandbox).
|
|
577
931
|
*/
|
|
578
932
|
environment?: KyxEnvironment;
|
|
933
|
+
}
|
|
934
|
+
/**
|
|
935
|
+
* Request body for initiating Terms of Service acceptance for an organization.
|
|
936
|
+
*/
|
|
937
|
+
export interface KYBTosRequestBody {
|
|
579
938
|
/**
|
|
580
|
-
*
|
|
939
|
+
* Email address for the organization.
|
|
581
940
|
*/
|
|
582
|
-
|
|
941
|
+
email: string;
|
|
942
|
+
/**
|
|
943
|
+
* KYC/KYB provider identifier.
|
|
944
|
+
*/
|
|
945
|
+
provider: KyxProvider;
|
|
946
|
+
/**
|
|
947
|
+
* Legal name of the business.
|
|
948
|
+
*/
|
|
949
|
+
business_name?: string;
|
|
950
|
+
/**
|
|
951
|
+
* Provider environment (production or sandbox).
|
|
952
|
+
*/
|
|
953
|
+
environment?: KyxEnvironment;
|
|
583
954
|
}
|
|
584
955
|
/**
|
|
585
|
-
*
|
|
956
|
+
* Request body for initiating a hosted KYC flow.
|
|
586
957
|
*/
|
|
587
|
-
export interface
|
|
958
|
+
export interface KYCLinksRequestBody {
|
|
588
959
|
/**
|
|
589
|
-
*
|
|
960
|
+
* KYC/KYB provider identifier.
|
|
590
961
|
*/
|
|
591
|
-
|
|
962
|
+
provider: KyxProvider;
|
|
592
963
|
/**
|
|
593
|
-
*
|
|
964
|
+
* Client-side agreement ID for ToS acceptance.
|
|
594
965
|
*/
|
|
595
|
-
|
|
966
|
+
client_agreement_id?: string;
|
|
596
967
|
/**
|
|
597
|
-
*
|
|
968
|
+
* Email address for the KYC session.
|
|
598
969
|
*/
|
|
599
|
-
|
|
970
|
+
email?: string;
|
|
600
971
|
/**
|
|
601
|
-
*
|
|
972
|
+
* Endorsements to request during KYC.
|
|
602
973
|
*/
|
|
603
|
-
|
|
974
|
+
endorsements?: Array<KyxEndorsementName>;
|
|
604
975
|
/**
|
|
605
|
-
*
|
|
976
|
+
* Provider environment (production or sandbox).
|
|
606
977
|
*/
|
|
607
|
-
|
|
978
|
+
environment?: KyxEnvironment;
|
|
608
979
|
/**
|
|
609
|
-
*
|
|
980
|
+
* URI to redirect the user after completing KYC.
|
|
610
981
|
*/
|
|
611
|
-
|
|
982
|
+
redirect_uri?: string;
|
|
612
983
|
}
|
|
613
984
|
/**
|
|
614
985
|
* List of KYC status snapshots, one per configured provider/environment.
|
|
@@ -662,31 +1033,60 @@ export interface KYCSubmitData {
|
|
|
662
1033
|
/**
|
|
663
1034
|
* Date of birth in YYYY-MM-DD format.
|
|
664
1035
|
*/
|
|
665
|
-
date_of_birth
|
|
1036
|
+
date_of_birth?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
* Email address.
|
|
1039
|
+
*/
|
|
1040
|
+
email?: string;
|
|
666
1041
|
/**
|
|
667
1042
|
* Legal first name.
|
|
668
1043
|
*/
|
|
669
|
-
first_name
|
|
1044
|
+
first_name?: string;
|
|
670
1045
|
/**
|
|
671
1046
|
* Identifying documents.
|
|
672
1047
|
*/
|
|
673
|
-
identifying_information
|
|
1048
|
+
identifying_information?: Array<VerificationDocument>;
|
|
674
1049
|
/**
|
|
675
1050
|
* Legal last name.
|
|
676
1051
|
*/
|
|
677
|
-
last_name
|
|
1052
|
+
last_name?: string;
|
|
678
1053
|
/**
|
|
679
|
-
*
|
|
1054
|
+
* Legal middle name.
|
|
680
1055
|
*/
|
|
681
|
-
|
|
1056
|
+
middle_name?: string;
|
|
682
1057
|
/**
|
|
683
|
-
*
|
|
1058
|
+
* ISO 3166-1 alpha-3 codes for all nationalities held.
|
|
684
1059
|
*/
|
|
685
|
-
|
|
1060
|
+
nationalities?: Array<string>;
|
|
1061
|
+
/**
|
|
1062
|
+
* Attests the user is a nonresident alien to satisfy identification without a US
|
|
1063
|
+
* tax ID (must be enabled for you).
|
|
1064
|
+
*/
|
|
1065
|
+
nonresident_alien_attestation?: boolean;
|
|
686
1066
|
/**
|
|
687
1067
|
* Phone number in E.164 format.
|
|
688
1068
|
*/
|
|
689
1069
|
phone?: string;
|
|
1070
|
+
/**
|
|
1071
|
+
* A postal address used in KYC and KYB data submission.
|
|
1072
|
+
*/
|
|
1073
|
+
residential_address?: VerificationAddress;
|
|
1074
|
+
/**
|
|
1075
|
+
* Latin-1 transliteration of the first name. Required for non-Latin-1 names.
|
|
1076
|
+
*/
|
|
1077
|
+
transliterated_first_name?: string;
|
|
1078
|
+
/**
|
|
1079
|
+
* Latin-1 transliteration of the last name. Required for non-Latin-1 names.
|
|
1080
|
+
*/
|
|
1081
|
+
transliterated_last_name?: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* Latin-1 transliteration of the middle name. Required for non-Latin-1 names.
|
|
1084
|
+
*/
|
|
1085
|
+
transliterated_middle_name?: string;
|
|
1086
|
+
/**
|
|
1087
|
+
* A postal address used in KYC and KYB data submission.
|
|
1088
|
+
*/
|
|
1089
|
+
transliterated_residential_address?: VerificationAddress;
|
|
690
1090
|
}
|
|
691
1091
|
/**
|
|
692
1092
|
* Request body for headless KYC data submission.
|
|
@@ -1023,7 +1423,71 @@ export interface PayoutSource {
|
|
|
1023
1423
|
*/
|
|
1024
1424
|
chain: string;
|
|
1025
1425
|
}
|
|
1426
|
+
/**
|
|
1427
|
+
* A postal address used in KYC and KYB data submission.
|
|
1428
|
+
*/
|
|
1429
|
+
export interface VerificationAddress {
|
|
1430
|
+
/**
|
|
1431
|
+
* City.
|
|
1432
|
+
*/
|
|
1433
|
+
city: string;
|
|
1434
|
+
/**
|
|
1435
|
+
* ISO 3166-1 alpha-3 country code.
|
|
1436
|
+
*/
|
|
1437
|
+
country: string;
|
|
1438
|
+
/**
|
|
1439
|
+
* Street address line 1.
|
|
1440
|
+
*/
|
|
1441
|
+
street_line_1: string;
|
|
1442
|
+
/**
|
|
1443
|
+
* Postal code. Required for countries that use them.
|
|
1444
|
+
*/
|
|
1445
|
+
postal_code?: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* Street address line 2.
|
|
1448
|
+
*/
|
|
1449
|
+
street_line_2?: string;
|
|
1450
|
+
/**
|
|
1451
|
+
* ISO 3166-2 state or province code. Required for US addresses.
|
|
1452
|
+
*/
|
|
1453
|
+
subdivision?: string;
|
|
1454
|
+
}
|
|
1455
|
+
/**
|
|
1456
|
+
* An identifying document for KYC or KYB verification. Also used for business
|
|
1457
|
+
* identifiers such as tax and registration numbers, for which the image and
|
|
1458
|
+
* expiration fields do not apply.
|
|
1459
|
+
*/
|
|
1460
|
+
export interface VerificationDocument {
|
|
1461
|
+
/**
|
|
1462
|
+
* ISO 3166-1 alpha-3 issuing country code.
|
|
1463
|
+
*/
|
|
1464
|
+
issuing_country: string;
|
|
1465
|
+
/**
|
|
1466
|
+
* Document type identifier.
|
|
1467
|
+
*/
|
|
1468
|
+
type: string;
|
|
1469
|
+
/**
|
|
1470
|
+
* Document description.
|
|
1471
|
+
*/
|
|
1472
|
+
description?: string;
|
|
1473
|
+
/**
|
|
1474
|
+
* Document expiration date.
|
|
1475
|
+
*/
|
|
1476
|
+
expiration?: string;
|
|
1477
|
+
/**
|
|
1478
|
+
* Base64-encoded back image.
|
|
1479
|
+
*/
|
|
1480
|
+
image_back?: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* Base64-encoded front image.
|
|
1483
|
+
*/
|
|
1484
|
+
image_front?: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* Document number.
|
|
1487
|
+
*/
|
|
1488
|
+
number?: string;
|
|
1489
|
+
}
|
|
1026
1490
|
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
|
|
1491
|
+
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 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 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 PayoutSource as PayoutSource, type VerificationAddress as VerificationAddress, type VerificationDocument as VerificationDocument, };
|
|
1028
1492
|
}
|
|
1029
1493
|
//# sourceMappingURL=fiat.d.ts.map
|