@privy-io/api-types 0.13.0 → 0.14.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.
@@ -5,6 +5,102 @@ import * as KrakenEmbedAPI from './kraken-embed';
5
5
 
6
6
  export class KrakenEmbed extends APIResource {}
7
7
 
8
+ /**
9
+ * Request body for cancelling a custom order.
10
+ */
11
+ export interface KrakenEmbedCancelCustomOrderInput {
12
+ user_id: string;
13
+ }
14
+
15
+ /**
16
+ * Path parameters for cancelling a custom order.
17
+ */
18
+ export interface KrakenEmbedCancelCustomOrderPath {
19
+ order_id: string;
20
+ }
21
+
22
+ /**
23
+ * Response body for cancelling a custom order.
24
+ */
25
+ export interface KrakenEmbedCancelCustomOrderResponse {
26
+ /**
27
+ * Result payload for cancel custom order response.
28
+ */
29
+ result: KrakenEmbedCancelCustomOrderResponse.Result;
30
+
31
+ error?: Array<unknown>;
32
+
33
+ errors?: Array<unknown>;
34
+ }
35
+
36
+ export namespace KrakenEmbedCancelCustomOrderResponse {
37
+ /**
38
+ * Result payload for cancel custom order response.
39
+ */
40
+ export interface Result extends KrakenEmbedAPI.KrakenEmbedCancelCustomOrderResult {}
41
+ }
42
+
43
+ /**
44
+ * Result payload for cancel custom order response.
45
+ */
46
+ export interface KrakenEmbedCancelCustomOrderResult {
47
+ /**
48
+ * Full custom order object.
49
+ */
50
+ order: KrakenEmbedCustomOrder;
51
+ }
52
+
53
+ /**
54
+ * Request body for creating a custom order.
55
+ */
56
+ export interface KrakenEmbedCreateCustomOrderInput {
57
+ /**
58
+ * Trade action for a custom order.
59
+ */
60
+ action: KrakenEmbedCustomOrderAction;
61
+
62
+ name: string;
63
+
64
+ /**
65
+ * Price trigger for a custom order. The order executes when base_asset/quote_asset
66
+ * rate meets the condition against target_price.
67
+ */
68
+ trigger: KrakenEmbedCustomOrderTrigger;
69
+
70
+ user_id: string;
71
+ }
72
+
73
+ /**
74
+ * Response body for creating a custom order.
75
+ */
76
+ export interface KrakenEmbedCreateCustomOrderResponse {
77
+ /**
78
+ * Result payload for create custom order response.
79
+ */
80
+ result: KrakenEmbedCreateCustomOrderResponse.Result;
81
+
82
+ error?: Array<unknown>;
83
+
84
+ errors?: Array<unknown>;
85
+ }
86
+
87
+ export namespace KrakenEmbedCreateCustomOrderResponse {
88
+ /**
89
+ * Result payload for create custom order response.
90
+ */
91
+ export interface Result extends KrakenEmbedAPI.KrakenEmbedCreateCustomOrderResult {}
92
+ }
93
+
94
+ /**
95
+ * Result payload for create custom order response.
96
+ */
97
+ export interface KrakenEmbedCreateCustomOrderResult {
98
+ /**
99
+ * Full custom order object.
100
+ */
101
+ order: KrakenEmbedCustomOrder;
102
+ }
103
+
8
104
  /**
9
105
  * Current day profit and loss for a portfolio, calculated from the most recent
10
106
  * available balance.
@@ -15,6 +111,147 @@ export interface KrakenEmbedCurrentDayPnl {
15
111
  since: string;
16
112
  }
17
113
 
114
+ /**
115
+ * Full custom order object.
116
+ */
117
+ export interface KrakenEmbedCustomOrder {
118
+ id: string;
119
+
120
+ /**
121
+ * Trade action for a custom order.
122
+ */
123
+ action: KrakenEmbedCustomOrderAction;
124
+
125
+ created_at: string;
126
+
127
+ name: string;
128
+
129
+ /**
130
+ * Custom order status with optional reason for cancelled or paused states.
131
+ */
132
+ status: KrakenEmbedCustomOrderStatus;
133
+
134
+ /**
135
+ * Price trigger for a custom order. The order executes when base_asset/quote_asset
136
+ * rate meets the condition against target_price.
137
+ */
138
+ trigger: KrakenEmbedCustomOrderTrigger;
139
+
140
+ updated_at: string;
141
+ }
142
+
143
+ /**
144
+ * Trade action for a custom order.
145
+ */
146
+ export interface KrakenEmbedCustomOrderAction {
147
+ /**
148
+ * Asset amount for custom order actions.
149
+ */
150
+ amount: KrakenEmbedCustomOrderAmount;
151
+
152
+ fee_bps: string;
153
+
154
+ /**
155
+ * Target asset for the other side of the custom order trade.
156
+ */
157
+ quote: KrakenEmbedCustomOrderQuoteAsset;
158
+
159
+ spread_bps: string;
160
+
161
+ type: 'receive' | 'spend';
162
+ }
163
+
164
+ /**
165
+ * Asset amount for custom order actions.
166
+ */
167
+ export interface KrakenEmbedCustomOrderAmount {
168
+ amount: string;
169
+
170
+ asset: string;
171
+
172
+ asset_class?: 'currency';
173
+ }
174
+
175
+ /**
176
+ * A single execution occurrence of a custom order.
177
+ */
178
+ export interface KrakenEmbedCustomOrderOccurrence {
179
+ id: string;
180
+
181
+ created_at: string;
182
+
183
+ status: 'success' | 'failure' | 'skipped';
184
+
185
+ /**
186
+ * Trigger metadata for a custom order occurrence.
187
+ */
188
+ trigger: KrakenEmbedCustomOrderOccurrenceTrigger;
189
+
190
+ updated_at: string;
191
+
192
+ /**
193
+ * Executed action details for a custom order occurrence.
194
+ */
195
+ executed_action?: KrakenEmbedCustomOrderOccurrence.ExecutedAction;
196
+
197
+ failure_reason?: string;
198
+
199
+ skip_reason?: string;
200
+ }
201
+
202
+ export namespace KrakenEmbedCustomOrderOccurrence {
203
+ /**
204
+ * Executed action details for a custom order occurrence.
205
+ */
206
+ export interface ExecutedAction extends KrakenEmbedAPI.KrakenEmbedCustomOrderOccurrenceExecutedAction {}
207
+ }
208
+
209
+ /**
210
+ * Executed action details for a custom order occurrence.
211
+ */
212
+ export interface KrakenEmbedCustomOrderOccurrenceExecutedAction {
213
+ quote_id: string;
214
+ }
215
+
216
+ /**
217
+ * Trigger metadata for a custom order occurrence.
218
+ */
219
+ export interface KrakenEmbedCustomOrderOccurrenceTrigger {
220
+ type: 'time' | 'price' | 'crypto_deposit' | 'market_open';
221
+ }
222
+
223
+ /**
224
+ * Target asset for the other side of the custom order trade.
225
+ */
226
+ export interface KrakenEmbedCustomOrderQuoteAsset {
227
+ asset: string;
228
+ }
229
+
230
+ /**
231
+ * Custom order status with optional reason for cancelled or paused states.
232
+ */
233
+ export interface KrakenEmbedCustomOrderStatus {
234
+ status: 'active' | 'completed' | 'cancelled' | 'paused';
235
+
236
+ reason?: unknown;
237
+ }
238
+
239
+ /**
240
+ * Price trigger for a custom order. The order executes when base_asset/quote_asset
241
+ * rate meets the condition against target_price.
242
+ */
243
+ export interface KrakenEmbedCustomOrderTrigger {
244
+ base_asset: string;
245
+
246
+ condition: 'gte' | 'lte';
247
+
248
+ quote_asset: string;
249
+
250
+ target_price: string;
251
+
252
+ type: 'price';
253
+ }
254
+
18
255
  /**
19
256
  * Query parameters for listing and filtering available assets.
20
257
  */
