@privy-io/api-types 0.8.0 → 0.10.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 (167) hide show
  1. package/CHANGELOG.md +57 -0
  2. package/client.d.mts +35 -32
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +35 -32
  5. package/client.d.ts.map +1 -1
  6. package/client.js +22 -8
  7. package/client.js.map +1 -1
  8. package/client.mjs +22 -8
  9. package/client.mjs.map +1 -1
  10. package/internal/types.d.mts +6 -6
  11. package/internal/types.d.mts.map +1 -1
  12. package/internal/types.d.ts +6 -6
  13. package/internal/types.d.ts.map +1 -1
  14. package/internal/utils/env.js +2 -2
  15. package/internal/utils/env.js.map +1 -1
  16. package/internal/utils/env.mjs +2 -2
  17. package/internal/utils/env.mjs.map +1 -1
  18. package/package.json +1 -1
  19. package/resources/accounts.d.mts +128 -86
  20. package/resources/accounts.d.mts.map +1 -1
  21. package/resources/accounts.d.ts +128 -86
  22. package/resources/accounts.d.ts.map +1 -1
  23. package/resources/aggregations.d.mts +43 -43
  24. package/resources/aggregations.d.mts.map +1 -1
  25. package/resources/aggregations.d.ts +43 -43
  26. package/resources/aggregations.d.ts.map +1 -1
  27. package/resources/apps.d.mts +177 -129
  28. package/resources/apps.d.mts.map +1 -1
  29. package/resources/apps.d.ts +177 -129
  30. package/resources/apps.d.ts.map +1 -1
  31. package/resources/client-auth.d.mts +650 -648
  32. package/resources/client-auth.d.mts.map +1 -1
  33. package/resources/client-auth.d.ts +650 -648
  34. package/resources/client-auth.d.ts.map +1 -1
  35. package/resources/embedded-wallets.d.mts +84 -84
  36. package/resources/embedded-wallets.d.mts.map +1 -1
  37. package/resources/embedded-wallets.d.ts +84 -84
  38. package/resources/embedded-wallets.d.ts.map +1 -1
  39. package/resources/funding.d.mts +42 -42
  40. package/resources/funding.d.mts.map +1 -1
  41. package/resources/funding.d.ts +42 -42
  42. package/resources/funding.d.ts.map +1 -1
  43. package/resources/index.d.mts +19 -18
  44. package/resources/index.d.mts.map +1 -1
  45. package/resources/index.d.ts +19 -18
  46. package/resources/index.d.ts.map +1 -1
  47. package/resources/index.js +3 -1
  48. package/resources/index.js.map +1 -1
  49. package/resources/index.mjs +2 -1
  50. package/resources/index.mjs.map +1 -1
  51. package/resources/intents.d.mts +270 -266
  52. package/resources/intents.d.mts.map +1 -1
  53. package/resources/intents.d.ts +270 -266
  54. package/resources/intents.d.ts.map +1 -1
  55. package/resources/key-quorums.d.mts +20 -20
  56. package/resources/key-quorums.d.mts.map +1 -1
  57. package/resources/key-quorums.d.ts +20 -20
  58. package/resources/key-quorums.d.ts.map +1 -1
  59. package/resources/kraken-embed.d.mts +62 -19
  60. package/resources/kraken-embed.d.mts.map +1 -1
  61. package/resources/kraken-embed.d.ts +62 -19
  62. package/resources/kraken-embed.d.ts.map +1 -1
  63. package/resources/organizations.d.mts +65 -0
  64. package/resources/organizations.d.mts.map +1 -0
  65. package/resources/organizations.d.ts +65 -0
  66. package/resources/organizations.d.ts.map +1 -0
  67. package/resources/organizations.js +9 -0
  68. package/resources/organizations.js.map +1 -0
  69. package/resources/organizations.mjs +5 -0
  70. package/resources/organizations.mjs.map +1 -0
  71. package/resources/policies.d.mts +360 -231
  72. package/resources/policies.d.mts.map +1 -1
  73. package/resources/policies.d.ts +360 -231
  74. package/resources/policies.d.ts.map +1 -1
  75. package/resources/shared.d.mts +28 -28
  76. package/resources/shared.d.mts.map +1 -1
  77. package/resources/shared.d.ts +28 -28
  78. package/resources/shared.d.ts.map +1 -1
  79. package/resources/swaps.d.mts +8 -11
  80. package/resources/swaps.d.mts.map +1 -1
  81. package/resources/swaps.d.ts +8 -11
  82. package/resources/swaps.d.ts.map +1 -1
  83. package/resources/swaps.js.map +1 -1
  84. package/resources/swaps.mjs.map +1 -1
  85. package/resources/transactions.d.mts +56 -66
  86. package/resources/transactions.d.mts.map +1 -1
  87. package/resources/transactions.d.ts +56 -66
  88. package/resources/transactions.d.ts.map +1 -1
  89. package/resources/users.d.mts +457 -448
  90. package/resources/users.d.mts.map +1 -1
  91. package/resources/users.d.ts +457 -448
  92. package/resources/users.d.ts.map +1 -1
  93. package/resources/wallet-actions.d.mts +450 -41
  94. package/resources/wallet-actions.d.mts.map +1 -1
  95. package/resources/wallet-actions.d.ts +450 -41
  96. package/resources/wallet-actions.d.ts.map +1 -1
  97. package/resources/wallets/balance.d.mts +2 -1
  98. package/resources/wallets/balance.d.mts.map +1 -1
  99. package/resources/wallets/balance.d.ts +2 -1
  100. package/resources/wallets/balance.d.ts.map +1 -1
  101. package/resources/wallets/balance.js.map +1 -1
  102. package/resources/wallets/balance.mjs.map +1 -1
  103. package/resources/wallets/index.d.mts +1 -1
  104. package/resources/wallets/index.d.mts.map +1 -1
  105. package/resources/wallets/index.d.ts +1 -1
  106. package/resources/wallets/index.d.ts.map +1 -1
  107. package/resources/wallets/index.js.map +1 -1
  108. package/resources/wallets/index.mjs.map +1 -1
  109. package/resources/wallets/transactions.d.mts +16 -31
  110. package/resources/wallets/transactions.d.mts.map +1 -1
  111. package/resources/wallets/transactions.d.ts +16 -31
  112. package/resources/wallets/transactions.d.ts.map +1 -1
  113. package/resources/wallets/transactions.js +1 -1
  114. package/resources/wallets/transactions.js.map +1 -1
  115. package/resources/wallets/transactions.mjs +1 -1
  116. package/resources/wallets/transactions.mjs.map +1 -1
  117. package/resources/wallets/wallets.d.mts +1475 -1172
  118. package/resources/wallets/wallets.d.mts.map +1 -1
  119. package/resources/wallets/wallets.d.ts +1475 -1172
  120. package/resources/wallets/wallets.d.ts.map +1 -1
  121. package/resources/wallets/wallets.js +10 -6
  122. package/resources/wallets/wallets.js.map +1 -1
  123. package/resources/wallets/wallets.mjs +10 -6
  124. package/resources/wallets/wallets.mjs.map +1 -1
  125. package/resources/webhooks.d.mts +1345 -582
  126. package/resources/webhooks.d.mts.map +1 -1
  127. package/resources/webhooks.d.ts +1345 -582
  128. package/resources/webhooks.d.ts.map +1 -1
  129. package/resources/yield.d.mts +157 -157
  130. package/resources/yield.d.mts.map +1 -1
  131. package/resources/yield.d.ts +157 -157
  132. package/resources/yield.d.ts.map +1 -1
  133. package/src/client.ts +661 -455
  134. package/src/internal/types.ts +6 -8
  135. package/src/internal/utils/env.ts +2 -2
  136. package/src/resources/accounts.ts +157 -103
  137. package/src/resources/aggregations.ts +55 -55
  138. package/src/resources/apps.ts +232 -166
  139. package/src/resources/client-auth.ts +890 -890
  140. package/src/resources/embedded-wallets.ts +123 -123
  141. package/src/resources/funding.ts +66 -66
  142. package/src/resources/index.ts +521 -431
  143. package/src/resources/intents.ts +326 -322
  144. package/src/resources/key-quorums.ts +23 -23
  145. package/src/resources/kraken-embed.ts +116 -19
  146. package/src/resources/organizations.ts +82 -0
  147. package/src/resources/policies.ts +495 -339
  148. package/src/resources/shared.ts +34 -34
  149. package/src/resources/swaps.ts +9 -14
  150. package/src/resources/transactions.ts +88 -115
  151. package/src/resources/users.ts +664 -653
  152. package/src/resources/wallet-actions.ts +585 -56
  153. package/src/resources/wallets/balance.ts +2 -1
  154. package/src/resources/wallets/index.ts +158 -138
  155. package/src/resources/wallets/transactions.ts +20 -83
  156. package/src/resources/wallets/wallets.ts +1997 -1563
  157. package/src/resources/webhooks.ts +1652 -700
  158. package/src/resources/yield.ts +188 -188
  159. package/src/version.ts +1 -1
  160. package/version.d.mts +1 -1
  161. package/version.d.mts.map +1 -1
  162. package/version.d.ts +1 -1
  163. package/version.d.ts.map +1 -1
  164. package/version.js +1 -1
  165. package/version.js.map +1 -1
  166. package/version.mjs +1 -1
  167. package/version.mjs.map +1 -1
@@ -666,540 +666,551 @@ export interface TelegramUnlinkRequestBody {
666
666
  }
667
667
 
668
668
  /**
669
- * The ID of an external OAuth provider.
669
+ * Input for authenticating with a custom JWT.
670
670
  */
671
- export type ExternalOAuthProviderID =
672
- | 'google'
673
- | 'discord'
674
- | 'twitter'
675
- | 'github'
676
- | 'spotify'
677
- | 'instagram'
678
- | 'tiktok'
679
- | 'linkedin'
680
- | 'apple'
681
- | 'line'
682
- | 'twitch';
671
+ export interface AuthenticateJwtInput {
672
+ token?: string;
683
673
 
684
- /**
685
- * The ID of a Privy app as an OAuth provider. Must start with "privy:".
686
- */
687
- export type PrivyOAuthProviderID = `privy:${string}`;
674
+ /**
675
+ * Whether to allow sign-up during authentication.
676
+ */
677
+ mode?: AuthenticateModeOption;
678
+ }
688
679
 
689
680
  /**
690
- * The ID of a custom OAuth provider, set up for this app. Must start with
691
- * "custom:".
681
+ * The authentication mode settings for the ceremony.
692
682
  */
693
- export type CustomOAuthProviderID = `custom:${string}`;
683
+ export interface AuthenticateMode {
684
+ /**
685
+ * Whether to allow sign-up during authentication.
686
+ */
687
+ mode?: AuthenticateModeOption;
688
+ }
694
689
 
695
690
  /**
696
- * The ID of an OAuth provider.
691
+ * Whether to allow sign-up during authentication.
697
692
  */
698
- export type OAuthProviderID = ExternalOAuthProviderID | PrivyOAuthProviderID | CustomOAuthProviderID;
693
+ export type AuthenticateModeOption = 'no-signup' | 'login-or-sign-up';
699
694
 
700
695
  /**
701
- * Bridge provider variant — production or sandbox.
696
+ * Input for authenticating a SIWE ceremony.
702
697
  */
