@dakota-xyz/ts-sdk 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -446,6 +446,13 @@ type components = {
446
446
  readonly id: string;
447
447
  /** @enum {string} */
448
448
  readonly entry_type: "purchase" | "deduction" | "refund";
449
+ /**
450
+ * @description Sub-category that distinguishes transaction fees from compliance
451
+ * fees and similar for refunds. `unknown` indicates a legacy row
452
+ * written before this column existed.
453
+ * @enum {string}
454
+ */
455
+ readonly category: "transaction_fee" | "compliance_fee" | "transaction_refund" | "compliance_refund" | "purchase" | "adjustment" | "unknown";
449
456
  /**
450
457
  * Format: int64
451
458
  * @example -5000
@@ -457,6 +464,11 @@ type components = {
457
464
  */
458
465
  readonly balance_after_cents: number;
459
466
  readonly transaction_id?: string | null;
467
+ /**
468
+ * @description Stripe PaymentIntent ID (pi_...) for purchase entries — paste into the Stripe dashboard search to look up the underlying payment.
469
+ * @example pi_3M5xY42eZvKYlo2C0xRm6WVe
470
+ */
471
+ readonly stripe_payment_intent_id?: string | null;
460
472
  /** @example Transfer fee for transaction txn_123 */
461
473
  readonly description: string;
462
474
  /** Format: date-time */
@@ -517,6 +529,12 @@ type components = {
517
529
  readonly role: components["schemas"]["ClientUserRole"];
518
530
  /** @description Whether the client has SWIFT payments enabled. */
519
531
  readonly swift_enabled?: boolean;
532
+ readonly client_id?: components["schemas"]["KSUID"];
533
+ /**
534
+ * @description Display name of the active client for this request.
535
+ * @example Acme Corp
536
+ */
537
+ readonly client_name?: string;
520
538
  /**
521
539
  * @description Timestamp of when the user was created.
522
540
  * @example 1234567890
@@ -529,6 +547,66 @@ type components = {
529
547
  * @enum {string}
530
548
  */
531
549
  readonly ClientUserRole: "admin" | "viewer";
550
+ readonly ClientPricingConfig: {
551
+ /**
552
+ * @description Monthly minimum fee in cents
553
+ * @example 10000
554
+ */
555
+ readonly monthlyMinimumCents: number;
556
+ /**
557
+ * @description Transfer fee in basis points (0-10000, representing 0% to 100%)
558
+ * @example 25
559
+ */
560
+ readonly transferFeeBps: number;
561
+ /**
562
+ * @description Per-ACH transaction fee in cents
563
+ * @example 100
564
+ */
565
+ readonly achFeeCents: number;
566
+ /**
567
+ * @description Per-wire transaction fee in cents
568
+ * @example 2500
569
+ */
570
+ readonly wireFeeCents: number;
571
+ /**
572
+ * @description Per-SWIFT transaction fee in cents
573
+ * @example 150
574
+ */
575
+ readonly sepaFeeCents: number;
576
+ /**
577
+ * @description Per-Swift-transfer banking fee in USD cents.
578
+ * @example 4000
579
+ */
580
+ readonly swiftFeeCents: number;
581
+ /**
582
+ * @description Per-individual-application-submission compliance fee in USD cents.
583
+ * @example 500
584
+ */
585
+ readonly kycFeeCents: number;
586
+ /**
587
+ * @description Per-business-application-submission compliance fee in USD cents.
588
+ * @example 2500
589
+ */
590
+ readonly kybFeeCents: number;
591
+ /**
592
+ * Format: date-time
593
+ * @description When this pricing takes effect
594
+ * @example 2024-01-01T00:00:00Z
595
+ */
596
+ readonly effectiveFrom: string;
597
+ /**
598
+ * Format: date-time
599
+ * @description When this pricing configuration was created
600
+ * @example 2024-01-01T00:00:00Z
601
+ */
602
+ readonly createdAt: string;
603
+ /**
604
+ * Format: date-time
605
+ * @description When this pricing configuration was last updated
606
+ * @example 2024-01-01T00:00:00Z
607
+ */
608
+ readonly updatedAt: string;
609
+ };
532
610
  /** @description Request body for creating a new client user */
533
611
  readonly CreateClientUserRequest: {
534
612
  /**
@@ -795,6 +873,15 @@ type components = {
795
873
  */
796
874
  readonly country: string;
797
875
  };
876
+ /**
877
+ * Destination Address
878
+ * @description Address format for fiat destinations with Lead Bank wire transfer character limits (max 35 characters per address line).
879
+ */
880
+ readonly FiatUSDestinationAddress: components["schemas"]["Address"] & {
881
+ readonly street1?: string;
882
+ readonly street2?: string;
883
+ readonly street3?: string;
884
+ };
798
885
  readonly Country: {
799
886
  /** @example CA */
800
887
  readonly code: string;
@@ -862,6 +949,31 @@ type components = {
862
949
  */
863
950
  readonly customer_type: "individual" | "business";
864
951
  readonly kyb_status: components["schemas"]["KybStatus"];
952
+ /**
953
+ * @description Provider-agnostic effective KYC/B status for this customer,
954
+ * derived server-side for display convenience. Returns the same
955
+ * answer for both Sumsub-verified and Persona-verified customers
956
+ * without the client having to know which provider did the work.
957
+ *
958
+ * **Derivation order (most authoritative first):**
959
+ * 1. The customer's onboarding application `decision`, if set
960
+ * (`approved` → `approved`; `declined`/`auto_declined` →
961
+ * `rejected`; `withdrawn` → `expired`).
962
+ * 2. The most-recently-updated non-deleted persona `kyb_link`'s
963
+ * status (legacy customers from before the orchestration
964
+ * layer — Persona's `created` maps to `not_started`,
965
+ * `completed` to `approved`, `needs_review` to `in_review`).
966
+ * 3. `pending` if the customer has an open onboarding
967
+ * application but no decision yet (Sumsub in-flight).
968
+ * 4. `not_started` otherwise.
969
+ *
970
+ * **Advisory, not authoritative.** This field is provided for
971
+ * badge rendering and operator UIs. The derivation rules may
972
+ * evolve as new verification providers are added. For
973
+ * compliance-critical decisions, consult `decision`,
974
+ * `kyb_links`, and `provider_statuses` directly.
975
+ */
976
+ readonly kyc_status: components["schemas"]["KybLinkStatus"];
865
977
  /** @description KYB Links for different providers used in the KYB process. */
866
978
  readonly kyb_links?: readonly components["schemas"]["KybLink"][];
867
979
  /** @description Detailed status information from different verification providers used in the KYB process. */
@@ -988,6 +1100,13 @@ type components = {
988
1100
  /**
989
1101
  * KYB Link Type
990
1102
  * @description Type of link provided by a verification provider for KYB verification.
1103
+ *
1104
+ * **Deprecated values:**
1105
+ * - `tos` — the Bridge TOS flow has been deprecated. The dashboard no
1106
+ * longer surfaces TOS state, but legacy customer records may still
1107
+ * carry `link_type: 'tos'` entries on the wire. New integrations
1108
+ * should ignore these entries; the value is retained in the enum
1109
+ * to keep responses for legacy data schema-valid.
991
1110
  * @example persona
992
1111
  * @enum {string}
993
1112
  */
@@ -1029,13 +1148,13 @@ type components = {
1029
1148
  * @example ach
1030
1149
  * @enum {string}
1031
1150
  */
1032
- readonly PaymentCapability: "ach" | "fedwire" | "swift" | "sepa" | "us_bank_account";
1151
+ readonly PaymentCapability: "ach" | "fedwire" | "swift" | "us_bank_account";
1033
1152
  /**
1034
1153
  * Transaction Status
1035
1154
  * @description Current status of a transaction.
1036
1155
  * @enum {string}
1037
1156
  */
1038
- readonly TransactionStatus: "timed_out" | "not_started" | "in_progress" | "awaiting_confirmation" | "pending" | "processing" | "completed" | "invalid" | "failed" | "canceled" | "reversed" | "rejected" | "broadcasted" | "pending_return" | "returned";
1157
+ readonly TransactionStatus: "timed_out" | "not_started" | "in_progress" | "awaiting_confirmation" | "pending" | "processing" | "completed" | "invalid" | "failed" | "canceled" | "reversed" | "rejected" | "broadcasted" | "pending_return" | "returned" | "pending_reversal";
1039
1158
  /**
1040
1159
  * Transaction Type
1041
1160
  * @description Type of transaction.
@@ -1286,13 +1405,13 @@ type components = {
1286
1405
  readonly account_type: "checking" | "savings";
1287
1406
  /** @example John Doe */
1288
1407
  readonly account_holder_name: string;
1289
- readonly account_holder_address?: components["schemas"]["Address"];
1408
+ readonly account_holder_address?: components["schemas"]["FiatUSDestinationAddress"];
1290
1409
  /** @example 1234567890 */
1291
1410
  readonly account_holder_phone?: string;
1292
1411
  /** @example Bank of America */
1293
1412
  readonly bank_name: string;
1294
1413
  /** @description Address of the bank. Optional for US domestic transfers. */
1295
- readonly bank_address?: components["schemas"]["Address"];
1414
+ readonly bank_address?: components["schemas"]["FiatUSDestinationAddress"];
1296
1415
  /** @example 1234567890 */
1297
1416
  readonly bank_phone?: string;
1298
1417
  } & {
@@ -1310,7 +1429,7 @@ type components = {
1310
1429
  };
1311
1430
  /**
1312
1431
  * IBAN Fiat Destination Request
1313
- * @description Request for creating or updating an IBAN bank account destination (for SWIFT and SEPA transfers).
1432
+ * @description Request for creating or updating an IBAN bank account destination (for SWIFT and SWIFT transfers).
1314
1433
  */
1315
1434
  readonly FiatIBANDestinationRequest: Omit<components["schemas"]["DestinationRequest"], "destination_type"> & {
1316
1435
  /**
@@ -1331,7 +1450,7 @@ type components = {
1331
1450
  */
1332
1451
  readonly iban: string;
1333
1452
  /**
1334
- * @description BIC/SWIFT code for the international bank account (optional for SEPA, required for SWIFT).
1453
+ * @description BIC/SWIFT code for the international bank account (optional for required for SWIFT).
1335
1454
  * @example DEUTDEFFXXX
1336
1455
  */
1337
1456
  readonly bic?: string;
@@ -1536,7 +1655,7 @@ type components = {
1536
1655
  };
1537
1656
  /**
1538
1657
  * IBAN Fiat Destination Response
1539
- * @description Response for an IBAN bank account destination (for SWIFT and SEPA transfers).
1658
+ * @description Response for an IBAN bank account destination (for SWIFT and SWIFT transfers).
1540
1659
  */
1541
1660
  readonly FiatIBANDestinationResponse: Omit<components["schemas"]["DestinationResponse"], "destination_type"> & {
1542
1661
  /**
@@ -1555,7 +1674,7 @@ type components = {
1555
1674
  */
1556
1675
  readonly iban: string;
1557
1676
  /**
1558
- * @description BIC/SWIFT code for the international bank account (optional for SEPA, required for SWIFT).
1677
+ * @description BIC/SWIFT code for the international bank account (optional for required for SWIFT).
1559
1678
  * @example DEUTDEFFXXX
1560
1679
  */
1561
1680
  readonly bic?: string;
@@ -1631,6 +1750,7 @@ type components = {
1631
1750
  * @example 1234567890
1632
1751
  */
1633
1752
  readonly completedAt?: number | null;
1753
+ readonly sender_details?: components["schemas"]["SenderDetails"];
1634
1754
  };
1635
1755
  readonly TransactionResource: components["schemas"]["OneOffTransaction"] | components["schemas"]["WalletTransaction"] | components["schemas"]["Transaction"];
1636
1756
  readonly PaginatedCustomerTransactionResponse: components["schemas"]["PaginatedListResponse"] & {
@@ -1794,6 +1914,64 @@ type components = {
1794
1914
  /** @description List of event types this target cares about (ignored if global is true) */
1795
1915
  readonly event_types?: readonly components["schemas"]["EventType"][];
1796
1916
  };
1917
+ /** @description Originating sender details for onramp/offramp/swap transactions. Populated when source-side metadata is available (e.g., from inbound wire/ACH source data). */
1918
+ readonly SenderDetails: {
1919
+ /**
1920
+ * @description Type of the originating sender (e.g., "fiat_account", "crypto_wallet").
1921
+ * @example fiat_account
1922
+ */
1923
+ readonly sender_type?: string;
1924
+ /**
1925
+ * @description Name on the originating account.
1926
+ * @example John Doe
1927
+ */
1928
+ readonly sender_account_holder_name?: string;
1929
+ /**
1930
+ * @description Bank name of the originating account.
1931
+ * @example Chase Bank
1932
+ */
1933
+ readonly sender_bank_name?: string;
1934
+ /**
1935
+ * @description ACH routing number of the originating bank account.
1936
+ * @example 021000021
1937
+ */
1938
+ readonly sender_routing_number?: string;
1939
+ /**
1940
+ * @description Account number of the originating bank account.
1941
+ * @example 1234567890
1942
+ */
1943
+ readonly sender_account_number?: string;
1944
+ /**
1945
+ * @description Wire routing number of the originating bank account.
1946
+ * @example 021000021
1947
+ */
1948
+ readonly sender_wire_routing_number?: string;
1949
+ /**
1950
+ * @description Type of the originating bank account (e.g., "checking", "savings").
1951
+ * @example checking
1952
+ */
1953
+ readonly sender_account_type?: string;
1954
+ /**
1955
+ * @description IBAN of the originating account.
1956
+ * @example GB82WEST12345698765432
1957
+ */
1958
+ readonly sender_iban?: string;
1959
+ /**
1960
+ * @description BIC/SWIFT code of the originating bank.
1961
+ * @example BARCGB22XXX
1962
+ */
1963
+ readonly sender_bic?: string;
1964
+ /**
1965
+ * @description Blockchain wallet address of the originating sender (offramp/swap).
1966
+ * @example 0x1234567890abcdef1234567890abcdef12345678
1967
+ */
1968
+ readonly sender_wallet_address?: string;
1969
+ /**
1970
+ * @description Network identifier of the originating wallet (e.g., "ethereum-mainnet").
1971
+ * @example ethereum-mainnet
1972
+ */
1973
+ readonly sender_network?: string;
1974
+ };
1797
1975
  /** @description A transaction relating to an auto account */
1798
1976
  readonly AutoAccountTransaction: {
1799
1977
  readonly id: components["schemas"]["KSUID"];
@@ -1821,6 +1999,7 @@ type components = {
1821
1999
  readonly completed_at?: number;
1822
2000
  readonly receipt?: components["schemas"]["TransactionReceipt"];
1823
2001
  readonly crypto_details?: components["schemas"]["TransactionCryptoDetails"];
2002
+ readonly sender_details?: components["schemas"]["SenderDetails"];
1824
2003
  /**
1825
2004
  * @description Provider identifier
1826
2005
  * @example dakota
@@ -1836,6 +2015,36 @@ type components = {
1836
2015
  * @example processing
1837
2016
  */
1838
2017
  readonly provider_status: string;
2018
+ /**
2019
+ * @description NACHA/Fedwire return code (e.g., R01) when the transaction was returned by the receiving bank.
2020
+ * @example R01
2021
+ */
2022
+ readonly return_code?: string;
2023
+ /**
2024
+ * @description Human-readable return reason provided by the receiving bank.
2025
+ * @example Insufficient Funds
2026
+ */
2027
+ readonly return_reason?: string;
2028
+ /**
2029
+ * @description Unix timestamp when the return was initiated.
2030
+ * @example 1234567890
2031
+ */
2032
+ readonly return_initiated_at?: number;
2033
+ /**
2034
+ * @description Unix timestamp deadline for return processing.
2035
+ * @example 1234567890
2036
+ */
2037
+ readonly return_deadline?: number;
2038
+ /**
2039
+ * @description Lead Bank ACH reversal reason when the originator reverses the transaction (e.g., duplicate, receiver_incorrect).
2040
+ * @example duplicate
2041
+ */
2042
+ readonly reversal_reason?: string;
2043
+ /**
2044
+ * @description Unix timestamp when the reversal was initiated.
2045
+ * @example 1234567890
2046
+ */
2047
+ readonly reversal_initiated_at?: number;
1839
2048
  };
1840
2049
  /** @description Detailed representation of an amount with its asset and optional metadata */
1841
2050
  readonly AmountDetails: {
@@ -1923,7 +2132,7 @@ type components = {
1923
2132
  /** @description Optional preferred payment rail for bank transfers. If not specified, the system will automatically select the most appropriate rail based on the destination's supported methods. */
1924
2133
  readonly destination_payment_rail?: components["schemas"]["PaymentCapability"];
1925
2134
  /**
1926
- * @description Optional payment reference message for bank transfers. Length limits: ACH (1-10 chars), Wire (1-140 chars), SEPA (6-140 chars), SWIFT (1-140 chars, max 4 lines of 35 chars each)
2135
+ * @description Optional payment reference message for bank transfers. Length limits: ACH (1-10 chars), Wire (1-140 chars) (6-140 chars), SWIFT (1-140 chars, max 4 lines of 35 chars each)
1927
2136
  * @example Invoice payment for services
1928
2137
  */
1929
2138
  readonly payment_reference?: string;
@@ -1988,7 +2197,7 @@ type components = {
1988
2197
  readonly completed_at?: number;
1989
2198
  /** @description The payment rail that was selected for this transaction */
1990
2199
  readonly destination_payment_rail?: components["schemas"]["PaymentCapability"];
1991
- /** @description Payment reference message for bank transfers (e.g. wire message, SWIFT or SEPA reference) */
2200
+ /** @description Payment reference message for bank transfers (e.g. wire message, SWIFT reference) */
1992
2201
  readonly payment_reference?: string | null;
1993
2202
  /**
1994
2203
  * @description Name of the destination bank
@@ -2020,13 +2229,48 @@ type components = {
2020
2229
  * @example BARCGB22XXX
2021
2230
  */
2022
2231
  readonly destination_bic?: string;
2232
+ /**
2233
+ * @description NACHA/Fedwire return code (e.g., R01) when the transaction was returned by the receiving bank.
2234
+ * @example R01
2235
+ */
2236
+ readonly return_code?: string;
2237
+ /**
2238
+ * @description Human-readable return reason provided by the receiving bank.
2239
+ * @example Insufficient Funds
2240
+ */
2241
+ readonly return_reason?: string;
2242
+ /**
2243
+ * @description Unix timestamp when the return was initiated.
2244
+ * @example 1234567890
2245
+ */
2246
+ readonly return_initiated_at?: number;
2247
+ /**
2248
+ * @description Unix timestamp deadline for return processing.
2249
+ * @example 1234567890
2250
+ */
2251
+ readonly return_deadline?: number;
2252
+ /**
2253
+ * @description Lead Bank ACH reversal reason when the originator reverses the transaction (e.g., duplicate, receiver_incorrect).
2254
+ * @example duplicate
2255
+ */
2256
+ readonly reversal_reason?: string;
2257
+ /**
2258
+ * @description Unix timestamp when the reversal was initiated.
2259
+ * @example 1234567890
2260
+ */
2261
+ readonly reversal_initiated_at?: number;
2262
+ /**
2263
+ * @description Display name of the customer associated with this transaction.
2264
+ * @example Acme Corp
2265
+ */
2266
+ readonly customer_name?: string;
2023
2267
  };
2024
2268
  /**
2025
2269
  * @description Status of a one-off transaction
2026
2270
  * @example pending
2027
2271
  * @enum {string}
2028
2272
  */
2029
- readonly OneOffTransactionStatus: "pending" | "processing" | "completed" | "failed" | "cancelled" | "reversed" | "pending_return" | "returned";
2273
+ readonly OneOffTransactionStatus: "pending" | "processing" | "completed" | "failed" | "cancelled" | "reversed" | "pending_return" | "returned" | "pending_reversal";
2030
2274
  readonly PaginatedOneOffTransactionResponse: components["schemas"]["PaginatedListResponse"] & {
2031
2275
  readonly data?: readonly components["schemas"]["OneOffTransaction"][];
2032
2276
  };
@@ -2137,7 +2381,13 @@ type components = {
2137
2381
  * @example Marc
2138
2382
  */
2139
2383
  readonly name: string;
2140
- /** @description The signer public key */
2384
+ /**
2385
+ * @description The signer public key. For KEY_TYPE_ES256 this must be a
2386
+ * base64-encoded X.509 SubjectPublicKeyInfo (PKIX) for an ECDSA
2387
+ * P-256 key. Both PEM-wrapped (with BEGIN/END PUBLIC KEY headers)
2388
+ * and raw DER encodings are accepted. For KEY_TYPE_WEBAUTHN this
2389
+ * must be a base64-encoded COSE public key.
2390
+ */
2141
2391
  readonly public_key: string;
2142
2392
  /**
2143
2393
  * @description Type of the key
@@ -2152,7 +2402,13 @@ type components = {
2152
2402
  * @example Marc
2153
2403
  */
2154
2404
  readonly name: string;
2155
- /** @description The signer public key */
2405
+ /**
2406
+ * @description The signer public key. For KEY_TYPE_ES256 this must be a
2407
+ * base64-encoded X.509 SubjectPublicKeyInfo (PKIX) for an ECDSA
2408
+ * P-256 key. Both PEM-wrapped (with BEGIN/END PUBLIC KEY headers)
2409
+ * and raw DER encodings are accepted. For KEY_TYPE_WEBAUTHN this
2410
+ * must be a base64-encoded COSE public key.
2411
+ */
2156
2412
  readonly public_key: string;
2157
2413
  /**
2158
2414
  * @description Type of the key
@@ -2174,6 +2430,11 @@ type components = {
2174
2430
  */
2175
2431
  readonly id: string;
2176
2432
  readonly client_id?: components["schemas"]["KSUID"];
2433
+ /**
2434
+ * @description ID of the signer group that governs mutations of this policy. Members of this group must endorse any add_policy_rule, update_policy_rule, remove_policy_rule, or delete_policy intent.
2435
+ * @example grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT
2436
+ */
2437
+ readonly signer_group_id?: string | null;
2177
2438
  /**
2178
2439
  * Format: int32
2179
2440
  * @description Version number of the policy (incremented on rule changes)
@@ -3681,6 +3942,17 @@ type components = {
3681
3942
  * @enum {string|null}
3682
3943
  */
3683
3944
  readonly application_decision?: "approved" | "declined" | "withdrawn" | null;
3945
+ /**
3946
+ * @description How the decision was reached: 'manual' for operator-driven decisions, 'auto' for automated approvals, 'override' reserved for future escalation. Null if no decision has been made.
3947
+ * @example manual
3948
+ * @enum {string|null}
3949
+ */
3950
+ readonly decision_method?: "manual" | "auto" | "override" | null;
3951
+ /**
3952
+ * @description Version identifier of the rule set that produced an automated decision. Null for manual decisions or when no decision has been made.
3953
+ * @example v1.2
3954
+ */
3955
+ readonly decision_rule_version?: string | null;
3684
3956
  /** @description The people/businesses being onboarded */
3685
3957
  readonly entities?: components["schemas"]["ApplicationEntities"];
3686
3958
  /** @description Enhanced Due Diligence data (if provided) */
@@ -3907,6 +4179,32 @@ type components = {
3907
4179
  */
3908
4180
  readonly applicant_id: string;
3909
4181
  };
4182
+ /** @description Error response when a self-serve client lacks the credits required to perform an action. */
4183
+ readonly InsufficientCreditsError: {
4184
+ /**
4185
+ * @description Stable machine-readable error code.
4186
+ * @example insufficient_credits
4187
+ * @enum {string}
4188
+ */
4189
+ readonly error: "insufficient_credits";
4190
+ /**
4191
+ * @description Human-readable explanation including the required and current amounts.
4192
+ * @example Insufficient credits to submit this application. Required 2500 cents, balance 500 cents.
4193
+ */
4194
+ readonly message: string;
4195
+ /**
4196
+ * Format: int64
4197
+ * @description Amount of credits required to perform this action, in USD cents.
4198
+ * @example 2500
4199
+ */
4200
+ readonly required_cents: number;
4201
+ /**
4202
+ * Format: int64
4203
+ * @description Caller's current credit balance, in USD cents.
4204
+ * @example 500
4205
+ */
4206
+ readonly balance_cents: number;
4207
+ };
3910
4208
  /** @description Error response when application cannot be submitted because applicants are not ready */
3911
4209
  readonly ApplicationNotReadyError: {
3912
4210
  /**
@@ -4105,6 +4403,36 @@ type components = {
4105
4403
  readonly EndingBeforeParam: components["schemas"]["KSUID"];
4106
4404
  /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. */
4107
4405
  readonly LimitParam: number;
4406
+ /**
4407
+ * @description Sandbox-only. Sets the HTTP status code returned when the sandbox injects an error at the configured step (see `X-Sandbox-Error-Step`). Must be a valid HTTP status code in the range 100-599; values outside that range are ignored. Status codes >= 400 cause the request to short-circuit immediately with a structured error response.
4408
+ * Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
4409
+ */
4410
+ readonly SandboxErrorStatusHeader: number;
4411
+ /**
4412
+ * @description Sandbox-only. Sets the human-readable `message` field of the injected sandbox error response. Truncated values longer than 500 characters are ignored.
4413
+ * Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
4414
+ */
4415
+ readonly SandboxErrorMessageHeader: string;
4416
+ /**
4417
+ * @description Sandbox-only. Names the pipeline step at which the injected error fires. Pair with `X-Sandbox-Error-Status` and (optionally) `X-Sandbox-Error-Message` to drive a deterministic failure mode at a known point in the request lifecycle. Values longer than 100 characters are ignored.
4418
+ * Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
4419
+ */
4420
+ readonly SandboxErrorStepHeader: "transaction_processing" | "compliance_check" | "account_validation" | "provider_call" | "kyb_submission" | "kyb_approval" | "network_call";
4421
+ /**
4422
+ * @description Sandbox-only. Applies a preset failure or behavior mode for the request, selecting a coherent combination of error step, status, and message. The full set of scenarios is also exposed dynamically via `GET /sandbox/scenarios` along with descriptions and per-rail applicability.
4423
+ * Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
4424
+ */
4425
+ readonly SandboxScenarioHeader: "happy_path" | "delayed_settlement" | "insufficient_funds" | "compliance_block" | "invalid_account" | "provider_maintenance" | "network_congestion" | "kyb_manual_review" | "kyb_rejected" | "kyb_expired" | "network_timeout" | "intermittent_errors" | "account_frozen" | "document_expired" | "invalid_swift";
4426
+ /**
4427
+ * @description Sandbox-only. When `true`, asynchronous simulation flows complete immediately rather than progressing through their normal timed states. Useful for fast end-to-end test runs that do not need to exercise intermediate webhook events. Accepts `true`/`false` (also `1`/`0`, `yes`/`no`); other values are treated as `false`.
4428
+ * Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
4429
+ */
4430
+ readonly SandboxInstantCompletionHeader: boolean;
4431
+ /**
4432
+ * @description Sandbox-only. When `true`, prevents the default 5-second KYB auto-approval that the sandbox applies to newly created customers. Use this header (typically with `X-Sandbox-Scenario: kyb_manual_review` or `kyb_rejected`) to keep an application in `pending` so integrators can exercise manual-review and rejection flows. Accepts `true`/`false` (also `1`/`0`, `yes`/`no`); other values are treated as `false`.
4433
+ * Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
4434
+ */
4435
+ readonly SandboxSkipAutoApprovalHeader: boolean;
4108
4436
  };
4109
4437
  requestBodies: never;
4110
4438
  headers: never;
@@ -4146,6 +4474,26 @@ type KybStatus = Customer['kyb_status'];
4146
4474
  type UpdateCustomerSubClientRequest = components['schemas']['UpdateCustomerSubClientRequest'];
4147
4475
  /** Summary of a sub-client including the count of associated customers */
4148
4476
  type SubClientSummary = components['schemas']['SubClientSummary'];
4477
+ /** Request body for bulk-importing customers from Sumsub share tokens */
4478
+ interface BulkImportSumsubTokensRequest {
4479
+ /** List of Sumsub share tokens to import */
4480
+ tokens: string[];
4481
+ }
4482
+ /** Per-token outcome for a bulk Sumsub import */
4483
+ interface BulkImportSumsubTokensResult {
4484
+ name?: string;
4485
+ success?: boolean;
4486
+ customer_id?: string;
4487
+ application_id?: string;
4488
+ error?: string;
4489
+ }
4490
+ /** Response from bulk-importing customers from Sumsub share tokens */
4491
+ interface BulkImportSumsubTokensResponse {
4492
+ total?: number;
4493
+ succeeded?: number;
4494
+ failed?: number;
4495
+ results?: BulkImportSumsubTokensResult[];
4496
+ }
4149
4497
  /** Recipient response */
4150
4498
  type Recipient = components['schemas']['RecipientResponse'];
4151
4499
  /** Recipient creation request */
@@ -4628,6 +4976,15 @@ type SelfServeCreditsLedgerResponse = components['schemas']['SelfServeCreditsLed
4628
4976
  type SelfServeCreditTier = components['schemas']['SelfServeCreditTier'];
4629
4977
  /** Self-serve credit tiers response */
4630
4978
  type SelfServeCreditTiersResponse = components['schemas']['SelfServeCreditTiersResponse'];
4979
+ /** Self-serve client pricing configuration (fee schedule) */
4980
+ type ClientPricingConfig = components['schemas']['ClientPricingConfig'];
4981
+ /**
4982
+ * Self-serve credits pricing response.
4983
+ *
4984
+ * Returned by `GET /self-serve/credits/pricing` — the caller's current
4985
+ * `ClientPricingConfig` (transfer/ACH/wire/SEPA/SWIFT/KYC/KYB fees + monthly minimum).
4986
+ */
4987
+ type SelfServeCreditsPricingResponse = ClientPricingConfig;
4631
4988
  /** Ledger entry type filter */
4632
4989
  type SelfServeCreditsLedgerEntryType = SelfServeCreditsLedgerEntry['entry_type'];
4633
4990
  /** Parameters for listing self-serve credits ledger entries */
@@ -4810,6 +5167,29 @@ declare class CustomersResource extends BaseResource {
4810
5167
  * ```
4811
5168
  */
4812
5169
  getSubClientSummary(): Promise<SubClientSummary[]>;
5170
+ /**
5171
+ * Bulk-import customers from Sumsub share tokens.
5172
+ *
5173
+ * Exchanges one or more Sumsub share tokens for Dakota customers + applications.
5174
+ * The response surfaces per-token results — individual tokens can fail while
5175
+ * others succeed.
5176
+ *
5177
+ * @param data - Bulk-import request containing the share tokens to redeem
5178
+ * @param options - Request options (e.g., custom idempotency key)
5179
+ * @returns Bulk-import summary with per-token results
5180
+ *
5181
+ * @example
5182
+ * ```typescript
5183
+ * const result = await client.customers.bulkImportFromSumsubTokens({
5184
+ * tokens: ['_act-sbx-jwt-...', '_act-sbx-jwt-...'],
5185
+ * });
5186
+ * console.log(`Imported ${result.succeeded}/${result.total}`);
5187
+ * for (const r of result.results ?? []) {
5188
+ * if (!r.success) console.error(r.name, r.error);
5189
+ * }
5190
+ * ```
5191
+ */
5192
+ bulkImportFromSumsubTokens(data: BulkImportSumsubTokensRequest, options?: RequestOptions): Promise<BulkImportSumsubTokensResponse>;
4813
5193
  }
4814
5194
 
4815
5195
  /**
@@ -6121,6 +6501,22 @@ declare class SelfServeResource extends BaseResource {
6121
6501
  * ```
6122
6502
  */
6123
6503
  listTiers(): Promise<SelfServeCreditTiersResponse>;
6504
+ /**
6505
+ * Get the self-serve client's pricing config (fee schedule).
6506
+ *
6507
+ * Returns the caller's current `ClientPricingConfig` — transfer/ACH/wire/SEPA/SWIFT/KYC/KYB
6508
+ * fees plus the monthly minimum. Self-serve clients only.
6509
+ *
6510
+ * @returns The current pricing configuration
6511
+ *
6512
+ * @example
6513
+ * ```typescript
6514
+ * const pricing = await client.selfServe.getPricing();
6515
+ * console.log(`ACH fee: ${pricing.achFeeCents} cents`);
6516
+ * console.log(`Wire fee: ${pricing.wireFeeCents} cents`);
6517
+ * ```
6518
+ */
6519
+ getPricing(): Promise<SelfServeCreditsPricingResponse>;
6124
6520
  }
6125
6521
 
6126
6522
  /**
@@ -6277,4 +6673,4 @@ declare class ConfigurationError extends Error {
6277
6673
  constructor(message: string);
6278
6674
  }
6279
6675
 
6280
- export { APIError, type Account, type AccountCreateRequest, type AccountListParams, type AccountUpdateRequest, AccountsResource, type Address, type AdvanceSimulationRequest, type AdvanceSimulationResult, type ApiKey, type ApiKeyCreateRequest, type ApiKeyResponse, ApiKeysResource, type Application, type ApplicationDocumentType, type ApplicationDocumentUploadRequest, type ApplicationDocumentUploadUrlRequest, type ApplicationListItem, type ApplicationStatus, type ApplicationSubmissionRequest, ApplicationsResource, type AssociatedIndividual, type AssociatedIndividualRequest, type AttestationSubmitRequest, type AttestationType, AuthMode, type AutoTransaction, AutoTransactionsResource, type AverageMonthlyRevenue, type BusinessApplicationCreateRequest, type BusinessDetailsResponse, type BusinessPurposeOfAccount, type BusinessSourceOfFunds, ConfigurationError, type Country, type CreateApiKeyForClientRequest, type CryptoDestination, type CryptoDestinationRequest, type CursorExtractor, type Customer, type CustomerCreateRequest, type CustomerCreateResponse, type CustomerListParams, CustomersResource, DEFAULT_RETRY_POLICY, DakotaClient, type DakotaClientConfig, type Destination, type DestinationRequest, DestinationsResource, type DocumentUploadResponse, type DocumentUploadUrlResponse, type EDDRequest, type EDDWithApplicationID, type EmploymentStatus, Environment, type Event, type EventListParams, type EventType, EventsResource, type ExpectedMonthlyDeposit, type Family, type FiatUSDestination, type FiatUSDestinationRequest, type IndividualDetailsResponse, type IndividualDocumentType, type IndividualDocumentUploadRequest, type IndividualDocumentUploadUrlRequest, type IndividualRequest, type IndividualRole, type IndividualTitle, InfoResource, type KSUID, type KybStatus, type LegalStructure, type ListParams, type Logger, type Meta, type Network, type NetworkId, type OfframpAccount, type OfframpAccountCreateRequest, type OneOffTransaction, type OneOffTransactionRequest, type OnrampAccount, type OnrampAccountCreateRequest, type PageFetcher, PaginatedIterator, type PaginatedResponse, type PaginationMeta, type PaginationParams, type PaymentCapability, type PersonName, PoliciesResource, type Policy, type PolicyCreateRequest, type PolicyRule, type PolicyRuleCreateRequest, type Recipient, type RecipientRequest, type RecipientUpdateRequest, RecipientsResource, type RequestOptions, type ResolvedConfig, type RetryPolicy, SandboxResource, type SandboxScenario, type SelfServeCreditTier, type SelfServeCreditTiersResponse, type SelfServeCreditsBalanceResponse, type SelfServeCreditsLedgerEntry, type SelfServeCreditsLedgerEntryType, type SelfServeCreditsLedgerParams, type SelfServeCreditsLedgerResponse, type SelfServeCreditsPurchaseRequest, type SelfServeCreditsPurchaseResponse, SelfServeResource, type Signer, type SignerCreateRequest, type SignerGroup, type SignerGroupCreateRequest, SignerGroupsResource, SignersResource, type SimulateInboundRequest, type SimulateInboundType, type SimulateOnboardingRequest, type SimulateOnboardingResponse, type SimulateOnboardingType, type SimulationCallbackRecord, type SimulationInspection, type SimulationResponse, type SubClientSummary, type SwapAccount, type SwapAccountCreateRequest, type TransactionListParams, type TransactionStatus, TransactionsResource, TransportError, type UpdateCustomerSubClientRequest, type UploadedDocumentMetadata, type User, type UserCreateRequest, type UserUpdateRequest, UsersResource, type Wallet, type WalletBalance, type WalletBalances, type WalletCreateRequest, type WalletTransaction, type WalletTransactionRequest, WalletsResource, type WebhookEvent, type WebhookHistoryList, type WebhookHistoryListParams, type WebhookHistoryResponse, type WebhookReplayResponse, type WebhookTarget, type WebhookTargetCreateRequest, type WebhookTargetUpdateRequest, WebhooksResource, consoleLogger, getEnvironmentURL, noopLogger, paginate };
6676
+ export { APIError, type Account, type AccountCreateRequest, type AccountListParams, type AccountUpdateRequest, AccountsResource, type Address, type AdvanceSimulationRequest, type AdvanceSimulationResult, type ApiKey, type ApiKeyCreateRequest, type ApiKeyResponse, ApiKeysResource, type Application, type ApplicationDocumentType, type ApplicationDocumentUploadRequest, type ApplicationDocumentUploadUrlRequest, type ApplicationListItem, type ApplicationStatus, type ApplicationSubmissionRequest, ApplicationsResource, type AssociatedIndividual, type AssociatedIndividualRequest, type AttestationSubmitRequest, type AttestationType, AuthMode, type AutoTransaction, AutoTransactionsResource, type AverageMonthlyRevenue, type BulkImportSumsubTokensRequest, type BulkImportSumsubTokensResponse, type BulkImportSumsubTokensResult, type BusinessApplicationCreateRequest, type BusinessDetailsResponse, type BusinessPurposeOfAccount, type BusinessSourceOfFunds, type ClientPricingConfig, ConfigurationError, type Country, type CreateApiKeyForClientRequest, type CryptoDestination, type CryptoDestinationRequest, type CursorExtractor, type Customer, type CustomerCreateRequest, type CustomerCreateResponse, type CustomerListParams, CustomersResource, DEFAULT_RETRY_POLICY, DakotaClient, type DakotaClientConfig, type Destination, type DestinationRequest, DestinationsResource, type DocumentUploadResponse, type DocumentUploadUrlResponse, type EDDRequest, type EDDWithApplicationID, type EmploymentStatus, Environment, type Event, type EventListParams, type EventType, EventsResource, type ExpectedMonthlyDeposit, type Family, type FiatUSDestination, type FiatUSDestinationRequest, type IndividualDetailsResponse, type IndividualDocumentType, type IndividualDocumentUploadRequest, type IndividualDocumentUploadUrlRequest, type IndividualRequest, type IndividualRole, type IndividualTitle, InfoResource, type KSUID, type KybStatus, type LegalStructure, type ListParams, type Logger, type Meta, type Network, type NetworkId, type OfframpAccount, type OfframpAccountCreateRequest, type OneOffTransaction, type OneOffTransactionRequest, type OnrampAccount, type OnrampAccountCreateRequest, type PageFetcher, PaginatedIterator, type PaginatedResponse, type PaginationMeta, type PaginationParams, type PaymentCapability, type PersonName, PoliciesResource, type Policy, type PolicyCreateRequest, type PolicyRule, type PolicyRuleCreateRequest, type Recipient, type RecipientRequest, type RecipientUpdateRequest, RecipientsResource, type RequestOptions, type ResolvedConfig, type RetryPolicy, SandboxResource, type SandboxScenario, type SelfServeCreditTier, type SelfServeCreditTiersResponse, type SelfServeCreditsBalanceResponse, type SelfServeCreditsLedgerEntry, type SelfServeCreditsLedgerEntryType, type SelfServeCreditsLedgerParams, type SelfServeCreditsLedgerResponse, type SelfServeCreditsPricingResponse, type SelfServeCreditsPurchaseRequest, type SelfServeCreditsPurchaseResponse, SelfServeResource, type Signer, type SignerCreateRequest, type SignerGroup, type SignerGroupCreateRequest, SignerGroupsResource, SignersResource, type SimulateInboundRequest, type SimulateInboundType, type SimulateOnboardingRequest, type SimulateOnboardingResponse, type SimulateOnboardingType, type SimulationCallbackRecord, type SimulationInspection, type SimulationResponse, type SubClientSummary, type SwapAccount, type SwapAccountCreateRequest, type TransactionListParams, type TransactionStatus, TransactionsResource, TransportError, type UpdateCustomerSubClientRequest, type UploadedDocumentMetadata, type User, type UserCreateRequest, type UserUpdateRequest, UsersResource, type Wallet, type WalletBalance, type WalletBalances, type WalletCreateRequest, type WalletTransaction, type WalletTransactionRequest, WalletsResource, type WebhookEvent, type WebhookHistoryList, type WebhookHistoryListParams, type WebhookHistoryResponse, type WebhookReplayResponse, type WebhookTarget, type WebhookTargetCreateRequest, type WebhookTargetUpdateRequest, WebhooksResource, consoleLogger, getEnvironmentURL, noopLogger, paginate };