@@ -64,6 +301,83 @@ export interface KrakenEmbedGetAssetListQueryParamsSchema {
64
301
  | '-listing_date';
65
302
  }
66
303
 
304
+ /**
305
+ * Query parameters for getting custom order history.
306
+ */
307
+ export interface KrakenEmbedGetCustomOrderHistoryQueryParams {
308
+ order_id: string;
309
+
310
+ user_id: string;
311
+ }
312
+
313
+ /**
314
+ * Response body for getting custom order execution history.
315
+ */
316
+ export interface KrakenEmbedGetCustomOrderHistoryResponse {
317
+ /**
318
+ * Result payload for custom order history response.
319
+ */
320
+ result: KrakenEmbedGetCustomOrderHistoryResponse.Result;
321
+
322
+ error?: Array<unknown>;
323
+
324
+ errors?: Array<unknown>;
325
+ }
326
+
327
+ export namespace KrakenEmbedGetCustomOrderHistoryResponse {
328
+ /**
329
+ * Result payload for custom order history response.
330
+ */
331
+ export interface Result extends KrakenEmbedAPI.KrakenEmbedGetCustomOrderHistoryResult {}
332
+ }
333
+
334
+ /**
335
+ * Result payload for custom order history response.
336
+ */
337
+ export interface KrakenEmbedGetCustomOrderHistoryResult {
338
+ history: Array<KrakenEmbedCustomOrderOccurrence>;
339
+ }
340
+
341
+ /**
342
+ * Query parameters for getting a single custom order.
343
+ */
344
+ export interface KrakenEmbedGetCustomOrderQueryParams {
345
+ order_id: string;
346
+
347
+ user_id: string;
348
+ }
349
+
350
+ /**
351
+ * Response body for getting a single custom order.
352
+ */
353
+ export interface KrakenEmbedGetCustomOrderResponse {
354
+ /**
355
+ * Result payload for get custom order response.
356
+ */
357
+ result: KrakenEmbedGetCustomOrderResponse.Result;
358
+
359
+ error?: Array<unknown>;
360
+
361
+ errors?: Array<unknown>;
362
+ }
363
+
364
+ export namespace KrakenEmbedGetCustomOrderResponse {
365
+ /**
366
+ * Result payload for get custom order response.
367
+ */
368
+ export interface Result extends KrakenEmbedAPI.KrakenEmbedGetCustomOrderResult {}
369
+ }
370
+
371
+ /**
372
+ * Result payload for get custom order response.
373
+ */
374
+ export interface KrakenEmbedGetCustomOrderResult {
375
+ /**
376
+ * Full custom order object.
377
+ */
378
+ order: KrakenEmbedCustomOrder;
379
+ }
380
+
67
381
  /**
68
382
  * Query parameters for portfolio details endpoint.
69
383
  */
@@ -169,14 +483,1106 @@ export interface KrakenEmbedGetQuoteQueryParams {
169
483
  user_id: string;
170
484
  }
171
485
 