703
- export type BridgeOnrampProvider = 'bridge' | 'bridge-sandbox';
698
+ export interface AuthenticateSiweInput {
699
+ message: string;
704
700
 
705
- /**
706
- * Valid set of onramp providers
707
- */
708
- export type OnrampProvider = 'bridge' | 'bridge-sandbox';
701
+ signature: string;
709
702
 
710
- /**
711
- * Whether to allow sign-up during authentication.
712
- */
713
- export type AuthenticateModeOption = 'no-signup' | 'login-or-sign-up';
703
+ chainId?: string | null;
704
+
705
+ connectorType?: string | null;
714
706
 
715
- /**
716
- * The authentication mode settings for the ceremony.
717
- */
718
- export interface AuthenticateMode {
719
707
  /**
720
708
  * Whether to allow sign-up during authentication.
721
709
  */
722
710
  mode?: AuthenticateModeOption;
723
- }
724
711
 
725
- /**
726
- * The result of the WebAuthn credProps extension.
727
- */
728
- export interface PasskeyCredPropsResult {
729
- rk?: boolean;
712
+ walletClientType?: string | null;
730
713
  }
731
714
 
732
715
  /**
733
- * Client extension results returned by the WebAuthn authenticator.
716
+ * Input for authenticating a SIWS ceremony.
734
717
  */
735
- export interface PasskeyClientExtensionResults {
736
- app_id?: boolean;
718
+ export interface AuthenticateSiwsInput {
719
+ message: string;
720
+
721
+ signature: string;
722
+
723
+ connectorType?: string | null;
724
+
725
+ message_type?: 'transaction' | 'plain';
737
726
 
738
727
  /**
739
- * The result of the WebAuthn credProps extension.
728
+ * Whether to allow sign-up during authentication.
740
729
  */
741
- cred_props?: PasskeyCredPropsResult;
730
+ mode?: AuthenticateModeOption;
742
731
 
743
- hmac_create_secret?: boolean;
732
+ walletClientType?: string | null;
744
733
  }
745
734
 
746
735
  /**
747
- * A WebAuthn credential descriptor identifying a specific public key credential.
736
+ * The deposit instructions for a virtual account.
748
737
  */
749
- export interface PasskeyCredentialDescriptor {
750
- id: string;
738
+ export interface BridgeBrlFiatVirtualAccountDepositInstructions {
739
+ account_holder_name: string;
751
740
 
752
- type: string;
741
+ asset: 'brl';
753
742
 
754
- transports?: Array<string>;
743
+ bank_address: string;
744
+
745
+ bank_name: string;
746
+
747
+ br_code: string;
748
+
749
+ payment_rails: Array<'pix'>;
755
750
  }
756
751
 
752
+ export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc';
753
+
757
754
  /**
758
- * Relying party information for a WebAuthn ceremony.
755
+ * The deposit instructions for a virtual account.
759
756
  */
760
- export interface PasskeyRelyingParty {
761
- name: string;
757
+ export interface BridgeEurFiatVirtualAccountDepositInstructions {
758
+ account_holder_name: string;
762
759
 
763
- id?: string;
760
+ asset: 'eur';
761
+
762
+ bank_address: string;
763
+
764
+ bank_name: string;
765
+
766
+ bic: string;
767
+
768
+ iban: string;
769
+
770
+ payment_rails: Array<'sepa'>;
764
771
  }
765
772
 
766
773
  /**
767
- * User entity for a WebAuthn registration ceremony.
774
+ * The response for getting a native onramp provider customer.
768
775
  */
769
- export interface PasskeyUser {
770
- id: string;
776
+ export interface BridgeFiatCustomerResponse {
777
+ has_accepted_terms: boolean;
771
778
 
772
- display_name: string;
779
+ provider: 'bridge';
773
780
 
774
- name: string;
781
+ /**
782
+ * Status of the KYC verification process.
783
+ */
784
+ status:
785
+ | 'not_found'
786
+ | 'active'
787
+ | 'awaiting_questionnaire'
788
+ | 'awaiting_ubo'
789
+ | 'incomplete'
790
+ | 'not_started'
791
+ | 'offboarded'
792
+ | 'paused'
793
+ | 'rejected'
794
+ | 'under_review';
795
+
796
+ kyc_url?: string;
797
+
798
+ rejection_reasons?: Array<BridgeFiatRejectionReason>;
775
799
  }
776
800
 
777
801
  /**
778
- * A public key credential parameter specifying the algorithm and credential type.
802
+ * A rejection reason for a customer KYC verification.
779
803
  */
780
- export interface PasskeyPubKeyCredParam {
781
- alg: number;
782
-
783
- type: 'public-key';
804
+ export interface BridgeFiatRejectionReason {
805
+ reason: string;
784
806
  }
785
807
 
786
808
  /**
787
- * Authenticator selection criteria for a WebAuthn registration ceremony.
809
+ * The deposit instructions for a virtual account.
788
810
  */
789
- export interface PasskeyAuthenticatorSelection {
790
- authenticator_attachment?: string;
811
+ export type BridgeFiatVirtualAccountDepositInstructions =
812
+ | BridgeUsdFiatVirtualAccountDepositInstructions
813
+ | BridgeEurFiatVirtualAccountDepositInstructions
814
+ | BridgeMxnFiatVirtualAccountDepositInstructions
815
+ | BridgeBrlFiatVirtualAccountDepositInstructions
816
+ | BridgeGbpFiatVirtualAccountDepositInstructions;
791
817
 
792
- require_resident_key?: boolean;
818
+ export interface BridgeFiatVirtualAccountDestination {
819
+ address: string;
793
820
 
794
- resident_key?: string;
821
+ asset: BridgeDestinationAsset;
795
822
 
796
- user_verification?: string;
823
+ chain: string;
797
824
  }
798
825
 
799
826
  /**
800
- * Extensions for a WebAuthn registration ceremony.
827
+ * The request input for creating virtual account.
801
828
  */
802
- export interface PasskeyEnrollmentExtensions {
803
- app_id?: string;
829
+ export interface BridgeFiatVirtualAccountRequest {
830
+ destination: BridgeFiatVirtualAccountDestination;
804
831
 
805
- /**
806
- * The result of the WebAuthn credProps extension.
807
- */
808
- cred_props?: PasskeyCredPropsResult;
832
+ provider: 'bridge';
809
833
 
810
- hmac_create_secret?: boolean;
834
+ source: BridgeFiatVirtualAccountSource;
811
835
  }
812
836
 
813
837
  /**
814
- * The authenticator attestation response from a WebAuthn registration ceremony.
838
+ * The response for creating virtual account.
815
839
  */
816
- export interface PasskeyAttestationResponse {
817
- attestation_object: string;
818
-
819
- client_data_json: string;
840
+ export interface BridgeFiatVirtualAccountResponse {
841
+ /**
842
+ * The deposit instructions for a virtual account.
843
+ */
844
+ deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
820
845
 
821
- authenticator_data?: string;
846
+ destination: BridgeFiatVirtualAccountDestination;
822
847
 
823
- public_key?: string;
848
+ provider: 'bridge';
824
849
 
825
- public_key_algorithm?: number;
850
+ status: string;
851
+ }
826
852
 
827
- transports?: Array<unknown>;
853
+ export interface BridgeFiatVirtualAccountSource {
854
+ asset: BridgeSourceAsset;
828
855
  }
829
856
 
830
857
  /**
831
- * WebAuthn registration options as defined by the Web Authentication
832
- * specification.
858
+ * The deposit instructions for a virtual account.
833
859
  */
834
- export interface PasskeyAuthenticatorEnrollmentOptions {
835
- challenge: string;
836
-
837
- pub_key_cred_params: Array<PasskeyPubKeyCredParam>;
838
-
839
- /**
840
- * Relying party information for a WebAuthn ceremony.
841
- */
842
- rp: PasskeyRelyingParty;
860
+ export interface BridgeGbpFiatVirtualAccountDepositInstructions {
861
+ account_holder_name: string;
843
862
 
844
- /**
845
- * User entity for a WebAuthn registration ceremony.
846
- */
847
- user: PasskeyUser;
863
+ account_number: string;
848
864
 
849
- attestation?: string;
865
+ asset: 'gbp';
850
866
 
851
- /**
852
- * Authenticator selection criteria for a WebAuthn registration ceremony.
853
- */
854
- authenticator_selection?: PasskeyAuthenticatorSelection;
867
+ bank_address: string;
855
868
 
856
- exclude_credentials?: Array<PasskeyCredentialDescriptor>;
869
+ bank_name: string;
857
870
 
858
- /**
859
- * Extensions for a WebAuthn registration ceremony.
860
- */
861
- extensions?: PasskeyEnrollmentExtensions;
871
+ payment_rails: Array<'faster_payments'>;
862
872
 
863
- timeout?: number;
873
+ sort_code: string;
864
874
  }
865
875
 
866
876
  /**
867
- * WebAuthn registration response as defined by the Web Authentication
868
- * specification.
877
+ * The deposit instructions for a virtual account.
869
878
  */
870
- export interface PasskeyAuthenticatorEnrollmentResponse {
871
- id: string;
879
+ export interface BridgeMxnFiatVirtualAccountDepositInstructions {
880
+ account_holder_name: string;
872
881
 
873
- /**
874
- * Client extension results returned by the WebAuthn authenticator.
875
- */
876
- client_extension_results: PasskeyClientExtensionResults;
882
+ asset: 'mxn';
877
883
 
878
- raw_id: string;
884
+ bank_address: string;
879
885
 
880
- /**
881
- * The authenticator attestation response from a WebAuthn registration ceremony.
882
- */
883
- response: PasskeyAttestationResponse;
886
+ bank_name: string;
884
887
 
885
- type: 'public-key';
888
+ clabe: string;
886
889
 
887
- authenticator_attachment?: string;
890
+ payment_rails: Array<'spei'>;
888
891
  }
889
892
 
890
893
  /**
891
- * Response for initiating a passkey link ceremony.
894
+ * Bridge provider variant — production or sandbox.
892
895
  */
893
- export interface ResponsePasskeyInitLink {
894
- /**
895
- * WebAuthn registration options as defined by the Web Authentication
896
- * specification.
897
- */
898
- options: PasskeyAuthenticatorEnrollmentOptions;
899
-
900
- relying_party?: string;
901
- }
896
+ export type BridgeOnrampProvider = 'bridge' | 'bridge-sandbox';
902
897
 
903
898
  /**
904
- * Response for initiating a passkey registration ceremony.
899
+ * The response for getting a native onramp provider customer.
905
900
  */
906
- export interface ResponsePasskeyInitRegister {
901
+ export interface BridgeSandboxFiatCustomerResponse {
902
+ has_accepted_terms: boolean;
903
+
904
+ provider: 'bridge-sandbox';
905
+
907
906
  /**
908
- * WebAuthn registration options as defined by the Web Authentication
909
- * specification.
907
+ * Status of the KYC verification process.
910
908
  */
911
- options: PasskeyAuthenticatorEnrollmentOptions;
909
+ status:
910
+ | 'not_found'
911
+ | 'active'
912
+ | 'awaiting_questionnaire'
913
+ | 'awaiting_ubo'
914
+ | 'incomplete'
915
+ | 'not_started'
916
+ | 'offboarded'
917
+ | 'paused'
918
+ | 'rejected'
919
+ | 'under_review';
912
920
 
913
- relying_party?: string;
921
+ kyc_url?: string;
922
+
923
+ rejection_reasons?: Array<BridgeFiatRejectionReason>;
914
924
  }
915
925
 
916
926
  /**
917
- * Input for linking a passkey credential.
927
+ * The request input for creating virtual account.
918
928
  */
919
- export interface PasskeyLinkInput {
920
- /**
921
- * WebAuthn registration response as defined by the Web Authentication
922
- * specification.
923
- */
924
- authenticator_response: PasskeyAuthenticatorEnrollmentResponse;
929
+ export interface BridgeSandboxFiatVirtualAccountRequest {
930
+ destination: BridgeFiatVirtualAccountDestination;
925
931
 
926
- relying_party?: string;
932
+ provider: 'bridge-sandbox';
933
+
934
+ source: BridgeFiatVirtualAccountSource;
927
935
  }
928
936
 
929
937
  /**
930
- * Input for registering a passkey credential.
938
+ * The response for creating virtual account.
931
939
  */
932
- export interface PasskeyRegisterInput {
940
+ export interface BridgeSandboxFiatVirtualAccountResponse {
933
941
  /**
934
- * WebAuthn registration response as defined by the Web Authentication
935
- * specification.
942
+ * The deposit instructions for a virtual account.
936
943
  */
937
- authenticator_response: PasskeyAuthenticatorEnrollmentResponse;
944
+ deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
938
945
 
939
- relying_party?: string;
946
+ destination: BridgeFiatVirtualAccountDestination;
947
+
948
+ provider: 'bridge-sandbox';
949
+
950
+ status: string;
940
951
  }
941
952
 
953
+ export type BridgeSourceAsset = 'usd' | 'eur' | 'mxn' | 'brl' | 'gbp';
954
+
942
955
  /**
943
- * Input for initiating a passkey ceremony.
956
+ * The deposit instructions for a virtual account.
944
957
  */
945
- export interface PasskeyInitInput {
946
- token?: string;
958
+ export interface BridgeUsdFiatVirtualAccountDepositInstructions {
959
+ asset: 'usd';
947
960
 
948
- relying_party?: string;
961
+ bank_account_number: string;
962
+
963
+ bank_address: string;
964
+
965
+ bank_beneficiary_address: string;
966
+
967
+ bank_beneficiary_name: string;
968
+
969
+ bank_name: string;
970
+
971
+ bank_routing_number: string;
972
+
973
+ payment_rails: Array<'ach_push' | 'wire'>;
949
974
  }
950
975
 
951
976
  /**
952
- * Input for unlinking a passkey credential.
977
+ * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
978
+ * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
953
979
  */
954
- export interface UnlinkPasskeyInput {
955
- credential_id: string;
956
-
957
- remove_as_mfa?: boolean;
958
- }
980
+ export type Caip2ChainID = string;
959
981
 
960
982
  /**
961
- * Extensions for a WebAuthn authentication ceremony.
983
+ * The request input for creating (or updating) a native onramp provider customer.
962
984
  */
963
- export interface PasskeyVerifyExtensions {
964
- app_id?: string;
985
+ export interface CreateOrUpdateFiatCustomerRequestInput {
986
+ has_accepted_terms: boolean;
965
987
 
966
- cred_props?: boolean;
988
+ /**
989
+ * Valid set of onramp providers
990
+ */
991
+ provider: OnrampProvider;
967
992
 
968
- hmac_create_secret?: boolean;
993
+ kyc_redirect_url?: string;
969
994
  }
970
995
 
971
996
  /**
972
- * The authenticator assertion response from a WebAuthn authentication ceremony.
997
+ * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
973
998
  */
974
- export interface PasskeyAssertionResponse {
975
- authenticator_data: string;
976
-
977
- client_data_json: string;
999
+ export type CryptoCurrencyCode = string;
978
1000
 
979
- signature: string;
1001
+ /**
1002
+ * The ID of a custom OAuth provider, set up for this app. Must start with
1003
+ * "custom:".
1004
+ */
1005
+ export type CustomOAuthProviderID = `custom:${string}`;
980
1006
 
981
- user_handle?: string;
982
- }
1007
+ /**
1008
+ * The ID of an external OAuth provider.
1009
+ */
1010
+ export type ExternalOAuthProviderID =
1011
+ | 'google'
1012
+ | 'discord'
1013
+ | 'twitter'
1014
+ | 'github'
1015
+ | 'spotify'
1016
+ | 'instagram'
1017
+ | 'tiktok'
1018
+ | 'linkedin'
1019
+ | 'apple'
1020
+ | 'line'
1021
+ | 'twitch';
983
1022
 
984
1023
  /**
985
- * WebAuthn authentication options as defined by the Web Authentication
986
- * specification.
1024
+ * Input for authenticating with Farcaster.
987
1025
  */
988
- export interface PasskeyAuthenticatorVerifyOptions {
989
- challenge: string;
1026
+ export interface FarcasterAuthenticateInput {
1027
+ channel_token: string;
990
1028
 
991
- allow_credentials?: Array<PasskeyCredentialDescriptor>;
1029
+ fid: number;
1030
+
1031
+ message: string;
1032
+
1033
+ signature: string;
992
1034
 
993
1035
  /**
994
- * Extensions for a WebAuthn authentication ceremony.
1036
+ * Whether to allow sign-up during authentication.
995
1037
  */
996
- extensions?: PasskeyVerifyExtensions;
997
-
998
- rp_id?: string;
1038
+ mode?: AuthenticateModeOption;
1039
+ }
999
1040
 
1000
- timeout?: number;
1041
+ /**
1042
+ * Proxy for the Farcaster Connect init response as defined in FIP-11.
1043
+ */
1044
+ export interface FarcasterConnectInitResponse {
1045
+ channel_token: string;
1001
1046
 
1002
- user_verification?: string;
1047
+ connect_uri: string;
1003
1048
  }
1004
1049
 
1005
1050
  /**
1006
- * WebAuthn authentication response as defined by the Web Authentication
1007
- * specification.
1051
+ * Proxy for the Farcaster Connect completed status response as defined in FIP-11.
1008
1052
  */
1009
- export interface PasskeyAuthenticatorVerifyResponse {
1010
- id: string;
1053
+ export interface FarcasterConnectStatusCompletedResponse {
1054
+ bio: string;
1011
1055
 
1012
- /**
1013
- * Client extension results returned by the WebAuthn authenticator.
1014
- */
1015
- client_extension_results: PasskeyClientExtensionResults;
1056
+ display_name: string;
1016
1057
 
1017
- raw_id: string;
1058
+ fid: number;
1018
1059
 
1019
- /**
1020
- * The authenticator assertion response from a WebAuthn authentication ceremony.
1021
- */
1022
- response: PasskeyAssertionResponse;
1060
+ message: string;
1023
1061
 
1024
- type: 'public-key';
1062
+ nonce: string;
1025
1063
 
1026
- authenticator_attachment?: string;
1064
+ pfp_url: string;
1065
+
1066
+ signature: string;
1067
+
1068
+ state: 'completed';
1069
+
1070
+ username: string;
1027
1071
  }
1028
1072
 
1029
1073
  /**
1030
- * Response for initiating a passkey authentication ceremony.
1074
+ * Proxy for the Farcaster Connect pending status response as defined in FIP-11.
1031
1075
  */
1032
- export interface ResponsePasskeyInitAuthenticate {
1033
- /**
1034
- * WebAuthn authentication options as defined by the Web Authentication
1035
- * specification.
1036
- */
1037
- options: PasskeyAuthenticatorVerifyOptions;
1076
+ export interface FarcasterConnectStatusPendingResponse {
1077
+ nonce: string;
1038
1078
 
1039
- relying_party?: string;
1079
+ state: 'pending';
1040
1080
  }
1041
1081
 
1042
1082
  /**
1043
- * Input for authenticating with a passkey.
1083
+ * Input for initiating a Farcaster connection.
1044
1084
  */
1045
- export interface PasskeyAuthenticateInput {
1046
- /**
1047
- * WebAuthn authentication response as defined by the Web Authentication
1048
- * specification.
1049
- */
1050
- authenticator_response: PasskeyAuthenticatorVerifyResponse;
1085
+ export interface FarcasterInitInput {
1086
+ token?: string;
1051
1087
 
1052
- challenge: string;
1088
+ redirect_url?: string;
1053
1089
 
1054
1090
  relying_party?: string;
1055
1091
  }
1056
1092
 
1057
1093
  /**
1058
- * The request body for transferring a passwordless account.
1094
+ * Input for linking a Farcaster account.
1059
1095
  */
1060
- export interface PasswordlessTransferRequestBody {
1061
- email: string;
1096
+ export interface FarcasterLinkInput {
1097
+ channel_token: string;
1098
+
1099
+ fid: number;
1062
1100
 
1063
- nonce: string;
1101
+ message: string;
1102
+
1103
+ signature: string;
1064
1104
  }
1065
1105
 
1066
1106
  /**
1067
- * The request body for transferring a passwordless sms account.
1107
+ * A Farcaster signer response when the signer has been approved.
1068
1108
  */
1069
- export interface PasswordlessSMSTransferRequestBody {
1070
- nonce: string;
1109
+ export interface FarcasterSignerApproved {
1110
+ fid: string;
1071
1111
 
1072
- phoneNumber: string;
1112
+ public_key: string;
1113
+
1114
+ status: 'approved';
1073
1115
  }
1074
1116
 
1075
1117
  /**
1076
- * Input for authenticating with a custom JWT.
1118
+ * A Farcaster signer init response when the signer is pending approval.
1077
1119
  */
1078
- export interface AuthenticateJwtInput {
1079
- token?: string;
1120
+ export interface FarcasterSignerInitPendingApproval {
1121
+ public_key: string;
1080
1122
 
1081
- /**
1082
- * Whether to allow sign-up during authentication.
1083
- */
1084
- mode?: AuthenticateModeOption;
1085
- }
1123
+ signer_approval_url: string;
1086
1124
 
1087
- /**
1088
- * Input for linking a custom JWT account.
1089
- */
1090
- export interface LinkJwtInput {
1091
- token?: string;
1125
+ status: 'pending_approval';
1092
1126
  }
1093
1127
 
1094
1128
  /**
1095
- * The request input for getting a native onramp provider customer.
1129
+ * A Farcaster signer response when the signer has been revoked.
1096
1130
  */
1097
- export interface GetFiatCustomerRequestInput {
1098
- /**
1099
- * Valid set of onramp providers
1100
- */
1101
- provider: OnrampProvider;
1131
+ export interface FarcasterSignerRevoked {
1132
+ fid: string;
1102
1133
 
1103
- kyc_redirect_url?: string;
1134
+ public_key: string;
1135
+
1136
+ status: 'revoked';
1104
1137
  }
1105
1138
 
1106
1139
  /**
1107
- * The request input for creating (or updating) a native onramp provider customer.
1140
+ * A Farcaster signer status response when the signer is pending approval.
1108
1141
  */
1109
- export interface CreateOrUpdateFiatCustomerRequestInput {
1110
- has_accepted_terms: boolean;
1111
-
1112
- /**
1113
- * Valid set of onramp providers
1114
- */
1115
- provider: OnrampProvider;
1142
+ export interface FarcasterSignerStatusPendingApproval {
1143
+ public_key: string;
1116
1144
 
1117
- kyc_redirect_url?: string;
1145
+ status: 'pending_approval';
1118
1146
  }
1119
1147
 
1120
1148
  /**
1121
- * A rejection reason for a customer KYC verification.
1149
+ * Input for unlinking a Farcaster account.
1122
1150
  */
1123
- export interface BridgeFiatRejectionReason {
1124
- reason: string;
1151
+ export interface FarcasterUnlinkInput {
1152
+ fid: number;
1125
1153
  }
1126
1154
 
1127
1155
  /**
1128
- * The response for getting a native onramp provider customer.
1156
+ * Input for authenticating a Farcaster V2 account.
1129
1157
  */
1130
- export interface BridgeFiatCustomerResponse {
1131
- has_accepted_terms: boolean;
1158
+ export interface FarcasterV2AuthenticateInput {
1159
+ fid: number;
1132
1160
 
1133
- provider: 'bridge';
1161
+ message: string;
1162
+
1163
+ signature: string;
1134
1164
 
1135
1165
  /**
1136
- * Status of the KYC verification process.
1166
+ * Whether to allow sign-up during authentication.
1137
1167
  */
1138
- status:
1139
- | 'not_found'
1140
- | 'active'
1141
- | 'awaiting_questionnaire'
1142
- | 'awaiting_ubo'
1143
- | 'incomplete'
1144
- | 'not_started'
1145
- | 'offboarded'
1146
- | 'paused'
1147
- | 'rejected'
1148
- | 'under_review';
1149
-
1150
- kyc_url?: string;
1151
-
1152
- rejection_reasons?: Array<BridgeFiatRejectionReason>;
1168
+ mode?: AuthenticateModeOption;
1153
1169
  }
1154
1170
 
1155
1171
  /**
1156
- * The response for getting a native onramp provider customer.
1172
+ * The request body for authenticating a Farcaster V2 account.
1157
1173
  */
1158
- export interface BridgeSandboxFiatCustomerResponse {
1159
- has_accepted_terms: boolean;
1174
+ export interface FarcasterV2AuthenticateRequestBody {
1175
+ fid: number;
1160
1176
 
1161
- provider: 'bridge-sandbox';
1177
+ message: string;
1178
+
1179
+ signature: string;
1162
1180
 
1163
1181
  /**
1164
- * Status of the KYC verification process.
1182
+ * Whether to allow sign-up during authentication.
1165
1183
  */
1166
- status:
1167
- | 'not_found'
1168
- | 'active'
1169
- | 'awaiting_questionnaire'
1170
- | 'awaiting_ubo'
1171
- | 'incomplete'
1172
- | 'not_started'
1173
- | 'offboarded'
1174
- | 'paused'
1175
- | 'rejected'
1176
- | 'under_review';
1177
-
1178
- kyc_url?: string;
1179
-
1180
- rejection_reasons?: Array<BridgeFiatRejectionReason>;
1184
+ mode?: AuthenticateModeOption;
1181
1185
  }
1182
1186
 
1183
1187
  /**
1184
- * The response for getting a native onramp provider customer.
1188
+ * Input for initiating a Farcaster V2 connection.
1185
1189
  */
1186
- export type FiatCustomerResponse = BridgeFiatCustomerResponse | BridgeSandboxFiatCustomerResponse;
1190
+ export interface FarcasterV2InitInput {}
1187
1191
 
1188
1192
  /**
1189
- * ISO 4217 fiat currency code. Three uppercase ASCII letters.
1193
+ * The request body for initiating a Farcaster V2 connection.
1190
1194
  */
1191
- export type FiatCurrencyCode = string;
1195
+ export interface FarcasterV2InitRequestBody {}
1192
1196
 
1193
1197
  /**
1194
- * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
1198
+ * Response for initiating a Farcaster V2 connection.
1195
1199
  */
1196
- export type CryptoCurrencyCode = string;
1200
+ export interface FarcasterV2InitResponse {
1201
+ expires_at: string;
1202
+
1203
+ nonce: string;
1204
+ }
1197
1205
 
1198
1206
  /**
1199
- * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
1200
- * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
1207
+ * The response body for initiating a Farcaster V2 connection.
1201
1208
  */
1202
- export type Caip2ChainID = string;
1209
+ export interface FarcasterV2InitResponseBody {
1210
+ expires_at: string;
1211
+
1212
+ nonce: string;
1213
+ }
1203
1214
 
1204
1215
  /**
1205
1216
  * A positive decimal amount as a string (e.g. "100", "50.25", "0.001").
@@ -1207,19 +1218,14 @@ export type Caip2ChainID = string;
1207
1218
  export type FiatAmount = string;
1208
1219
 
1209
1220
  /**
1210
- * Source currency details for a fiat onramp quote request.
1221
+ * ISO 4217 fiat currency code. Three uppercase ASCII letters.
1211
1222
  */
1212
- export interface FiatOnrampSource {
1213
- /**
1214
- * A positive decimal amount as a string (e.g. "100", "50.25", "0.001").
1215
- */
1216
- amount: FiatAmount;
1223
+ export type FiatCurrencyCode = string;
1217
1224
 
1218
- /**
1219
- * ISO 4217 fiat currency code. Three uppercase ASCII letters.
1220
- */
1221
- asset: FiatCurrencyCode;
1222
- }
1225
+ /**
1226
+ * The response for getting a native onramp provider customer.
1227
+ */
1228
+ export type FiatCustomerResponse = BridgeFiatCustomerResponse | BridgeSandboxFiatCustomerResponse;
1223
1229
 
1224
1230
  /**
1225
1231
  * Destination cryptocurrency details for a fiat onramp quote request.
@@ -1256,23 +1262,15 @@ export type FiatOnrampProvider =
1256
1262
  | 'coinbase-sandbox';
1257
1263
 
1258
1264
  /**
1259
- * The request input for getting fiat onramp quotes.
1265
+ * An error from a specific fiat onramp provider when fetching quotes.
1260
1266
  */
1261
- export interface GetFiatOnrampQuotesInput {
1262
- /**
1263
- * Destination cryptocurrency details for a fiat onramp quote request.
1264
- */
1265
- destination: FiatOnrampDestination;
1266
-
1267
- /**
1268
- * Whether to use the sandbox or production environment for fiat onramp.
1269
- */
1270
- environment: FiatOnrampEnvironment;
1267
+ export interface FiatOnrampProviderError {
1268
+ error: string;
1271
1269
 
1272
1270
  /**
1273
- * Source currency details for a fiat onramp quote request.
1271
+ * The fiat onramp provider to use.
1274
1272
  */
1275
- source: FiatOnrampSource;
1273
+ provider: FiatOnrampProvider;
1276
1274
  }
1277
1275
 
1278
1276
  /**
@@ -1292,28 +1290,117 @@ export interface FiatOnrampQuote {
1292
1290
 
1293
1291
  source_currency_code?: string | null;
1294
1292
 
1295
- sub_provider?: string | null;
1293
+ sub_provider?: string | null;
1294
+ }
1295
+
1296
+ /**
1297
+ * Source currency details for a fiat onramp quote request.
1298
+ */
1299
+ export interface FiatOnrampSource {
1300
+ /**
1301
+ * A positive decimal amount as a string (e.g. "100", "50.25", "0.001").
1302
+ */
1303
+ amount: FiatAmount;
1304
+
1305
+ /**
1306
+ * ISO 4217 fiat currency code. Three uppercase ASCII letters.
1307
+ */
1308
+ asset: FiatCurrencyCode;
1309
+ }
1310
+
1311
+ /**
1312
+ * Normalized fiat onramp transaction status.
1313
+ */
1314
+ export type FiatOnrampTransactionStatus =
1315
+ | 'pending'
1316
+ | 'processing'
1317
+ | 'completed'
1318
+ | 'failed'
1319
+ | 'cancelled'
1320
+ | 'refunded'
1321
+ | 'unknown';
1322
+
1323
+ /**
1324
+ * The request input for creating virtual account.
1325
+ */
1326
+ export type FiatVirtualAccountRequest =
1327
+ | BridgeFiatVirtualAccountRequest
1328
+ | BridgeSandboxFiatVirtualAccountRequest;
1329
+
1330
+ /**
1331
+ * The response for creating virtual account.
1332
+ */
1333
+ export type FiatVirtualAccountResponse =
1334
+ | BridgeFiatVirtualAccountResponse
1335
+ | BridgeSandboxFiatVirtualAccountResponse;
1336
+
1337
+ /**
1338
+ * The request input for getting a native onramp provider customer.
1339
+ */
1340
+ export interface GetFiatCustomerRequestInput {
1341
+ /**
1342
+ * Valid set of onramp providers
1343
+ */
1344
+ provider: OnrampProvider;
1345
+
1346
+ kyc_redirect_url?: string;
1347
+ }
1348
+
1349
+ /**
1350
+ * The request input for getting fiat onramp quotes.
1351
+ */
1352
+ export interface GetFiatOnrampQuotesInput {
1353
+ /**
1354
+ * Destination cryptocurrency details for a fiat onramp quote request.
1355
+ */
1356
+ destination: FiatOnrampDestination;
1357
+
1358
+ /**
1359
+ * Whether to use the sandbox or production environment for fiat onramp.
1360
+ */
1361
+ environment: FiatOnrampEnvironment;
1362
+
1363
+ /**
1364
+ * Source currency details for a fiat onramp quote request.
1365
+ */
1366
+ source: FiatOnrampSource;
1367
+ }
1368
+
1369
+ /**
1370
+ * The response containing fiat onramp quotes.
1371
+ */
1372
+ export interface GetFiatOnrampQuotesResponse {
1373
+ quotes: Array<FiatOnrampQuote>;
1374
+
1375
+ provider_errors?: Array<FiatOnrampProviderError>;
1296
1376
  }
1297
1377
 
1298
1378
  /**
1299
- * An error from a specific fiat onramp provider when fetching quotes.
1379
+ * The request input for checking a fiat onramp session status.
1300
1380
  */
1301
- export interface FiatOnrampProviderError {
1302
- error: string;
1303
-
1381
+ export interface GetFiatOnrampTransactionStatusInput {
1304
1382
  /**
1305
1383
  * The fiat onramp provider to use.
1306
1384
  */
1307
1385
  provider: FiatOnrampProvider;
1386
+
1387
+ session_id: string;
1308
1388
  }
1309
1389
 
1310
1390
  /**
1311
- * The response containing fiat onramp quotes.
1391
+ * The response containing the fiat onramp session status.
1312
1392
  */
1313
- export interface GetFiatOnrampQuotesResponse {
1314
- quotes: Array<FiatOnrampQuote>;
1393
+ export interface GetFiatOnrampTransactionStatusResponse {
1394
+ raw_status: string;
1315
1395
 
1316
- provider_errors?: Array<FiatOnrampProviderError>;
1396
+ session_id: string;
1397
+
1398
+ /**
1399
+ * Normalized fiat onramp transaction status.
1400
+ */
1401
+ status: FiatOnrampTransactionStatus;
1402
+
1403
+ transaction_id?: string;
1317
1404
  }
1318
1405
 
1319
1406
  /**
@@ -1352,408 +1439,474 @@ export interface GetFiatOnrampURLResponse {
1352
1439
  }
1353
1440
 
1354
1441
  /**
1355
- * Normalized fiat onramp transaction status.
1442
+ * Input for linking a custom JWT account.
1356
1443
  */
1357
- export type FiatOnrampTransactionStatus =
1358
- | 'pending'
1359
- | 'processing'
1360
- | 'completed'
1361
- | 'failed'
1362
- | 'cancelled'
1363
- | 'refunded'
1364
- | 'unknown';
1444
+ export interface LinkJwtInput {
1445
+ token?: string;
1446
+ }
1365
1447
 
1366
1448
  /**
1367
- * The request input for checking a fiat onramp session status.
1449
+ * Input for enrolling SMS MFA.
1368
1450
  */
1369
- export interface GetFiatOnrampTransactionStatusInput {
1370
- /**
1371
- * The fiat onramp provider to use.
1372
- */
1373
- provider: FiatOnrampProvider;
1451
+ export interface MfaSMSInitEnrollInput {
1452
+ action: 'enroll';
1374
1453
 
1375
- session_id: string;
1454
+ phoneNumber: string;
1376
1455
  }
1377
1456
 
1378
1457
  /**
1379
- * The response containing the fiat onramp session status.
1458
+ * Input for verifying SMS MFA.
1380
1459
  */
1381
- export interface GetFiatOnrampTransactionStatusResponse {
1382
- raw_status: string;
1460
+ export interface MfaSMSInitVerifyInput {
1461
+ action: 'verify';
1462
+ }
1383
1463
 
1384
- session_id: string;
1464
+ /**
1465
+ * The type of OAuth authorization code.
1466
+ */
1467
+ export type OAuthCodeType = 'raw';
1468
+
1469
+ /**
1470
+ * The ID of an OAuth provider.
1471
+ */
1472
+ export type OAuthProviderID = ExternalOAuthProviderID | PrivyOAuthProviderID | CustomOAuthProviderID;
1473
+
1474
+ /**
1475
+ * The request body for transferring an OAuth account.
1476
+ */
1477
+ export interface OAuthTransferRequestBody {
1478
+ nonce: string;
1385
1479
 
1386
1480
  /**
1387
- * Normalized fiat onramp transaction status.
1481
+ * User info for an OAuth transfer.
1388
1482
  */
1389
- status: FiatOnrampTransactionStatus;
1390
-
1391
- transaction_id?: string;
1483
+ userInfo: OAuthTransferUserInfo;
1392
1484
  }
1393
1485
 
1394
- export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc';
1486
+ /**
1487
+ * User info for an OAuth transfer.
1488
+ */
1489
+ export interface OAuthTransferUserInfo {
1490
+ subject: string;
1395
1491
 
1396
- export type BridgeSourceAsset = 'usd' | 'eur' | 'mxn' | 'brl' | 'gbp';
1492
+ email?: string | null;
1397
1493
 
1398
- export interface BridgeFiatVirtualAccountSource {
1399
- asset: BridgeSourceAsset;
1400
- }
1494
+ embeddedWalletAddresses?: Array<string>;
1401
1495
 
1402
- export interface BridgeFiatVirtualAccountDestination {
1403
- address: string;
1496
+ /**
1497
+ * Metadata for an OAuth transfer user info.
1498
+ */
1499
+ meta?: OAuthTransferUserInfoMeta;
1404
1500
 
1405
- asset: BridgeDestinationAsset;
1501
+ name?: string;
1406
1502
 
1407
- chain: string;
1503
+ profilePictureUrl?: string;
1504
+
1505
+ smartWalletAddresses?: Array<string>;
1506
+
1507
+ username?: string;
1508
+
1509
+ vanityName?: string;
1408
1510
  }
1409
1511
 
1410
1512
  /**
1411
- * The request input for creating virtual account.
1513
+ * Metadata for an OAuth transfer user info.
1412
1514
  */
1413
- export interface BridgeFiatVirtualAccountRequest {
1414
- destination: BridgeFiatVirtualAccountDestination;
1515
+ export interface OAuthTransferUserInfoMeta {
1516
+ providerAppId?: string;
1517
+ }
1415
1518
 
1416
- provider: 'bridge';
1519
+ /**
1520
+ * Valid set of onramp providers
1521
+ */
1522
+ export type OnrampProvider = 'bridge' | 'bridge-sandbox';
1417
1523
 
1418
- source: BridgeFiatVirtualAccountSource;
1524
+ /**
1525
+ * The authenticator assertion response from a WebAuthn authentication ceremony.
1526
+ */
1527
+ export interface PasskeyAssertionResponse {
1528
+ authenticator_data: string;
1529
+
1530
+ client_data_json: string;
1531
+
1532
+ signature: string;
1533
+
1534
+ user_handle?: string;
1419
1535
  }
1420
1536
 
1421
1537
  /**
1422
- * The request input for creating virtual account.
1538
+ * The authenticator attestation response from a WebAuthn registration ceremony.
1423
1539
  */
1424
- export interface BridgeSandboxFiatVirtualAccountRequest {
1425
- destination: BridgeFiatVirtualAccountDestination;
1540
+ export interface PasskeyAttestationResponse {
1541
+ attestation_object: string;
1426
1542
 
1427
- provider: 'bridge-sandbox';
1543
+ client_data_json: string;
1428
1544
 
1429
- source: BridgeFiatVirtualAccountSource;
1545
+ authenticator_data?: string;
1546
+
1547
+ public_key?: string;
1548
+
1549
+ public_key_algorithm?: number;
1550
+
1551
+ transports?: Array<string>;
1430
1552
  }
1431
1553
 
1432
1554
  /**
1433
- * The request input for creating virtual account.
1555
+ * Input for authenticating with a passkey.
1434
1556
  */
1435
- export type FiatVirtualAccountRequest =
1436
- | BridgeFiatVirtualAccountRequest
1437
- | BridgeSandboxFiatVirtualAccountRequest;
1557
+ export interface PasskeyAuthenticateInput {
1558
+ /**
1559
+ * WebAuthn authentication response as defined by the Web Authentication
1560
+ * specification.
1561
+ */
1562
+ authenticator_response: PasskeyAuthenticatorVerifyResponse;
1563
+
1564
+ challenge: string;
1565
+
1566
+ relying_party?: string;
1567
+ }
1438
1568
 
1439
1569
  /**
1440
- * The deposit instructions for a virtual account.
1570
+ * WebAuthn registration options as defined by the Web Authentication
1571
+ * specification.
1441
1572
  */
1442
- export interface BridgeUsdFiatVirtualAccountDepositInstructions {
1443
- asset: 'usd';
1573
+ export interface PasskeyAuthenticatorEnrollmentOptions {
1574
+ challenge: string;
1444
1575
 
1445
- bank_account_number: string;
1576
+ pub_key_cred_params: Array<PasskeyPubKeyCredParam>;
1446
1577
 
1447
- bank_address: string;
1578
+ /**
1579
+ * Relying party information for a WebAuthn ceremony.
1580
+ */
1581
+ rp: PasskeyRelyingParty;
1448
1582
 
1449
- bank_beneficiary_address: string;
1583
+ /**
1584
+ * User entity for a WebAuthn registration ceremony.
1585
+ */
1586
+ user: PasskeyUser;
1450
1587
 
1451
- bank_beneficiary_name: string;
1588
+ attestation?: string;
1452
1589
 
1453
- bank_name: string;
1590
+ /**
1591
+ * Authenticator selection criteria for a WebAuthn registration ceremony.
1592
+ */
1593
+ authenticator_selection?: PasskeyAuthenticatorSelection;
1454
1594
 
1455
- bank_routing_number: string;
1595
+ exclude_credentials?: Array<PasskeyCredentialDescriptor>;
1456
1596
 
1457
- payment_rails: Array<'ach_push' | 'wire'>;
1597
+ /**
1598
+ * Extensions for a WebAuthn registration ceremony.
1599
+ */
1600
+ extensions?: PasskeyEnrollmentExtensions;
1601
+
1602
+ timeout?: number;
1458
1603
  }
1459
1604
 
1460
1605
  /**
1461
- * The deposit instructions for a virtual account.
1606
+ * WebAuthn registration response as defined by the Web Authentication
1607
+ * specification.
1462
1608
  */
1463
- export interface BridgeEurFiatVirtualAccountDepositInstructions {
1464
- account_holder_name: string;
1609
+ export interface PasskeyAuthenticatorEnrollmentResponse {
1610
+ id: string;
1465
1611
 
1466
- asset: 'eur';
1612
+ /**
1613
+ * Client extension results returned by the WebAuthn authenticator.
1614
+ */
1615
+ client_extension_results: PasskeyClientExtensionResults;
1467
1616
 
1468
- bank_address: string;
1617
+ raw_id: string;
1469
1618
 
1470
- bank_name: string;
1619
+ /**
1620
+ * The authenticator attestation response from a WebAuthn registration ceremony.
1621
+ */
1622
+ response: PasskeyAttestationResponse;
1471
1623
 
1472
- bic: string;
1624
+ type: 'public-key';
1473
1625
 
1474
- iban: string;
1626
+ authenticator_attachment?: string;
1627
+ }
1475
1628
 
1476
- payment_rails: Array<'sepa'>;
1629
+ /**
1630
+ * Authenticator selection criteria for a WebAuthn registration ceremony.
1631
+ */
1632
+ export interface PasskeyAuthenticatorSelection {
1633
+ authenticator_attachment?: string;
1634
+
1635
+ require_resident_key?: boolean;
1636
+
1637
+ resident_key?: string;
1638
+
1639
+ user_verification?: string;
1477
1640
  }
1478
1641
 
1479
1642
  /**
1480
- * The deposit instructions for a virtual account.
1643
+ * WebAuthn authentication options as defined by the Web Authentication
1644
+ * specification.
1481
1645
  */
1482
- export interface BridgeMxnFiatVirtualAccountDepositInstructions {
1483
- account_holder_name: string;
1646
+ export interface PasskeyAuthenticatorVerifyOptions {
1647
+ challenge: string;
1484
1648
 
1485
- asset: 'mxn';
1649
+ allow_credentials?: Array<PasskeyCredentialDescriptor>;
1486
1650
 
1487
- bank_address: string;
1651
+ /**
1652
+ * Extensions for a WebAuthn authentication ceremony.
1653
+ */
1654
+ extensions?: PasskeyVerifyExtensions;
1488
1655
 
1489
- bank_name: string;
1656
+ rp_id?: string;
1490
1657
 
1491
- clabe: string;
1658
+ timeout?: number;
1492
1659
 
1493
- payment_rails: Array<'spei'>;
1660
+ user_verification?: string;
1494
1661
  }
1495
1662
 
1496
1663
  /**
1497
- * The deposit instructions for a virtual account.
1664
+ * WebAuthn authentication response as defined by the Web Authentication
1665
+ * specification.
1498
1666
  */
1499
- export interface BridgeBrlFiatVirtualAccountDepositInstructions {
1500
- account_holder_name: string;
1667
+ export interface PasskeyAuthenticatorVerifyResponse {
1668
+ id: string;
1501
1669
 
1502
- asset: 'brl';
1670
+ /**
1671
+ * Client extension results returned by the WebAuthn authenticator.
1672
+ */
1673
+ client_extension_results: PasskeyClientExtensionResults;
1503
1674
 
1504
- bank_address: string;
1675
+ raw_id: string;
1505
1676
 
1506
- bank_name: string;
1677
+ /**
1678
+ * The authenticator assertion response from a WebAuthn authentication ceremony.
1679
+ */
1680
+ response: PasskeyAssertionResponse;
1507
1681
 
1508
- br_code: string;
1682
+ type: 'public-key';
1509
1683
 
1510
- payment_rails: Array<'pix'>;
1684
+ authenticator_attachment?: string;
1511
1685
  }
1512
1686
 
1513
1687
  /**
1514
- * The deposit instructions for a virtual account.
1688
+ * Client extension results returned by the WebAuthn authenticator.
1515
1689
  */
1516
- export interface BridgeGbpFiatVirtualAccountDepositInstructions {
1517
- account_holder_name: string;
1690
+ export interface PasskeyClientExtensionResults {
1691
+ app_id?: boolean;
1518
1692
 
1519
- account_number: string;
1693
+ /**
1694
+ * The result of the WebAuthn credProps extension.
1695
+ */
1696
+ cred_props?: PasskeyCredPropsResult;
1520
1697
 
1521
- asset: 'gbp';
1698
+ hmac_create_secret?: boolean;
1699
+ }
1522
1700
 
1523
- bank_address: string;
1701
+ /**
1702
+ * The result of the WebAuthn credProps extension.
1703
+ */
1704
+ export interface PasskeyCredPropsResult {
1705
+ rk?: boolean;
1706
+ }
1524
1707
 
1525
- bank_name: string;
1708
+ /**
1709
+ * A WebAuthn credential descriptor identifying a specific public key credential.
1710
+ */
1711
+ export interface PasskeyCredentialDescriptor {
1712
+ id: string;
1526
1713
 
1527
- payment_rails: Array<'faster_payments'>;
1714
+ type: string;
1528
1715
 
1529
- sort_code: string;
1716
+ transports?: Array<string>;
1530
1717
  }
1531
1718
 
1532
1719
  /**
1533
- * The deposit instructions for a virtual account.
1720
+ * Extensions for a WebAuthn registration ceremony.
1534
1721
  */
1535
- export type BridgeFiatVirtualAccountDepositInstructions =
1536
- | BridgeUsdFiatVirtualAccountDepositInstructions
1537
- | BridgeEurFiatVirtualAccountDepositInstructions
1538
- | BridgeMxnFiatVirtualAccountDepositInstructions
1539
- | BridgeBrlFiatVirtualAccountDepositInstructions
1540
- | BridgeGbpFiatVirtualAccountDepositInstructions;
1722
+ export interface PasskeyEnrollmentExtensions {
1723
+ app_id?: string;
1541
1724
 
1542
- /**
1543
- * The response for creating virtual account.
1544
- */
1545
- export interface BridgeFiatVirtualAccountResponse {
1546
1725
  /**
1547
- * The deposit instructions for a virtual account.
1726
+ * The result of the WebAuthn credProps extension.
1548
1727
  */
1549
- deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
1728
+ cred_props?: PasskeyCredPropsResult;
1550
1729
 
1551
- destination: BridgeFiatVirtualAccountDestination;
1730
+ hmac_create_secret?: boolean;
1731
+ }
1552
1732
 
1553
- provider: 'bridge';
1733
+ /**
1734
+ * Input for initiating a passkey ceremony.
1735
+ */
1736
+ export interface PasskeyInitInput {
1737
+ token?: string;
1554
1738
 
1555
- status: string;
1739
+ relying_party?: string;
1556
1740
  }
1557
1741
 
1558
1742
  /**
1559
- * The response for creating virtual account.
1743
+ * Input for linking a passkey credential.
1560
1744
  */
1561
- export interface BridgeSandboxFiatVirtualAccountResponse {
1745
+ export interface PasskeyLinkInput {
1562
1746
  /**
1563
- * The deposit instructions for a virtual account.
1747
+ * WebAuthn registration response as defined by the Web Authentication
1748
+ * specification.
1564
1749
  */
1565
- deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
1566
-
1567
- destination: BridgeFiatVirtualAccountDestination;
1568
-
1569
- provider: 'bridge-sandbox';
1750
+ authenticator_response: PasskeyAuthenticatorEnrollmentResponse;
1570
1751
 
1571
- status: string;
1752
+ relying_party?: string;
1572
1753
  }
1573
1754
 
1574
1755
  /**
1575
- * The response for creating virtual account.
1756
+ * A public key credential parameter specifying the algorithm and credential type.
1576
1757
  */
1577
- export type FiatVirtualAccountResponse =
1578
- | BridgeFiatVirtualAccountResponse
1579
- | BridgeSandboxFiatVirtualAccountResponse;
1758
+ export interface PasskeyPubKeyCredParam {
1759
+ alg: number;
1580
1760
 
1581
- /**
1582
- * The type of OAuth authorization code.
1583
- */
1584
- export type OAuthCodeType = 'raw';
1761
+ type: 'public-key';
1762
+ }
1585
1763
 
1586
1764
  /**
1587
- * Metadata for an OAuth transfer user info.
1765
+ * Input for registering a passkey credential.
1588
1766
  */
1589
- export interface OAuthTransferUserInfoMeta {
1590
- providerAppId?: string;
1767
+ export interface PasskeyRegisterInput {
1768
+ /**
1769
+ * WebAuthn registration response as defined by the Web Authentication
1770
+ * specification.
1771
+ */
1772
+ authenticator_response: PasskeyAuthenticatorEnrollmentResponse;
1773
+
1774
+ relying_party?: string;
1591
1775
  }
1592
1776
 
1593
1777
  /**
1594
- * User info for an OAuth transfer.
1778
+ * Relying party information for a WebAuthn ceremony.
1595
1779
  */
1596
- export interface OAuthTransferUserInfo {
1597
- subject: string;
1598
-
1599
- email?: string | null;
1780
+ export interface PasskeyRelyingParty {
1781
+ name: string;
1600
1782
 
1601
- embeddedWalletAddresses?: Array<string>;
1783
+ id?: string;
1784
+ }
1602
1785
 
1603
- /**
1604
- * Metadata for an OAuth transfer user info.
1605
- */
1606
- meta?: OAuthTransferUserInfoMeta;
1786
+ /**
1787
+ * User entity for a WebAuthn registration ceremony.
1788
+ */
1789
+ export interface PasskeyUser {
1790
+ id: string;
1607
1791
 
1608
- name?: string;
1792
+ display_name: string;
1609
1793
 
1610
- profilePictureUrl?: string;
1794
+ name: string;
1795
+ }
1611
1796
 
1612
- smartWalletAddresses?: Array<string>;
1797
+ /**
1798
+ * Extensions for a WebAuthn authentication ceremony.
1799
+ */
1800
+ export interface PasskeyVerifyExtensions {
1801
+ app_id?: string;
1613
1802
 
1614
- username?: string;
1803
+ cred_props?: boolean;
1615
1804
 
1616
- vanityName?: string;
1805
+ hmac_create_secret?: boolean;
1617
1806
  }
1618
1807
 
1619
1808
  /**
1620
- * The request body for transferring an OAuth account.
1809
+ * The request body for transferring a passwordless sms account.
1621
1810
  */
1622
- export interface OAuthTransferRequestBody {
1811
+ export interface PasswordlessSMSTransferRequestBody {
1623
1812
  nonce: string;
1624
1813
 
1625
- /**
1626
- * User info for an OAuth transfer.
1627
- */
1628
- userInfo: OAuthTransferUserInfo;
1814
+ phoneNumber: string;
1629
1815
  }
1630
1816
 
1631
1817
  /**
1632
- * Input for a SIWE signing ceremony.
1818
+ * The request body for transferring a passwordless account.
1633
1819
  */
1634
- export interface SiweInput {
1635
- message: string;
1636
-
1637
- signature: string;
1638
-
1639
- chainId?: string | null;
1640
-
1641
- connectorType?: string | null;
1820
+ export interface PasswordlessTransferRequestBody {
1821
+ email: string;
1642
1822
 
1643
- walletClientType?: string | null;
1823
+ nonce: string;
1644
1824
  }
1645
1825
 
1646
1826
  /**
1647
- * Input for a smart wallet SIWE signing ceremony.
1827
+ * The ID of a Privy app as an OAuth provider. Must start with "privy:".
1648
1828
  */
1649
- export interface SmartWalletSiweInput {
1650
- message: string;
1651
-
1652
- signature: string;
1829
+ export type PrivyOAuthProviderID = `privy:${string}`;
1653
1830
 
1831
+ /**
1832
+ * Response for initiating a passkey authentication ceremony.
1833
+ */
1834
+ export interface ResponsePasskeyInitAuthenticate {
1654
1835
  /**
1655
- * The supported smart wallet providers.
1836
+ * WebAuthn authentication options as defined by the Web Authentication
1837
+ * specification.
1656
1838
  */
1657
- smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
1839
+ options: PasskeyAuthenticatorVerifyOptions;
1658
1840
 
1659
- smart_wallet_version?: string;
1841
+ relying_party?: string;
1660
1842
  }
1661
1843
 
1662
1844
  /**
1663
- * Input for authenticating a SIWE ceremony.
1845
+ * Response for initiating a passkey link ceremony.
1664
1846
  */
1665
- export interface AuthenticateSiweInput {
1666
- message: string;
1667
-
1668
- signature: string;
1669
-
1670
- chainId?: string | null;
1671
-
1672
- connectorType?: string | null;
1673
-
1847
+ export interface ResponsePasskeyInitLink {
1674
1848
  /**
1675
- * Whether to allow sign-up during authentication.
1849
+ * WebAuthn registration options as defined by the Web Authentication
1850
+ * specification.
1676
1851
  */
1677
- mode?: AuthenticateModeOption;
1678
-
1679
- walletClientType?: string | null;
1680
- }
1852
+ options: PasskeyAuthenticatorEnrollmentOptions;
1681
1853
 
1682
- /**
1683
- * Input containing a SIWE wallet address.
1684
- */
1685
- export interface SiweAddressInput {
1686
- address: string;
1854
+ relying_party?: string;
1687
1855
  }
1688
1856
 
1689
1857
  /**
1690
- * Input for initiating a SIWE ceremony.
1858
+ * Response for initiating a passkey registration ceremony.
1691
1859
  */
1692
- export interface SiweInitInput {
1693
- token?: string;
1860
+ export interface ResponsePasskeyInitRegister {
1861
+ /**
1862
+ * WebAuthn registration options as defined by the Web Authentication
1863
+ * specification.
1864
+ */
1865
+ options: PasskeyAuthenticatorEnrollmentOptions;
1694
1866
 
1695
- address?: string;
1867
+ relying_party?: string;
1696
1868
  }
1697
1869
 
1698
1870
  /**
1699
- * A SIWE nonce response.
1871
+ * Input containing a SIWE wallet address.
1700
1872
  */
1701
- export interface SiweNonce {
1873
+ export interface SiweAddressInput {
1702
1874
  address: string;
1703
-
1704
- expires_at: string;
1705
-
1706
- nonce: string;
1707
1875
  }
1708
1876
 
1709
- /**
1710
- * Input for transferring a SIWE account.
1711
- */
1712
- export interface TransferSiweInput {
1713
- address: string;
1714
-
1715
- nonce: string;
1716
-
1717
- chainId?: string | null;
1718
-
1719
- connectorType?: string | null;
1877
+ /**
1878
+ * Input for initiating a SIWE ceremony.
1879
+ */
1880
+ export interface SiweInitInput {
1881
+ token?: string;
1720
1882
 
1721
- walletClientType?: string | null;
1883
+ address?: string;
1722
1884
  }
1723
1885
 
1724
1886
  /**
1725
- * Input for a SIWS signing ceremony.
1887
+ * Input for a SIWE signing ceremony.
1726
1888
  */
1727
- export interface SiwsInput {
1889
+ export interface SiweInput {
1728
1890
  message: string;
1729
1891
 
1730
1892
  signature: string;
1731
1893
 
1732
- connectorType?: string | null;
1894
+ chainId?: string | null;
1733
1895
 
1734
- message_type?: 'transaction' | 'plain';
1896
+ connectorType?: string | null;
1735
1897
 
1736
1898
  walletClientType?: string | null;
1737
1899
  }
1738
1900
 
1739
1901
  /**
1740
- * Input for authenticating a SIWS ceremony.
1902
+ * A SIWE nonce response.
1741
1903
  */
1742
- export interface AuthenticateSiwsInput {
1743
- message: string;
1744
-
1745
- signature: string;
1746
-
1747
- connectorType?: string | null;
1748
-
1749
- message_type?: 'transaction' | 'plain';
1904
+ export interface SiweNonce {
1905
+ address: string;
1750
1906
 
1751
- /**
1752
- * Whether to allow sign-up during authentication.
1753
- */
1754
- mode?: AuthenticateModeOption;
1907
+ expires_at: string;
1755
1908
 
1756
- walletClientType?: string | null;
1909
+ nonce: string;
1757
1910
  }
1758
1911
 
1759
1912
  /**
@@ -1772,6 +1925,21 @@ export interface SiwsInitInput {
1772
1925
  token?: string;
1773
1926
  }
1774
1927
 
1928
+ /**
1929
+ * Input for a SIWS signing ceremony.
1930
+ */
1931
+ export interface SiwsInput {
1932
+ message: string;
1933
+
1934
+ signature: string;
1935
+
1936
+ connectorType?: string | null;
1937
+
1938
+ message_type?: 'transaction' | 'plain';
1939
+
1940
+ walletClientType?: string | null;
1941
+ }
1942
+
1775
1943
  /**
1776
1944
  * A SIWS nonce response.
1777
1945
  */
@@ -1784,16 +1952,19 @@ export interface SiwsNonce {
1784
1952
  }
1785
1953
 
1786
1954
  /**
1787
- * Input for transferring a SIWS account.
1955
+ * Input for a smart wallet SIWE signing ceremony.
1788
1956
  */
1789
- export interface TransferSiwsInput {
1790
- address: string;
1957
+ export interface SmartWalletSiweInput {
1958
+ message: string;
1791
1959
 
1792
- nonce: string;
1960
+ signature: string;
1793
1961
 
1794
- connectorType?: string | null;
1962
+ /**
1963
+ * The supported smart wallet providers.
1964
+ */
1965
+ smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
1795
1966
 
1796
- walletClientType?: string | null;
1967
+ smart_wallet_version?: string;
1797
1968
  }
1798
1969
 
1799
1970
  /**
@@ -1816,28 +1987,6 @@ export interface TelegramAuthResult {
1816
1987
  username?: string;
1817
1988
  }
1818
1989
 
1819
- /**
1820
- * Auth result object returned by Telegram when a user authenticates using a mini
1821
- * app.
1822
- */
1823
- export interface TelegramWebAppData {
1824
- auth_date: number | null;
1825
-
1826
- hash: string;
1827
-
1828
- user: string;
1829
-
1830
- chat_instance?: string;
1831
-
1832
- chat_type?: string;
1833
-
1834
- query_id?: string;
1835
-
1836
- signature?: string;
1837
-
1838
- start_param?: string;
1839
- }
1840
-
1841
1990
  /**
1842
1991
  * Input for authenticating with Telegram.
1843
1992
  */
@@ -1870,241 +2019,92 @@ export interface TelegramUnlinkInput {
1870
2019
  }
1871
2020
 
1872
2021
  /**
1873
- * Input for transferring a Telegram account.
1874
- */
1875
- export interface TransferTelegramInput {
1876
- nonce: string;
1877
-
1878
- /**
1879
- * Auth result object returned by Telegram when a user authenticates using the
1880
- * login widget.
1881
- */
1882
- telegram_auth_result?: TelegramAuthResult;
1883
-
1884
- /**
1885
- * Auth result object returned by Telegram when a user authenticates using a mini
1886
- * app.
1887
- */
1888
- telegram_web_app_data?: TelegramWebAppData;
1889
- }
1890
-
1891
- /**
1892
- * Proxy for the Farcaster Connect init response as defined in FIP-11.
1893
- */
1894
- export interface FarcasterConnectInitResponse {
1895
- channel_token: string;
1896
-
1897
- connect_uri: string;
1898
- }
1899
-
1900
- /**
1901
- * Proxy for the Farcaster Connect completed status response as defined in FIP-11.
1902
- */
1903
- export interface FarcasterConnectStatusCompletedResponse {
1904
- bio: string;
1905
-
1906
- display_name: string;
1907
-
1908
- fid: number;
1909
-
1910
- message: string;
1911
-
1912
- nonce: string;
1913
-
1914
- pfp_url: string;
1915
-
1916
- signature: string;
1917
-
1918
- state: 'completed';
1919
-
1920
- username: string;
1921
- }
1922
-
1923
- /**
1924
- * Proxy for the Farcaster Connect pending status response as defined in FIP-11.
1925
- */
1926
- export interface FarcasterConnectStatusPendingResponse {
1927
- nonce: string;
1928
-
1929
- state: 'pending';
1930
- }
1931
-
1932
- /**
1933
- * Input for authenticating with Farcaster.
1934
- */
1935
- export interface FarcasterAuthenticateInput {
1936
- channel_token: string;
1937
-
1938
- fid: number;
1939
-
1940
- message: string;
1941
-
1942
- signature: string;
1943
-
1944
- /**
1945
- * Whether to allow sign-up during authentication.
1946
- */
1947
- mode?: AuthenticateModeOption;
1948
- }
1949
-
1950
- /**
1951
- * Input for linking a Farcaster account.
1952
- */
1953
- export interface FarcasterLinkInput {
1954
- channel_token: string;
1955
-
1956
- fid: number;
1957
-
1958
- message: string;
1959
-
1960
- signature: string;
1961
- }
1962
-
1963
- /**
1964
- * Input for initiating a Farcaster connection.
1965
- */
1966
- export interface FarcasterInitInput {
1967
- token?: string;
1968
-
1969
- redirect_url?: string;
1970
-
1971
- relying_party?: string;
1972
- }
1973
-
1974
- /**
1975
- * Input for unlinking a Farcaster account.
1976
- */
1977
- export interface FarcasterUnlinkInput {
1978
- fid: number;
1979
- }
1980
-
1981
- /**
1982
- * Input for transferring a Farcaster account.
1983
- */
1984
- export interface TransferFarcasterInput {
1985
- farcaster_embedded_address: string;
1986
-
1987
- farcaster_id: string;
1988
-
1989
- nonce: string;
1990
- }
1991
-
1992
- /**
1993
- * Input for initiating a Farcaster V2 connection.
1994
- */
1995
- export type FarcasterV2InitInput = unknown;
1996
-
1997
- /**
1998
- * Response for initiating a Farcaster V2 connection.
1999
- */
2000
- export interface FarcasterV2InitResponse {
2001
- expires_at: string;
2002
-
2003
- nonce: string;
2004
- }
2005
-
2006
- /**
2007
- * Input for authenticating a Farcaster V2 account.
2022
+ * Auth result object returned by Telegram when a user authenticates using a mini
2023
+ * app.
2008
2024
  */
2009
- export interface FarcasterV2AuthenticateInput {
2010
- fid: number;
2011
-
2012
- message: string;
2013
-
2014
- signature: string;
2015
-
2016
- /**
2017
- * Whether to allow sign-up during authentication.
2018
- */
2019
- mode?: AuthenticateModeOption;
2020
- }
2025
+ export interface TelegramWebAppData {
2026
+ auth_date: number | null;
2021
2027
 
2022
- /**
2023
- * The request body for initiating a Farcaster V2 connection.
2024
- */
2025
- export type FarcasterV2InitRequestBody = unknown;
2028
+ hash: string;
2026
2029
 
2027
- /**
2028
- * The response body for initiating a Farcaster V2 connection.
2029
- */
2030
- export interface FarcasterV2InitResponseBody {
2031
- expires_at: string;
2030
+ user: string;
2032
2031
 
2033
- nonce: string;
2034
- }
2032
+ chat_instance?: string;
2035
2033
 
2036
- /**
2037
- * The request body for authenticating a Farcaster V2 account.
2038
- */
2039
- export interface FarcasterV2AuthenticateRequestBody {
2040
- fid: number;
2034
+ chat_type?: string;
2041
2035
 
2042
- message: string;
2036
+ query_id?: string;
2043
2037
 
2044
- signature: string;
2038
+ signature?: string;
2045
2039
 
2046
- /**
2047
- * Whether to allow sign-up during authentication.
2048
- */
2049
- mode?: AuthenticateModeOption;
2040
+ start_param?: string;
2050
2041
  }
2051
2042
 
2052
2043
  /**
2053
- * A Farcaster signer init response when the signer is pending approval.
2044
+ * Input for transferring a Farcaster account.
2054
2045
  */
2055
- export interface FarcasterSignerInitPendingApproval {
2056
- public_key: string;
2046
+ export interface TransferFarcasterInput {
2047
+ farcaster_embedded_address: string;
2057
2048
 
2058
- signer_approval_url: string;
2049
+ farcaster_id: string;
2059
2050
 
2060
- status: 'pending_approval';
2051
+ nonce: string;
2061
2052
  }
2062
2053
 
2063
2054
  /**
2064
- * A Farcaster signer response when the signer has been approved.
2055
+ * Input for transferring a SIWE account.
2065
2056
  */
2066
- export interface FarcasterSignerApproved {
2067
- fid: string;
2057
+ export interface TransferSiweInput {
2058
+ address: string;
2068
2059
 
2069
- public_key: string;
2060
+ nonce: string;
2070
2061
 
2071
- status: 'approved';
2062
+ chainId?: string | null;
2063
+
2064
+ connectorType?: string | null;
2065
+
2066
+ walletClientType?: string | null;
2072
2067
  }
2073
2068
 
2074
2069
  /**
2075
- * A Farcaster signer response when the signer has been revoked.
2070
+ * Input for transferring a SIWS account.
2076
2071
  */
2077
- export interface FarcasterSignerRevoked {
2078
- fid: string;
2072
+ export interface TransferSiwsInput {
2073
+ address: string;
2079
2074
 
2080
- public_key: string;
2075
+ nonce: string;
2081
2076
 
2082
- status: 'revoked';
2077
+ connectorType?: string | null;
2078
+
2079
+ walletClientType?: string | null;
2083
2080
  }
2084
2081
 
2085
2082
  /**
2086
- * A Farcaster signer status response when the signer is pending approval.
2083
+ * Input for transferring a Telegram account.
2087
2084
  */
2088
- export interface FarcasterSignerStatusPendingApproval {
2089
- public_key: string;
2085
+ export interface TransferTelegramInput {
2086
+ nonce: string;
2090
2087
 
2091
- status: 'pending_approval';
2092
- }
2088
+ /**
2089
+ * Auth result object returned by Telegram when a user authenticates using the
2090
+ * login widget.
2091
+ */
2092
+ telegram_auth_result?: TelegramAuthResult;
2093
2093
 
2094
- /**
2095
- * Input for verifying SMS MFA.
2096
- */
2097
- export interface MfaSMSInitVerifyInput {
2098
- action: 'verify';
2094
+ /**
2095
+ * Auth result object returned by Telegram when a user authenticates using a mini
2096
+ * app.
2097
+ */
2098
+ telegram_web_app_data?: TelegramWebAppData;
2099
2099
  }
2100
2100
 
2101
2101
  /**
2102
- * Input for enrolling SMS MFA.
2102
+ * Input for unlinking a passkey credential.
2103
2103
  */
2104
- export interface MfaSMSInitEnrollInput {
2105
- action: 'enroll';
2104
+ export interface UnlinkPasskeyInput {
2105
+ credential_id: string;
2106
2106
 
2107
- phoneNumber: string;
2107
+ remove_as_mfa?: boolean;
2108
2108
  }
2109
2109
 
2110
2110
  export declare namespace ClientAuth {
@@ -2168,119 +2168,119 @@ export declare namespace ClientAuth {
2168
2168
  type TelegramAuthenticateRequestBody as TelegramAuthenticateRequestBody,
2169
2169
  type TelegramLinkRequestBody as TelegramLinkRequestBody,
2170
2170
  type TelegramUnlinkRequestBody as TelegramUnlinkRequestBody,
2171
- type ExternalOAuthProviderID as ExternalOAuthProviderID,
2172
- type PrivyOAuthProviderID as PrivyOAuthProviderID,
2173
- type CustomOAuthProviderID as CustomOAuthProviderID,
2174
- type OAuthProviderID as OAuthProviderID,
2175
- type BridgeOnrampProvider as BridgeOnrampProvider,
2176
- type OnrampProvider as OnrampProvider,
2177
- type AuthenticateModeOption as AuthenticateModeOption,
2178
- type AuthenticateMode as AuthenticateMode,
2179
- type PasskeyCredPropsResult as PasskeyCredPropsResult,
2180
- type PasskeyClientExtensionResults as PasskeyClientExtensionResults,
2181
- type PasskeyCredentialDescriptor as PasskeyCredentialDescriptor,
2182
- type PasskeyRelyingParty as PasskeyRelyingParty,
2183
- type PasskeyUser as PasskeyUser,
2184
- type PasskeyPubKeyCredParam as PasskeyPubKeyCredParam,
2185
- type PasskeyAuthenticatorSelection as PasskeyAuthenticatorSelection,
2186
- type PasskeyEnrollmentExtensions as PasskeyEnrollmentExtensions,
2187
- type PasskeyAttestationResponse as PasskeyAttestationResponse,
2188
- type PasskeyAuthenticatorEnrollmentOptions as PasskeyAuthenticatorEnrollmentOptions,
2189
- type PasskeyAuthenticatorEnrollmentResponse as PasskeyAuthenticatorEnrollmentResponse,
2190
- type ResponsePasskeyInitLink as ResponsePasskeyInitLink,
2191
- type ResponsePasskeyInitRegister as ResponsePasskeyInitRegister,
2192
- type PasskeyLinkInput as PasskeyLinkInput,
2193
- type PasskeyRegisterInput as PasskeyRegisterInput,
2194
- type PasskeyInitInput as PasskeyInitInput,
2195
- type UnlinkPasskeyInput as UnlinkPasskeyInput,
2196
- type PasskeyVerifyExtensions as PasskeyVerifyExtensions,
2197
- type PasskeyAssertionResponse as PasskeyAssertionResponse,
2198
- type PasskeyAuthenticatorVerifyOptions as PasskeyAuthenticatorVerifyOptions,
2199
- type PasskeyAuthenticatorVerifyResponse as PasskeyAuthenticatorVerifyResponse,
2200
- type ResponsePasskeyInitAuthenticate as ResponsePasskeyInitAuthenticate,
2201
- type PasskeyAuthenticateInput as PasskeyAuthenticateInput,
2202
- type PasswordlessTransferRequestBody as PasswordlessTransferRequestBody,
2203
- type PasswordlessSMSTransferRequestBody as PasswordlessSMSTransferRequestBody,
2204
2171
  type AuthenticateJwtInput as AuthenticateJwtInput,
2205
- type LinkJwtInput as LinkJwtInput,
2206
- type GetFiatCustomerRequestInput as GetFiatCustomerRequestInput,
2207
- type CreateOrUpdateFiatCustomerRequestInput as CreateOrUpdateFiatCustomerRequestInput,
2208
- type BridgeFiatRejectionReason as BridgeFiatRejectionReason,
2172
+ type AuthenticateMode as AuthenticateMode,
2173
+ type AuthenticateModeOption as AuthenticateModeOption,
2174
+ type AuthenticateSiweInput as AuthenticateSiweInput,
2175
+ type AuthenticateSiwsInput as AuthenticateSiwsInput,
2176
+ type BridgeBrlFiatVirtualAccountDepositInstructions as BridgeBrlFiatVirtualAccountDepositInstructions,
2177
+ type BridgeDestinationAsset as BridgeDestinationAsset,
2178
+ type BridgeEurFiatVirtualAccountDepositInstructions as BridgeEurFiatVirtualAccountDepositInstructions,
2209
2179
  type BridgeFiatCustomerResponse as BridgeFiatCustomerResponse,
2180
+ type BridgeFiatRejectionReason as BridgeFiatRejectionReason,
2181
+ type BridgeFiatVirtualAccountDepositInstructions as BridgeFiatVirtualAccountDepositInstructions,
2182
+ type BridgeFiatVirtualAccountDestination as BridgeFiatVirtualAccountDestination,
2183
+ type BridgeFiatVirtualAccountRequest as BridgeFiatVirtualAccountRequest,
2184
+ type BridgeFiatVirtualAccountResponse as BridgeFiatVirtualAccountResponse,
2185
+ type BridgeFiatVirtualAccountSource as BridgeFiatVirtualAccountSource,
2186
+ type BridgeGbpFiatVirtualAccountDepositInstructions as BridgeGbpFiatVirtualAccountDepositInstructions,
2187
+ type BridgeMxnFiatVirtualAccountDepositInstructions as BridgeMxnFiatVirtualAccountDepositInstructions,
2188
+ type BridgeOnrampProvider as BridgeOnrampProvider,
2210
2189
  type BridgeSandboxFiatCustomerResponse as BridgeSandboxFiatCustomerResponse,
2211
- type FiatCustomerResponse as FiatCustomerResponse,
2212
- type FiatCurrencyCode as FiatCurrencyCode,
2213
- type CryptoCurrencyCode as CryptoCurrencyCode,
2190
+ type BridgeSandboxFiatVirtualAccountRequest as BridgeSandboxFiatVirtualAccountRequest,
2191
+ type BridgeSandboxFiatVirtualAccountResponse as BridgeSandboxFiatVirtualAccountResponse,
2192
+ type BridgeSourceAsset as BridgeSourceAsset,
2193
+ type BridgeUsdFiatVirtualAccountDepositInstructions as BridgeUsdFiatVirtualAccountDepositInstructions,
2214
2194
  type Caip2ChainID as Caip2ChainID,
2195
+ type CreateOrUpdateFiatCustomerRequestInput as CreateOrUpdateFiatCustomerRequestInput,
2196
+ type CryptoCurrencyCode as CryptoCurrencyCode,
2197
+ type CustomOAuthProviderID as CustomOAuthProviderID,
2198
+ type ExternalOAuthProviderID as ExternalOAuthProviderID,
2199
+ type FarcasterAuthenticateInput as FarcasterAuthenticateInput,
2200
+ type FarcasterConnectInitResponse as FarcasterConnectInitResponse,
2201
+ type FarcasterConnectStatusCompletedResponse as FarcasterConnectStatusCompletedResponse,
2202
+ type FarcasterConnectStatusPendingResponse as FarcasterConnectStatusPendingResponse,
2203
+ type FarcasterInitInput as FarcasterInitInput,
2204
+ type FarcasterLinkInput as FarcasterLinkInput,
2205
+ type FarcasterSignerApproved as FarcasterSignerApproved,
2206
+ type FarcasterSignerInitPendingApproval as FarcasterSignerInitPendingApproval,
2207
+ type FarcasterSignerRevoked as FarcasterSignerRevoked,
2208
+ type FarcasterSignerStatusPendingApproval as FarcasterSignerStatusPendingApproval,
2209
+ type FarcasterUnlinkInput as FarcasterUnlinkInput,
2210
+ type FarcasterV2AuthenticateInput as FarcasterV2AuthenticateInput,
2211
+ type FarcasterV2InitInput as FarcasterV2InitInput,
2212
+ type FarcasterV2InitRequestBody as FarcasterV2InitRequestBody,
2213
+ type FarcasterV2InitResponse as FarcasterV2InitResponse,
2215
2214
  type FiatAmount as FiatAmount,
2216
- type FiatOnrampSource as FiatOnrampSource,
2215
+ type FiatCurrencyCode as FiatCurrencyCode,
2216
+ type FiatCustomerResponse as FiatCustomerResponse,
2217
2217
  type FiatOnrampDestination as FiatOnrampDestination,
2218
2218
  type FiatOnrampEnvironment as FiatOnrampEnvironment,
2219
2219
  type FiatOnrampProvider as FiatOnrampProvider,
2220
- type GetFiatOnrampQuotesInput as GetFiatOnrampQuotesInput,
2221
- type FiatOnrampQuote as FiatOnrampQuote,
2222
2220
  type FiatOnrampProviderError as FiatOnrampProviderError,
2223
- type GetFiatOnrampQuotesResponse as GetFiatOnrampQuotesResponse,
2224
- type GetFiatOnrampURLInput as GetFiatOnrampURLInput,
2225
- type GetFiatOnrampURLResponse as GetFiatOnrampURLResponse,
2221
+ type FiatOnrampQuote as FiatOnrampQuote,
2222
+ type FiatOnrampSource as FiatOnrampSource,
2226
2223
  type FiatOnrampTransactionStatus as FiatOnrampTransactionStatus,
2227
- type GetFiatOnrampTransactionStatusInput as GetFiatOnrampTransactionStatusInput,
2228
- type GetFiatOnrampTransactionStatusResponse as GetFiatOnrampTransactionStatusResponse,
2229
- type BridgeDestinationAsset as BridgeDestinationAsset,
2230
- type BridgeSourceAsset as BridgeSourceAsset,
2231
- type BridgeFiatVirtualAccountSource as BridgeFiatVirtualAccountSource,
2232
- type BridgeFiatVirtualAccountDestination as BridgeFiatVirtualAccountDestination,
2233
- type BridgeFiatVirtualAccountRequest as BridgeFiatVirtualAccountRequest,
2234
- type BridgeSandboxFiatVirtualAccountRequest as BridgeSandboxFiatVirtualAccountRequest,
2235
2224
  type FiatVirtualAccountRequest as FiatVirtualAccountRequest,
2236
- type BridgeUsdFiatVirtualAccountDepositInstructions as BridgeUsdFiatVirtualAccountDepositInstructions,
2237
- type BridgeEurFiatVirtualAccountDepositInstructions as BridgeEurFiatVirtualAccountDepositInstructions,
2238
- type BridgeMxnFiatVirtualAccountDepositInstructions as BridgeMxnFiatVirtualAccountDepositInstructions,
2239
- type BridgeBrlFiatVirtualAccountDepositInstructions as BridgeBrlFiatVirtualAccountDepositInstructions,
2240
- type BridgeGbpFiatVirtualAccountDepositInstructions as BridgeGbpFiatVirtualAccountDepositInstructions,
2241
- type BridgeFiatVirtualAccountDepositInstructions as BridgeFiatVirtualAccountDepositInstructions,
2242
- type BridgeFiatVirtualAccountResponse as BridgeFiatVirtualAccountResponse,
2243
- type BridgeSandboxFiatVirtualAccountResponse as BridgeSandboxFiatVirtualAccountResponse,
2244
2225
  type FiatVirtualAccountResponse as FiatVirtualAccountResponse,
2226
+ type GetFiatCustomerRequestInput as GetFiatCustomerRequestInput,
2227
+ type GetFiatOnrampQuotesInput as GetFiatOnrampQuotesInput,
2228
+ type GetFiatOnrampQuotesResponse as GetFiatOnrampQuotesResponse,
2229
+ type GetFiatOnrampTransactionStatusInput as GetFiatOnrampTransactionStatusInput,
2230
+ type GetFiatOnrampTransactionStatusResponse as GetFiatOnrampTransactionStatusResponse,
2231
+ type GetFiatOnrampURLInput as GetFiatOnrampURLInput,
2232
+ type GetFiatOnrampURLResponse as GetFiatOnrampURLResponse,
2233
+ type LinkJwtInput as LinkJwtInput,
2234
+ type MfaSMSInitEnrollInput as MfaSMSInitEnrollInput,
2235
+ type MfaSMSInitVerifyInput as MfaSMSInitVerifyInput,
2245
2236
  type OAuthCodeType as OAuthCodeType,
2246
- type OAuthTransferUserInfoMeta as OAuthTransferUserInfoMeta,
2247
- type OAuthTransferUserInfo as OAuthTransferUserInfo,
2237
+ type OAuthProviderID as OAuthProviderID,
2248
2238
  type OAuthTransferRequestBody as OAuthTransferRequestBody,
2249
- type SiweInput as SiweInput,
2250
- type SmartWalletSiweInput as SmartWalletSiweInput,
2251
- type AuthenticateSiweInput as AuthenticateSiweInput,
2239
+ type OAuthTransferUserInfo as OAuthTransferUserInfo,
2240
+ type OAuthTransferUserInfoMeta as OAuthTransferUserInfoMeta,
2241
+ type OnrampProvider as OnrampProvider,
2242
+ type PasskeyAssertionResponse as PasskeyAssertionResponse,
2243
+ type PasskeyAttestationResponse as PasskeyAttestationResponse,
2244
+ type PasskeyAuthenticateInput as PasskeyAuthenticateInput,
2245
+ type PasskeyAuthenticatorEnrollmentOptions as PasskeyAuthenticatorEnrollmentOptions,
2246
+ type PasskeyAuthenticatorEnrollmentResponse as PasskeyAuthenticatorEnrollmentResponse,
2247
+ type PasskeyAuthenticatorSelection as PasskeyAuthenticatorSelection,
2248
+ type PasskeyAuthenticatorVerifyOptions as PasskeyAuthenticatorVerifyOptions,
2249
+ type PasskeyAuthenticatorVerifyResponse as PasskeyAuthenticatorVerifyResponse,
2250
+ type PasskeyClientExtensionResults as PasskeyClientExtensionResults,
2251
+ type PasskeyCredPropsResult as PasskeyCredPropsResult,
2252
+ type PasskeyCredentialDescriptor as PasskeyCredentialDescriptor,
2253
+ type PasskeyEnrollmentExtensions as PasskeyEnrollmentExtensions,
2254
+ type PasskeyInitInput as PasskeyInitInput,
2255
+ type PasskeyLinkInput as PasskeyLinkInput,
2256
+ type PasskeyPubKeyCredParam as PasskeyPubKeyCredParam,
2257
+ type PasskeyRegisterInput as PasskeyRegisterInput,
2258
+ type PasskeyRelyingParty as PasskeyRelyingParty,
2259
+ type PasskeyUser as PasskeyUser,
2260
+ type PasskeyVerifyExtensions as PasskeyVerifyExtensions,
2261
+ type PasswordlessSMSTransferRequestBody as PasswordlessSMSTransferRequestBody,
2262
+ type PasswordlessTransferRequestBody as PasswordlessTransferRequestBody,
2263
+ type PrivyOAuthProviderID as PrivyOAuthProviderID,
2264
+ type ResponsePasskeyInitAuthenticate as ResponsePasskeyInitAuthenticate,
2265
+ type ResponsePasskeyInitLink as ResponsePasskeyInitLink,
2266
+ type ResponsePasskeyInitRegister as ResponsePasskeyInitRegister,
2252
2267
  type SiweAddressInput as SiweAddressInput,
2253
2268
  type SiweInitInput as SiweInitInput,
2269
+ type SiweInput as SiweInput,
2254
2270
  type SiweNonce as SiweNonce,
2255
- type TransferSiweInput as TransferSiweInput,
2256
- type SiwsInput as SiwsInput,
2257
- type AuthenticateSiwsInput as AuthenticateSiwsInput,
2258
2271
  type SiwsAddressInput as SiwsAddressInput,
2259
2272
  type SiwsInitInput as SiwsInitInput,
2273
+ type SiwsInput as SiwsInput,
2260
2274
  type SiwsNonce as SiwsNonce,
2261
- type TransferSiwsInput as TransferSiwsInput,
2275
+ type SmartWalletSiweInput as SmartWalletSiweInput,
2262
2276
  type TelegramAuthResult as TelegramAuthResult,
2263
- type TelegramWebAppData as TelegramWebAppData,
2264
2277
  type TelegramAuthenticateInput as TelegramAuthenticateInput,
2265
2278
  type TelegramUnlinkInput as TelegramUnlinkInput,
2266
- type TransferTelegramInput as TransferTelegramInput,
2267
- type FarcasterConnectInitResponse as FarcasterConnectInitResponse,
2268
- type FarcasterConnectStatusCompletedResponse as FarcasterConnectStatusCompletedResponse,
2269
- type FarcasterConnectStatusPendingResponse as FarcasterConnectStatusPendingResponse,
2270
- type FarcasterAuthenticateInput as FarcasterAuthenticateInput,
2271
- type FarcasterLinkInput as FarcasterLinkInput,
2272
- type FarcasterInitInput as FarcasterInitInput,
2273
- type FarcasterUnlinkInput as FarcasterUnlinkInput,
2279
+ type TelegramWebAppData as TelegramWebAppData,
2274
2280
  type TransferFarcasterInput as TransferFarcasterInput,
2275
- type FarcasterV2InitInput as FarcasterV2InitInput,
2276
- type FarcasterV2InitResponse as FarcasterV2InitResponse,
2277
- type FarcasterV2AuthenticateInput as FarcasterV2AuthenticateInput,
2278
- type FarcasterV2InitRequestBody as FarcasterV2InitRequestBody,
2279
- type FarcasterSignerInitPendingApproval as FarcasterSignerInitPendingApproval,
2280
- type FarcasterSignerApproved as FarcasterSignerApproved,
2281
- type FarcasterSignerRevoked as FarcasterSignerRevoked,
2282
- type FarcasterSignerStatusPendingApproval as FarcasterSignerStatusPendingApproval,
2283
- type MfaSMSInitVerifyInput as MfaSMSInitVerifyInput,
2284
- type MfaSMSInitEnrollInput as MfaSMSInitEnrollInput,
2281
+ type TransferSiweInput as TransferSiweInput,
2282
+ type TransferSiwsInput as TransferSiwsInput,
2283
+ type TransferTelegramInput as TransferTelegramInput,
2284
+ type UnlinkPasskeyInput as UnlinkPasskeyInput,
2285
2285
  };
2286
2286
  }