486
+ /**
487
+ * Query parameters for listing custom orders.
488
+ */
489
+ export interface KrakenEmbedListCustomOrdersQueryParams {
490
+ user_id: string;
491
+
492
+ cursor?: string;
493
+
494
+ statuses?: Array<'active' | 'paused' | 'cancelled' | 'completed'> | string;
495
+ }
496
+
497
+ /**
498
+ * Response body for listing custom orders.
499
+ */
500
+ export interface KrakenEmbedListCustomOrdersResponse {
501
+ /**
502
+ * Result payload for list custom orders response.
503
+ */
504
+ result: KrakenEmbedListCustomOrdersResponse.Result;
505
+
506
+ error?: Array<unknown>;
507
+
508
+ errors?: Array<unknown>;
509
+ }
510
+
511
+ export namespace KrakenEmbedListCustomOrdersResponse {
512
+ /**
513
+ * Result payload for list custom orders response.
514
+ */
515
+ export interface Result extends KrakenEmbedAPI.KrakenEmbedListCustomOrdersResult {}
516
+ }
517
+
518
+ /**
519
+ * Result payload for list custom orders response.
520
+ */
521
+ export interface KrakenEmbedListCustomOrdersResult {
522
+ orders: Array<KrakenEmbedCustomOrder>;
523
+ }
524
+
525
+ /**
526
+ * Optional best-effort metadata hints for proof of address verification.
527
+ */
528
+ export interface KrakenEmbedStartAddressMetadata {
529
+ address?: KrakenEmbedStartAddressMetadata.Address | null;
530
+
531
+ document_number?: string | null;
532
+
533
+ document_type?:
534
+ | 'bank_statement'
535
+ | 'credit_card_statement'
536
+ | 'employer_letter_or_work_contract'
537
+ | 'government_issued_document'
538
+ | 'home_or_rental_insurance'
539
+ | 'internet_or_cable_bill'
540
+ | 'mobile_phone_bill'
541
+ | 'mortgage_statement'
542
+ | 'official_government_letter'
543
+ | 'passport_address_page'
544
+ | 'rental_or_lease_agreement'
545
+ | 'residence_certificate'
546
+ | 'social_insurance_payment_receipt'
547
+ | 'tax_receipt'
548
+ | 'tax_return'
549
+ | 'utility_bill'
550
+ | 'other'
551
+ | null;
552
+
553
+ expiration_date?: string | null;
554
+ }
555
+
556
+ export namespace KrakenEmbedStartAddressMetadata {
557
+ export interface Address {
558
+ city: string;
559
+
560
+ country:
561
+ | 'AD'
562
+ | 'AE'
563
+ | 'AF'
564
+ | 'AG'
565
+ | 'AI'
566
+ | 'AL'
567
+ | 'AM'
568
+ | 'AO'
569
+ | 'AQ'
570
+ | 'AR'
571
+ | 'AS'
572
+ | 'AT'
573
+ | 'AU'
574
+ | 'AW'
575
+ | 'AX'
576
+ | 'AZ'
577
+ | 'BA'
578
+ | 'BB'
579
+ | 'BD'
580
+ | 'BE'
581
+ | 'BF'
582
+ | 'BG'
583
+ | 'BH'
584
+ | 'BI'
585
+ | 'BJ'
586
+ | 'BL'
587
+ | 'BM'
588
+ | 'BN'
589
+ | 'BO'
590
+ | 'BQ'
591
+ | 'BR'
592
+ | 'BS'
593
+ | 'BT'
594
+ | 'BV'
595
+ | 'BW'
596
+ | 'BY'
597
+ | 'BZ'
598
+ | 'CA'
599
+ | 'CC'
600
+ | 'CD'
601
+ | 'CF'
602
+ | 'CG'
603
+ | 'CH'
604
+ | 'CI'
605
+ | 'CK'
606
+ | 'CL'
607
+ | 'CM'
608
+ | 'CN'
609
+ | 'CO'
610
+ | 'CR'
611
+ | 'CU'
612
+ | 'CV'
613
+ | 'CW'
614
+ | 'CX'
615
+ | 'CY'
616
+ | 'CZ'
617
+ | 'DE'
618
+ | 'DJ'
619
+ | 'DK'
620
+ | 'DM'
621
+ | 'DO'
622
+ | 'DZ'
623
+ | 'EC'
624
+ | 'EE'
625
+ | 'EG'
626
+ | 'EH'
627
+ | 'ER'
628
+ | 'ES'
629
+ | 'ET'
630
+ | 'FI'
631
+ | 'FJ'
632
+ | 'FK'
633
+ | 'FM'
634
+ | 'FO'
635
+ | 'FR'
636
+ | 'GA'
637
+ | 'GB'
638
+ | 'GD'
639
+ | 'GE'
640
+ | 'GF'
641
+ | 'GG'
642
+ | 'GH'
643
+ | 'GI'
644
+ | 'GL'
645
+ | 'GM'
646
+ | 'GN'
647
+ | 'GP'
648
+ | 'GQ'
649
+ | 'GR'
650
+ | 'GS'
651
+ | 'GT'
652
+ | 'GU'
653
+ | 'GW'
654
+ | 'GY'
655
+ | 'HK'
656
+ | 'HM'
657
+ | 'HN'
658
+ | 'HR'
659
+ | 'HT'
660
+ | 'HU'
661
+ | 'ID'
662
+ | 'IE'
663
+ | 'IL'
664
+ | 'IM'
665
+ | 'IN'
666
+ | 'IO'
667
+ | 'IQ'
668
+ | 'IR'
669
+ | 'IS'
670
+ | 'IT'
671
+ | 'JE'
672
+ | 'JM'
673
+ | 'JO'
674
+ | 'JP'
675
+ | 'KE'
676
+ | 'KG'
677
+ | 'KH'
678
+ | 'KI'
679
+ | 'KM'
680
+ | 'KN'
681
+ | 'KP'
682
+ | 'KR'
683
+ | 'KW'
684
+ | 'KY'
685
+ | 'KZ'
686
+ | 'LA'
687
+ | 'LB'
688
+ | 'LC'
689
+ | 'LI'
690
+ | 'LK'
691
+ | 'LR'
692
+ | 'LS'
693
+ | 'LT'
694
+ | 'LU'
695
+ | 'LV'
696
+ | 'LY'
697
+ | 'MA'
698
+ | 'MC'
699
+ | 'MD'
700
+ | 'ME'
701
+ | 'MF'
702
+ | 'MG'
703
+ | 'MH'
704
+ | 'MK'
705
+ | 'ML'
706
+ | 'MM'
707
+ | 'MN'
708
+ | 'MO'
709
+ | 'MP'
710
+ | 'MQ'
711
+ | 'MR'
712
+ | 'MS'
713
+ | 'MT'
714
+ | 'MU'
715
+ | 'MV'
716
+ | 'MW'
717
+ | 'MX'
718
+ | 'MY'
719
+ | 'MZ'
720
+ | 'NA'
721
+ | 'NC'
722
+ | 'NE'
723
+ | 'NF'
724
+ | 'NG'
725
+ | 'NI'
726
+ | 'NL'
727
+ | 'NO'
728
+ | 'NP'
729
+ | 'NR'
730
+ | 'NU'
731
+ | 'NZ'
732
+ | 'OM'
733
+ | 'PA'
734
+ | 'PE'
735
+ | 'PF'
736
+ | 'PG'
737
+ | 'PH'
738
+ | 'PK'
739
+ | 'PL'
740
+ | 'PM'
741
+ | 'PN'
742
+ | 'PR'
743
+ | 'PS'
744
+ | 'PT'
745
+ | 'PW'
746
+ | 'PY'
747
+ | 'QA'
748
+ | 'RE'
749
+ | 'RO'
750
+ | 'RS'
751
+ | 'RU'
752
+ | 'RW'
753
+ | 'SA'
754
+ | 'SB'
755
+ | 'SC'
756
+ | 'SD'
757
+ | 'SE'
758
+ | 'SG'
759
+ | 'SH'
760
+ | 'SI'
761
+ | 'SJ'
762
+ | 'SK'
763
+ | 'SL'
764
+ | 'SM'
765
+ | 'SN'
766
+ | 'SO'
767
+ | 'SR'
768
+ | 'SS'
769
+ | 'ST'
770
+ | 'SV'
771
+ | 'SX'
772
+ | 'SY'
773
+ | 'SZ'
774
+ | 'TC'
775
+ | 'TD'
776
+ | 'TF'
777
+ | 'TG'
778
+ | 'TH'
779
+ | 'TJ'
780
+ | 'TK'
781
+ | 'TL'
782
+ | 'TM'
783
+ | 'TN'
784
+ | 'TO'
785
+ | 'TR'
786
+ | 'TT'
787
+ | 'TV'
788
+ | 'TW'
789
+ | 'TZ'
790
+ | 'UA'
791
+ | 'UG'
792
+ | 'UM'
793
+ | 'US'
794
+ | 'UY'
795
+ | 'UZ'
796
+ | 'VA'
797
+ | 'VC'
798
+ | 'VE'
799
+ | 'VG'
800
+ | 'VI'
801
+ | 'VN'
802
+ | 'VU'
803
+ | 'WF'
804
+ | 'WS'
805
+ | 'YE'
806
+ | 'YT'
807
+ | 'ZA'
808
+ | 'ZM'
809
+ | 'ZW'
810
+ | 'AC'
811
+ | 'AN'
812
+ | 'AP'
813
+ | 'CP'
814
+ | 'DG'
815
+ | 'EA'
816
+ | 'EU'
817
+ | 'IC'
818
+ | 'JX'
819
+ | 'TA'
820
+ | 'QO'
821
+ | 'XK'
822
+ | '0C';
823
+
824
+ line1: string;
825
+
826
+ postal_code: string;
827
+
828
+ line2?: string | null;
829
+
830
+ province?: string | null;
831
+ }
832
+ }
833
+
834
+ /**
835
+ * Input payload for starting proof of address verification via URL.
836
+ */
837
+ export interface KrakenEmbedStartAddressVerificationURLInput {
838
+ document_url: string;
839
+
840
+ type: 'proof_of_address';
841
+
842
+ /**
843
+ * Debug options for start verification. Only works in non-production environments.
844
+ */
845
+ debug?: KrakenEmbedStartAddressVerificationURLInput.Debug;
846
+
847
+ /**
848
+ * Optional best-effort metadata hints for proof of address verification.
849
+ */
850
+ metadata?: KrakenEmbedStartAddressVerificationURLInput.Metadata;
851
+ }
852
+
853
+ export namespace KrakenEmbedStartAddressVerificationURLInput {
854
+ /**
855
+ * Debug options for start verification. Only works in non-production environments.
856
+ */
857
+ export interface Debug extends KrakenEmbedAPI.KrakenEmbedStartVerificationDebug {}
858
+
859
+ /**
860
+ * Optional best-effort metadata hints for proof of address verification.
861
+ */
862
+ export interface Metadata extends KrakenEmbedAPI.KrakenEmbedStartAddressMetadata {}
863
+ }
864
+
865
+ /**
866
+ * Identity information hints including full name and date of birth for proof of
867
+ * identity verification.
868
+ */
869
+ export interface KrakenEmbedStartIdentityInfo {
870
+ date_of_birth?: string | null;
871
+
872
+ full_name?: KrakenEmbedStartIdentityInfo.FullName | null;
873
+ }
874
+
875
+ export namespace KrakenEmbedStartIdentityInfo {
876
+ export interface FullName {
877
+ first_name: string;
878
+
879
+ last_name: string;
880
+
881
+ middle_name?: string | null;
882
+ }
883
+ }
884
+
885
+ /**
886
+ * Optional best-effort metadata hints for proof of identity verification.
887
+ */
888
+ export interface KrakenEmbedStartIdentityMetadata {
889
+ document_number?: string | null;
890
+
891
+ document_type?:
892
+ | 'passport'
893
+ | 'drivers_license'
894
+ | 'id_card'
895
+ | 'residence_card'
896
+ | 'special_permanent_residence_card'
897
+ | null;
898
+
899
+ expiration_date?: string | null;
900
+
901
+ /**
902
+ * Identity information hints including full name and date of birth for proof of
903
+ * identity verification.
904
+ */
905
+ identity?: KrakenEmbedStartIdentityMetadata.Identity;
906
+
907
+ issuing_country?:
908
+ | 'AD'
909
+ | 'AE'
910
+ | 'AF'
911
+ | 'AG'
912
+ | 'AI'
913
+ | 'AL'
914
+ | 'AM'
915
+ | 'AO'
916
+ | 'AQ'
917
+ | 'AR'
918
+ | 'AS'
919
+ | 'AT'
920
+ | 'AU'
921
+ | 'AW'
922
+ | 'AX'
923
+ | 'AZ'
924
+ | 'BA'
925
+ | 'BB'
926
+ | 'BD'
927
+ | 'BE'
928
+ | 'BF'
929
+ | 'BG'
930
+ | 'BH'
931
+ | 'BI'
932
+ | 'BJ'
933
+ | 'BL'
934
+ | 'BM'
935
+ | 'BN'
936
+ | 'BO'
937
+ | 'BQ'
938
+ | 'BR'
939
+ | 'BS'
940
+ | 'BT'
941
+ | 'BV'
942
+ | 'BW'
943
+ | 'BY'
944
+ | 'BZ'
945
+ | 'CA'
946
+ | 'CC'
947
+ | 'CD'
948
+ | 'CF'
949
+ | 'CG'
950
+ | 'CH'
951
+ | 'CI'
952
+ | 'CK'
953
+ | 'CL'
954
+ | 'CM'
955
+ | 'CN'
956
+ | 'CO'
957
+ | 'CR'
958
+ | 'CU'
959
+ | 'CV'
960
+ | 'CW'
961
+ | 'CX'
962
+ | 'CY'
963
+ | 'CZ'
964
+ | 'DE'
965
+ | 'DJ'
966
+ | 'DK'
967
+ | 'DM'
968
+ | 'DO'
969
+ | 'DZ'
970
+ | 'EC'
971
+ | 'EE'
972
+ | 'EG'
973
+ | 'EH'
974
+ | 'ER'
975
+ | 'ES'
976
+ | 'ET'
977
+ | 'FI'
978
+ | 'FJ'
979
+ | 'FK'
980
+ | 'FM'
981
+ | 'FO'
982
+ | 'FR'
983
+ | 'GA'
984
+ | 'GB'
985
+ | 'GD'
986
+ | 'GE'
987
+ | 'GF'
988
+ | 'GG'
989
+ | 'GH'
990
+ | 'GI'
991
+ | 'GL'
992
+ | 'GM'
993
+ | 'GN'
994
+ | 'GP'
995
+ | 'GQ'
996
+ | 'GR'
997
+ | 'GS'
998
+ | 'GT'
999
+ | 'GU'
1000
+ | 'GW'
1001
+ | 'GY'
1002
+ | 'HK'
1003
+ | 'HM'
1004
+ | 'HN'
1005
+ | 'HR'
1006
+ | 'HT'
1007
+ | 'HU'
1008
+ | 'ID'
1009
+ | 'IE'
1010
+ | 'IL'
1011
+ | 'IM'
1012
+ | 'IN'
1013
+ | 'IO'
1014
+ | 'IQ'
1015
+ | 'IR'
1016
+ | 'IS'
1017
+ | 'IT'
1018
+ | 'JE'
1019
+ | 'JM'
1020
+ | 'JO'
1021
+ | 'JP'
1022
+ | 'KE'
1023
+ | 'KG'
1024
+ | 'KH'
1025
+ | 'KI'
1026
+ | 'KM'
1027
+ | 'KN'
1028
+ | 'KP'
1029
+ | 'KR'
1030
+ | 'KW'
1031
+ | 'KY'
1032
+ | 'KZ'
1033
+ | 'LA'
1034
+ | 'LB'
1035
+ | 'LC'
1036
+ | 'LI'
1037
+ | 'LK'
1038
+ | 'LR'
1039
+ | 'LS'
1040
+ | 'LT'
1041
+ | 'LU'
1042
+ | 'LV'
1043
+ | 'LY'
1044
+ | 'MA'
1045
+ | 'MC'
1046
+ | 'MD'
1047
+ | 'ME'
1048
+ | 'MF'
1049
+ | 'MG'
1050
+ | 'MH'
1051
+ | 'MK'
1052
+ | 'ML'
1053
+ | 'MM'
1054
+ | 'MN'
1055
+ | 'MO'
1056
+ | 'MP'
1057
+ | 'MQ'
1058
+ | 'MR'
1059
+ | 'MS'
1060
+ | 'MT'
1061
+ | 'MU'
1062
+ | 'MV'
1063
+ | 'MW'
1064
+ | 'MX'
1065
+ | 'MY'
1066
+ | 'MZ'
1067
+ | 'NA'
1068
+ | 'NC'
1069
+ | 'NE'
1070
+ | 'NF'
1071
+ | 'NG'
1072
+ | 'NI'
1073
+ | 'NL'
1074
+ | 'NO'
1075
+ | 'NP'
1076
+ | 'NR'
1077
+ | 'NU'
1078
+ | 'NZ'
1079
+ | 'OM'
1080
+ | 'PA'
1081
+ | 'PE'
1082
+ | 'PF'
1083
+ | 'PG'
1084
+ | 'PH'
1085
+ | 'PK'
1086
+ | 'PL'
1087
+ | 'PM'
1088
+ | 'PN'
1089
+ | 'PR'
1090
+ | 'PS'
1091
+ | 'PT'
1092
+ | 'PW'
1093
+ | 'PY'
1094
+ | 'QA'
1095
+ | 'RE'
1096
+ | 'RO'
1097
+ | 'RS'
1098
+ | 'RU'
1099
+ | 'RW'
1100
+ | 'SA'
1101
+ | 'SB'
1102
+ | 'SC'
1103
+ | 'SD'
1104
+ | 'SE'
1105
+ | 'SG'
1106
+ | 'SH'
1107
+ | 'SI'
1108
+ | 'SJ'
1109
+ | 'SK'
1110
+ | 'SL'
1111
+ | 'SM'
1112
+ | 'SN'
1113
+ | 'SO'
1114
+ | 'SR'
1115
+ | 'SS'
1116
+ | 'ST'
1117
+ | 'SV'
1118
+ | 'SX'
1119
+ | 'SY'
1120
+ | 'SZ'
1121
+ | 'TC'
1122
+ | 'TD'
1123
+ | 'TF'
1124
+ | 'TG'
1125
+ | 'TH'
1126
+ | 'TJ'
1127
+ | 'TK'
1128
+ | 'TL'
1129
+ | 'TM'
1130
+ | 'TN'
1131
+ | 'TO'
1132
+ | 'TR'
1133
+ | 'TT'
1134
+ | 'TV'
1135
+ | 'TW'
1136
+ | 'TZ'
1137
+ | 'UA'
1138
+ | 'UG'
1139
+ | 'UM'
1140
+ | 'US'
1141
+ | 'UY'
1142
+ | 'UZ'
1143
+ | 'VA'
1144
+ | 'VC'
1145
+ | 'VE'
1146
+ | 'VG'
1147
+ | 'VI'
1148
+ | 'VN'
1149
+ | 'VU'
1150
+ | 'WF'
1151
+ | 'WS'
1152
+ | 'YE'
1153
+ | 'YT'
1154
+ | 'ZA'
1155
+ | 'ZM'
1156
+ | 'ZW'
1157
+ | 'AC'
1158
+ | 'AN'
1159
+ | 'AP'
1160
+ | 'CP'
1161
+ | 'DG'
1162
+ | 'EA'
1163
+ | 'EU'
1164
+ | 'IC'
1165
+ | 'JX'
1166
+ | 'TA'
1167
+ | 'QO'
1168
+ | 'XK'
1169
+ | '0C'
1170
+ | null;
1171
+
1172
+ nationality?:
1173
+ | 'AD'
1174
+ | 'AE'
1175
+ | 'AF'
1176
+ | 'AG'
1177
+ | 'AI'
1178
+ | 'AL'
1179
+ | 'AM'
1180
+ | 'AO'
1181
+ | 'AQ'
1182
+ | 'AR'
1183
+ | 'AS'
1184
+ | 'AT'
1185
+ | 'AU'
1186
+ | 'AW'
1187
+ | 'AX'
1188
+ | 'AZ'
1189
+ | 'BA'
1190
+ | 'BB'
1191
+ | 'BD'
1192
+ | 'BE'
1193
+ | 'BF'
1194
+ | 'BG'
1195
+ | 'BH'
1196
+ | 'BI'
1197
+ | 'BJ'
1198
+ | 'BL'
1199
+ | 'BM'
1200
+ | 'BN'
1201
+ | 'BO'
1202
+ | 'BQ'
1203
+ | 'BR'
1204
+ | 'BS'
1205
+ | 'BT'
1206
+ | 'BV'
1207
+ | 'BW'
1208
+ | 'BY'
1209
+ | 'BZ'
1210
+ | 'CA'
1211
+ | 'CC'
1212
+ | 'CD'
1213
+ | 'CF'
1214
+ | 'CG'
1215
+ | 'CH'
1216
+ | 'CI'
1217
+ | 'CK'
1218
+ | 'CL'
1219
+ | 'CM'
1220
+ | 'CN'
1221
+ | 'CO'
1222
+ | 'CR'
1223
+ | 'CU'
1224
+ | 'CV'
1225
+ | 'CW'
1226
+ | 'CX'
1227
+ | 'CY'
1228
+ | 'CZ'
1229
+ | 'DE'
1230
+ | 'DJ'
1231
+ | 'DK'
1232
+ | 'DM'
1233
+ | 'DO'
1234
+ | 'DZ'
1235
+ | 'EC'
1236
+ | 'EE'
1237
+ | 'EG'
1238
+ | 'EH'
1239
+ | 'ER'
1240
+ | 'ES'
1241
+ | 'ET'
1242
+ | 'FI'
1243
+ | 'FJ'
1244
+ | 'FK'
1245
+ | 'FM'
1246
+ | 'FO'
1247
+ | 'FR'
1248
+ | 'GA'
1249
+ | 'GB'
1250
+ | 'GD'
1251
+ | 'GE'
1252
+ | 'GF'
1253
+ | 'GG'
1254
+ | 'GH'
1255
+ | 'GI'
1256
+ | 'GL'
1257
+ | 'GM'
1258
+ | 'GN'
1259
+ | 'GP'
1260
+ | 'GQ'
1261
+ | 'GR'
1262
+ | 'GS'
1263
+ | 'GT'
1264
+ | 'GU'
1265
+ | 'GW'
1266
+ | 'GY'
1267
+ | 'HK'
1268
+ | 'HM'
1269
+ | 'HN'
1270
+ | 'HR'
1271
+ | 'HT'
1272
+ | 'HU'
1273
+ | 'ID'
1274
+ | 'IE'
1275
+ | 'IL'
1276
+ | 'IM'
1277
+ | 'IN'
1278
+ | 'IO'
1279
+ | 'IQ'
1280
+ | 'IR'
1281
+ | 'IS'
1282
+ | 'IT'
1283
+ | 'JE'
1284
+ | 'JM'
1285
+ | 'JO'
1286
+ | 'JP'
1287
+ | 'KE'
1288
+ | 'KG'
1289
+ | 'KH'
1290
+ | 'KI'
1291
+ | 'KM'
1292
+ | 'KN'
1293
+ | 'KP'
1294
+ | 'KR'
1295
+ | 'KW'
1296
+ | 'KY'
1297
+ | 'KZ'
1298
+ | 'LA'
1299
+ | 'LB'
1300
+ | 'LC'
1301
+ | 'LI'
1302
+ | 'LK'
1303
+ | 'LR'
1304
+ | 'LS'
1305
+ | 'LT'
1306
+ | 'LU'
1307
+ | 'LV'
1308
+ | 'LY'
1309
+ | 'MA'
1310
+ | 'MC'
1311
+ | 'MD'
1312
+ | 'ME'
1313
+ | 'MF'
1314
+ | 'MG'
1315
+ | 'MH'
1316
+ | 'MK'
1317
+ | 'ML'
1318
+ | 'MM'
1319
+ | 'MN'
1320
+ | 'MO'
1321
+ | 'MP'
1322
+ | 'MQ'
1323
+ | 'MR'
1324
+ | 'MS'
1325
+ | 'MT'
1326
+ | 'MU'
1327
+ | 'MV'
1328
+ | 'MW'
1329
+ | 'MX'
1330
+ | 'MY'
1331
+ | 'MZ'
1332
+ | 'NA'
1333
+ | 'NC'
1334
+ | 'NE'
1335
+ | 'NF'
1336
+ | 'NG'
1337
+ | 'NI'
1338
+ | 'NL'
1339
+ | 'NO'
1340
+ | 'NP'
1341
+ | 'NR'
1342
+ | 'NU'
1343
+ | 'NZ'
1344
+ | 'OM'
1345
+ | 'PA'
1346
+ | 'PE'
1347
+ | 'PF'
1348
+ | 'PG'
1349
+ | 'PH'
1350
+ | 'PK'
1351
+ | 'PL'
1352
+ | 'PM'
1353
+ | 'PN'
1354
+ | 'PR'
1355
+ | 'PS'
1356
+ | 'PT'
1357
+ | 'PW'
1358
+ | 'PY'
1359
+ | 'QA'
1360
+ | 'RE'
1361
+ | 'RO'
1362
+ | 'RS'
1363
+ | 'RU'
1364
+ | 'RW'
1365
+ | 'SA'
1366
+ | 'SB'
1367
+ | 'SC'
1368
+ | 'SD'
1369
+ | 'SE'
1370
+ | 'SG'
1371
+ | 'SH'
1372
+ | 'SI'
1373
+ | 'SJ'
1374
+ | 'SK'
1375
+ | 'SL'
1376
+ | 'SM'
1377
+ | 'SN'
1378
+ | 'SO'
1379
+ | 'SR'
1380
+ | 'SS'
1381
+ | 'ST'
1382
+ | 'SV'
1383
+ | 'SX'
1384
+ | 'SY'
1385
+ | 'SZ'
1386
+ | 'TC'
1387
+ | 'TD'
1388
+ | 'TF'
1389
+ | 'TG'
1390
+ | 'TH'
1391
+ | 'TJ'
1392
+ | 'TK'
1393
+ | 'TL'
1394
+ | 'TM'
1395
+ | 'TN'
1396
+ | 'TO'
1397
+ | 'TR'
1398
+ | 'TT'
1399
+ | 'TV'
1400
+ | 'TW'
1401
+ | 'TZ'
1402
+ | 'UA'
1403
+ | 'UG'
1404
+ | 'UM'
1405
+ | 'US'
1406
+ | 'UY'
1407
+ | 'UZ'
1408
+ | 'VA'
1409
+ | 'VC'
1410
+ | 'VE'
1411
+ | 'VG'
1412
+ | 'VI'
1413
+ | 'VN'
1414
+ | 'VU'
1415
+ | 'WF'
1416
+ | 'WS'
1417
+ | 'YE'
1418
+ | 'YT'
1419
+ | 'ZA'
1420
+ | 'ZM'
1421
+ | 'ZW'
1422
+ | 'AC'
1423
+ | 'AN'
1424
+ | 'AP'
1425
+ | 'CP'
1426
+ | 'DG'
1427
+ | 'EA'
1428
+ | 'EU'
1429
+ | 'IC'
1430
+ | 'JX'
1431
+ | 'TA'
1432
+ | 'QO'
1433
+ | 'XK'
1434
+ | '0C'
1435
+ | null;
1436
+ }
1437
+
1438
+ export namespace KrakenEmbedStartIdentityMetadata {
1439
+ /**
1440
+ * Identity information hints including full name and date of birth for proof of
1441
+ * identity verification.
1442
+ */
1443
+ export interface Identity extends KrakenEmbedAPI.KrakenEmbedStartIdentityInfo {}
1444
+ }
1445
+
1446
+ /**
1447
+ * Input payload for starting proof of identity verification via URLs.
1448
+ */
1449
+ export interface KrakenEmbedStartIdentityVerificationURLInput {
1450
+ front_url: string;
1451
+
1452
+ type: 'proof_of_identity';
1453
+
1454
+ back_url?: string | null;
1455
+
1456
+ /**
1457
+ * Debug options for start verification. Only works in non-production environments.
1458
+ */
1459
+ debug?: KrakenEmbedStartIdentityVerificationURLInput.Debug;
1460
+
1461
+ /**
1462
+ * Optional best-effort metadata hints for proof of identity verification.
1463
+ */
1464
+ metadata?: KrakenEmbedStartIdentityVerificationURLInput.Metadata;
1465
+ }
1466
+
1467
+ export namespace KrakenEmbedStartIdentityVerificationURLInput {
1468
+ /**
1469
+ * Debug options for start verification. Only works in non-production environments.
1470
+ */
1471
+ export interface Debug extends KrakenEmbedAPI.KrakenEmbedStartVerificationDebug {}
1472
+
1473
+ /**
1474
+ * Optional best-effort metadata hints for proof of identity verification.
1475
+ */
1476
+ export interface Metadata extends KrakenEmbedAPI.KrakenEmbedStartIdentityMetadata {}
1477
+ }
1478
+
1479
+ /**
1480
+ * Input payload for starting proof of liveness verification via URLs.
1481
+ */
1482
+ export interface KrakenEmbedStartLivenessVerificationURLInput {
1483
+ center_url: string;
1484
+
1485
+ left_url: string;
1486
+
1487
+ right_url: string;
1488
+
1489
+ type: 'proof_of_liveness';
1490
+
1491
+ /**
1492
+ * Debug options for start verification. Only works in non-production environments.
1493
+ */
1494
+ debug?: KrakenEmbedStartLivenessVerificationURLInput.Debug;
1495
+ }
1496
+
1497
+ export namespace KrakenEmbedStartLivenessVerificationURLInput {
1498
+ /**
1499
+ * Debug options for start verification. Only works in non-production environments.
1500
+ */
1501
+ export interface Debug extends KrakenEmbedAPI.KrakenEmbedStartVerificationDebug {}
1502
+ }
1503
+
1504
+ /**
1505
+ * Debug options for start verification. Only works in non-production environments.
1506
+ */
1507
+ export interface KrakenEmbedStartVerificationDebug {
1508
+ outcome?: 'failed' | null;
1509
+ }
1510
+
1511
+ /**
1512
+ * Discriminated union of all start verification URL input types.
1513
+ */
1514
+ export type KrakenEmbedStartVerificationURLInput =
1515
+ | KrakenEmbedStartIdentityVerificationURLInput
1516
+ | KrakenEmbedStartAddressVerificationURLInput
1517
+ | KrakenEmbedStartLivenessVerificationURLInput;
1518
+
1519
+ /**
1520
+ * Response body for starting verification via URL.
1521
+ */
1522
+ export interface KrakenEmbedStartVerificationURLResponse {
1523
+ /**
1524
+ * Result payload for start verification URL response.
1525
+ */
1526
+ result: KrakenEmbedStartVerificationURLResponse.Result;
1527
+ }
1528
+
1529
+ export namespace KrakenEmbedStartVerificationURLResponse {
1530
+ /**
1531
+ * Result payload for start verification URL response.
1532
+ */
1533
+ export interface Result extends KrakenEmbedAPI.KrakenEmbedStartVerificationURLResult {}
1534
+ }
1535
+
1536
+ /**
1537
+ * Result payload for start verification URL response.
1538
+ */
1539
+ export interface KrakenEmbedStartVerificationURLResult {
1540
+ verification_id: string;
1541
+ }
1542
+
172
1543
  export declare namespace KrakenEmbed {
173
1544
  export {
1545
+ type KrakenEmbedCancelCustomOrderInput as KrakenEmbedCancelCustomOrderInput,
1546
+ type KrakenEmbedCancelCustomOrderPath as KrakenEmbedCancelCustomOrderPath,
1547
+ type KrakenEmbedCancelCustomOrderResponse as KrakenEmbedCancelCustomOrderResponse,
1548
+ type KrakenEmbedCancelCustomOrderResult as KrakenEmbedCancelCustomOrderResult,
1549
+ type KrakenEmbedCreateCustomOrderInput as KrakenEmbedCreateCustomOrderInput,
1550
+ type KrakenEmbedCreateCustomOrderResponse as KrakenEmbedCreateCustomOrderResponse,
1551
+ type KrakenEmbedCreateCustomOrderResult as KrakenEmbedCreateCustomOrderResult,
174
1552
  type KrakenEmbedCurrentDayPnl as KrakenEmbedCurrentDayPnl,
1553
+ type KrakenEmbedCustomOrder as KrakenEmbedCustomOrder,
1554
+ type KrakenEmbedCustomOrderAction as KrakenEmbedCustomOrderAction,
1555
+ type KrakenEmbedCustomOrderAmount as KrakenEmbedCustomOrderAmount,
1556
+ type KrakenEmbedCustomOrderOccurrence as KrakenEmbedCustomOrderOccurrence,
1557
+ type KrakenEmbedCustomOrderOccurrenceExecutedAction as KrakenEmbedCustomOrderOccurrenceExecutedAction,
1558
+ type KrakenEmbedCustomOrderOccurrenceTrigger as KrakenEmbedCustomOrderOccurrenceTrigger,
1559
+ type KrakenEmbedCustomOrderQuoteAsset as KrakenEmbedCustomOrderQuoteAsset,
1560
+ type KrakenEmbedCustomOrderStatus as KrakenEmbedCustomOrderStatus,
1561
+ type KrakenEmbedCustomOrderTrigger as KrakenEmbedCustomOrderTrigger,
175
1562
  type KrakenEmbedGetAssetListQueryParamsSchema as KrakenEmbedGetAssetListQueryParamsSchema,
1563
+ type KrakenEmbedGetCustomOrderHistoryQueryParams as KrakenEmbedGetCustomOrderHistoryQueryParams,
1564
+ type KrakenEmbedGetCustomOrderHistoryResponse as KrakenEmbedGetCustomOrderHistoryResponse,
1565
+ type KrakenEmbedGetCustomOrderHistoryResult as KrakenEmbedGetCustomOrderHistoryResult,
1566
+ type KrakenEmbedGetCustomOrderQueryParams as KrakenEmbedGetCustomOrderQueryParams,
1567
+ type KrakenEmbedGetCustomOrderResponse as KrakenEmbedGetCustomOrderResponse,
1568
+ type KrakenEmbedGetCustomOrderResult as KrakenEmbedGetCustomOrderResult,
176
1569
  type KrakenEmbedGetPortfolioDetailsQueryParamsSchema as KrakenEmbedGetPortfolioDetailsQueryParamsSchema,
177
1570
  type KrakenEmbedGetPortfolioSummaryQueryParams as KrakenEmbedGetPortfolioSummaryQueryParams,
178
1571
  type KrakenEmbedGetPortfolioSummaryResponse as KrakenEmbedGetPortfolioSummaryResponse,
179
1572
  type KrakenEmbedGetPortfolioTransactionsQueryParamsSchema as KrakenEmbedGetPortfolioTransactionsQueryParamsSchema,
180
1573
  type KrakenEmbedGetQuoteQueryParams as KrakenEmbedGetQuoteQueryParams,
1574
+ type KrakenEmbedListCustomOrdersQueryParams as KrakenEmbedListCustomOrdersQueryParams,
1575
+ type KrakenEmbedListCustomOrdersResponse as KrakenEmbedListCustomOrdersResponse,
1576
+ type KrakenEmbedListCustomOrdersResult as KrakenEmbedListCustomOrdersResult,
1577
+ type KrakenEmbedStartAddressMetadata as KrakenEmbedStartAddressMetadata,
1578
+ type KrakenEmbedStartAddressVerificationURLInput as KrakenEmbedStartAddressVerificationURLInput,
1579
+ type KrakenEmbedStartIdentityInfo as KrakenEmbedStartIdentityInfo,
1580
+ type KrakenEmbedStartIdentityMetadata as KrakenEmbedStartIdentityMetadata,
1581
+ type KrakenEmbedStartIdentityVerificationURLInput as KrakenEmbedStartIdentityVerificationURLInput,
1582
+ type KrakenEmbedStartLivenessVerificationURLInput as KrakenEmbedStartLivenessVerificationURLInput,
1583
+ type KrakenEmbedStartVerificationDebug as KrakenEmbedStartVerificationDebug,
1584
+ type KrakenEmbedStartVerificationURLInput as KrakenEmbedStartVerificationURLInput,
1585
+ type KrakenEmbedStartVerificationURLResponse as KrakenEmbedStartVerificationURLResponse,
1586
+ type KrakenEmbedStartVerificationURLResult as KrakenEmbedStartVerificationURLResult,
181
1587
  };
182
1588
  }