@dakota-xyz/ts-sdk 2.2.1 → 3.0.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
@@ -315,12 +315,81 @@ declare abstract class BaseResource {
315
315
  constructor(transport: Transport);
316
316
  /**
317
317
  * Create a paginated iterator for a list endpoint.
318
+ *
319
+ * `inspectMeta` is called with each page's raw `meta` before the page is
320
+ * yielded, for endpoints whose meta says something the caller must act on.
321
+ * Throw from it to fail the page.
318
322
  */
319
- protected paginate<T>(path: string, params?: Record<string, unknown>, cursorExtractor?: CursorExtractor<T>): PaginatedIterator<T>;
323
+ protected paginate<T>(path: string, params?: Record<string, unknown>, cursorExtractor?: CursorExtractor<T>, inspectMeta?: (meta: Record<string, unknown> | undefined) => void): PaginatedIterator<T>;
320
324
  }
321
325
 
322
326
  type components = {
323
327
  schemas: {
328
+ readonly RDMarketingFeeStatementList: {
329
+ /**
330
+ * @description Newest first. EMPTY means the client's contract is real but no
331
+ * month has started yet (it starts next month or later) — the page
332
+ * says "starting soon" rather than denying the contract. A client
333
+ * who has never had a contract gets 404 instead, and the portal
334
+ * hides the section entirely. The two are different answers.
335
+ */
336
+ readonly months: readonly string[];
337
+ };
338
+ readonly RDMarketingFeeStatement: {
339
+ /** Format: date */
340
+ readonly month: string;
341
+ /**
342
+ * Format: double
343
+ * @description The rate in force for THIS month, in monthly basis points. A later rate change does not rewrite it.
344
+ */
345
+ readonly y_bps_monthly: number;
346
+ /**
347
+ * @description What the month owes this client, RD minor units. ABSENT until the
348
+ * month is priced — never zero, which would state that nothing is
349
+ * owed.
350
+ */
351
+ readonly owed_minor?: string;
352
+ /** @description The mean of the month's stored daily principals. Absent while the month is incomplete. */
353
+ readonly avg_daily_balance_minor?: string;
354
+ /** @description Calendar days in the month — the divisor, never the number of rows stored. */
355
+ readonly days_in_month: number;
356
+ /**
357
+ * @description Days whose principal is stored. Lower than days_in_month while the
358
+ * month is still being derived or still running, which is how a
359
+ * partial month is shown as partial rather than as a complete small
360
+ * one.
361
+ */
362
+ readonly days_stamped: number;
363
+ readonly daily: readonly components["schemas"]["RDMarketingFeeDailyRow"][];
364
+ };
365
+ readonly RDMarketingFeeDailyRow: {
366
+ /** Format: date */
367
+ readonly date: string;
368
+ /**
369
+ * @description The client's stored daily principal for that day, minor units, as a
370
+ * decimal string. This is read, never recomputed: it is the same
371
+ * figure the month was priced on, so what is shown and what was paid
372
+ * cannot drift.
373
+ *
374
+ * Every calendar day of the month gets a row. ABSENT means the day is
375
+ * not stamped yet — a repairable gap, resolved by the derivation on
376
+ * its own. A present "0" means the client genuinely held no RD that
377
+ * day. The two are different facts and must not render alike.
378
+ */
379
+ readonly balance_minor?: string;
380
+ /**
381
+ * @description That day's share of the month's fee, minor units, as a decimal
382
+ * string. These decompose the snapshot's owed proportionally by
383
+ * balance and sum to exactly that total.
384
+ *
385
+ * ABSENT for every day of a month that has not been priced. The fee
386
+ * is a property of the month, not of the day, so it is unknown for
387
+ * all days at once until the month's Dakota rate is derived. A zero
388
+ * here would state that nothing is owed, which is a different claim
389
+ * from "not yet known".
390
+ */
391
+ readonly fee_minor?: string;
392
+ };
324
393
  readonly AgenticActionDownstream: {
325
394
  readonly recipient_id?: string;
326
395
  readonly destination_id?: string;
@@ -534,29 +603,22 @@ type components = {
534
603
  /** @description Advisory recommendations (always present, possibly empty). Non-binding — acting on one is a separate, human-gated step. */
535
604
  readonly suggestions: readonly components["schemas"]["InsightItem"][];
536
605
  };
537
- readonly InsightChatMessage: {
538
- /** @enum {string} */
539
- readonly role: "user" | "assistant";
540
- readonly content: string;
541
- };
542
- readonly InsightChatRequest: {
543
- /** @description The conversation so far, oldest first. */
544
- readonly messages: readonly components["schemas"]["InsightChatMessage"][];
545
- };
546
- readonly InsightChatResponse: {
547
- /** @description The assistant's plain-text answer. Advisory only — the assistant cannot execute anything. */
548
- readonly reply: string;
549
- /**
550
- * @description How the boundary screen treated this turn. `ok` is a normal turn; `warned` means the request was off-topic and the customer was warned but may continue; `blocked` means the conversation has been terminated (repeated off-topic turns or a manipulation attempt) — the client should stop serving it and offer a fresh chat.
551
- * @enum {string}
552
- */
553
- readonly conversation_status?: "ok" | "warned" | "blocked";
554
- };
555
606
  readonly CreateScheduledPaymentsAction: {
556
607
  readonly destination_id?: string;
557
608
  /** @description The funding wallet for these payments — one the agent recognizes. Optional only when the agent recognizes exactly one wallet (used by default); otherwise required, since a signer can recognize several and the choice cannot be deferred to fire time. Its chain family must match the payment network. */
558
609
  readonly wallet_id?: string;
610
+ /** @description Decimal string. What this MEANS depends on `amount_includes_fee` below: by default it is what the PAYEE RECEIVES, and the server grosses it up so the fee comes out on top. */
559
611
  readonly amount: string;
612
+ /**
613
+ * @description Whose side of the conversion fee `amount` is on.
614
+ *
615
+ * Absent or `false` (the DEFAULT): `amount` is what the payee RECEIVES. The server adds the fee on top, so slightly more leaves the funding wallet. This is what "pay Bruno 10 USDC" means to a person, and it matches the same payment made through a client's own form.
616
+ *
617
+ * `true`: `amount` is what LEAVES the wallet, and the payee receives less the fee. Use it only when the customer says so — "send 10 in total", "including the fee".
618
+ *
619
+ * The gross-up is done SERVER-SIDE from the fee on the request; the agent never computes it, so it can neither get the arithmetic wrong nor be talked out of the fee. With no fee configured the two are identical.
620
+ */
621
+ readonly amount_includes_fee?: boolean;
560
622
  readonly asset: string;
561
623
  /**
562
624
  * @description The chain THIS payment settles on. The network belongs to the payment, not to the payee: an address belongs to a whole family, so which chain a given payment uses is chosen when the payment is made. Optional — the destination's own network is used when omitted. When the destination pins a DIFFERENT one in the same family, this payment's network wins (the pin records what an earlier payment did, not a restriction on the address). Across chain FAMILIES the address does not carry at all, and that is refused.
@@ -652,7 +714,6 @@ type components = {
652
714
  readonly offramp_bps?: number;
653
715
  };
654
716
  readonly CreateInstructionsRequest: {
655
- readonly client_policy?: components["schemas"]["AgenticClientPolicy"];
656
717
  readonly payment_agent_id: string;
657
718
  readonly proposals: readonly components["schemas"]["AgenticProposal"][];
658
719
  readonly developer_fee?: components["schemas"]["DeveloperFee"];
@@ -668,12 +729,12 @@ type components = {
668
729
  readonly prompt?: string;
669
730
  /** @description The conversation so far, oldest first. */
670
731
  readonly messages?: readonly components["schemas"]["AgenticChatMessage"][];
732
+ readonly developer_fee?: components["schemas"]["DeveloperFee"];
671
733
  /**
672
734
  * @description The customer's IANA timezone (e.g. "America/Los_Angeles"). When present, the agent resolves every relative date ("tomorrow", "Friday") and clock time ("10 am") in THIS timezone; a date without a time is drafted for the first working hours of the local day (10:00) and the draft summary states the resolved local time; a time without a date means its next local occurrence. Absent or unrecognized ⇒ times resolve as UTC and the agent says so when a specific clock time matters. Send it on EVERY turn — the server is stateless. Note: the zone's UTC offset is captured at drafting time, so a DST transition before a far-future fire date shifts the fire time by the DST delta.
673
735
  * @example America/Los_Angeles
674
736
  */
675
737
  readonly timezone?: string;
676
- readonly client_policy?: components["schemas"]["AgenticClientPolicy"];
677
738
  };
678
739
  /**
679
740
  * @description ALPHA — how THIS client's product speaks, and what the agent may propose for it. It reshapes what the drafting model SEES (tool results, tool descriptions, prompt sections) and constrains what it may PROPOSE, so the agent narrates in the client's own nouns instead of platform ones.
@@ -958,7 +1019,9 @@ type components = {
958
1019
  readonly mandate_version?: number;
959
1020
  /** @description AUDIT — the money-path transaction created when this payment fired. Absent until the payment executes. */
960
1021
  readonly wallet_transaction_id?: string;
1022
+ /** @description What LEAVES the funding wallet, denominated in `asset` on `network_id`. For a DIRECT payment that is also what the payee receives. For a CONVERTED payment (the payee settles on a different asset or chain) it is the DEPOSIT into the conversion account, grossed up so the payee nets the requested figure — so it is LARGER than the payout and in a DIFFERENT asset. Never render it against `output_asset`. */
961
1023
  readonly amount?: string;
1024
+ /** @description The asset `amount` is denominated in — the asset that LEAVES the wallet. For a converted payment this is the deposit asset, not the one the payee receives (see `output_asset`). */
962
1025
  readonly asset?: string;
963
1026
  /** @description Why the payment failed (e.g. the mandate gate's denied dimensions); absent unless status is failed. */
964
1027
  readonly failure_reason?: string;
@@ -975,7 +1038,7 @@ type components = {
975
1038
  readonly destination_label?: string;
976
1039
  /** @description For a `bank` destination, the payout rail (e.g. ach, fedwire, swift). Absent for crypto. */
977
1040
  readonly destination_rail?: string;
978
- /** @description The asset the recipient ULTIMATELY receives. For an offramp this is the fiat currency (e.g. USD) the deposit converts to; for a direct crypto payment it equals `asset`. Stablecoin conversion is 1:1, so the output AMOUNT equals `amount`. */
1041
+ /** @description The asset the recipient ULTIMATELY receives. For an offramp this is the fiat currency (e.g. USD) the deposit converts to; for a direct crypto payment it equals `asset`. DO NOT PAIR THIS WITH `amount`: for a converted payment `amount` is the DEPOSIT — what leaves the wallet, in the deposit's own asset — and it is grossed up so the payee nets the requested figure, so a real payment reads amount 0.211112 and pays out 0.19. The rate is 1:1; the fee is not. This response carries no output amount, so a converted payment's payout figure is not available here. */
979
1042
  readonly output_asset?: string;
980
1043
  /** @description For a crypto destination, the network the recipient ULTIMATELY receives on — for a cross-family swap this differs from `network_id` (the DEPOSIT network the wallet pays), e.g. output_network solana-devnet while network_id is base-sepolia. Equals `network_id` for a direct crypto payment; absent for a bank offramp (fiat has no network). */
981
1044
  readonly output_network?: string;
@@ -1165,19 +1228,70 @@ type components = {
1165
1228
  * @example 9000000
1166
1229
  */
1167
1230
  readonly transfer_capacity_cents: number;
1231
+ /**
1232
+ * @description Server-owned balance health. Computed live from the same snapshot as
1233
+ * `percent_remaining`, so the two can never disagree. Clients MUST
1234
+ * render this rather than deriving bands themselves; treat an
1235
+ * unrecognised value as `healthy`.
1236
+ * @example healthy
1237
+ * @enum {string}
1238
+ */
1239
+ readonly health?: "healthy" | "low" | "critical" | "empty";
1240
+ /**
1241
+ * Format: int64
1242
+ * @description Denominator for `percent_remaining`: the balance at the client's most
1243
+ * recent deliberate top-up, ratcheted upward by any incidental credit
1244
+ * since. `0` means *no baseline* and must never be used as a divisor.
1245
+ * @example 100000
1246
+ */
1247
+ readonly balance_baseline_cents?: number;
1248
+ /**
1249
+ * @description `balance_cents` as a whole percentage of `balance_baseline_cents`,
1250
+ * floored. Omitted when `balance_baseline_cents` is 0.
1251
+ * @example 45
1252
+ */
1253
+ readonly percent_remaining?: number;
1254
+ /**
1255
+ * Format: int64
1256
+ * @description Transfer volume at which health becomes `low` — the capacity of the
1257
+ * largest balance that still classifies `low`. Omitted when
1258
+ * `balance_baseline_cents` is 0.
1259
+ * @example 8000000
1260
+ */
1261
+ readonly low_at_transfer_capacity_cents?: number;
1262
+ /**
1263
+ * Format: int64
1264
+ * @description Cheapest total fee any configured rail can charge. Below this, rail
1265
+ * transfers are held.
1266
+ * @example 51
1267
+ */
1268
+ readonly min_next_transfer_fee_cents?: number;
1269
+ /**
1270
+ * Format: float
1271
+ * @description The client's transfer fee rate, so callers stop hardcoding 0.25%.
1272
+ * @example 25
1273
+ */
1274
+ readonly transfer_fee_bps?: number;
1168
1275
  };
1169
1276
  readonly SelfServeCreditsLedgerEntry: {
1170
1277
  /** @example 34o8dS2h9c7n1V8qLpY2Zx6TwUa */
1171
1278
  readonly id: string;
1172
- /** @enum {string} */
1173
- readonly entry_type: "purchase" | "deduction" | "refund";
1279
+ /**
1280
+ * @description `bonus` is a promotional grant written alongside a bulk-tier
1281
+ * `purchase` row in the same transaction; its `amount_cents` is the
1282
+ * bonus only and it carries no Stripe session id. `adjustment` has been
1283
+ * emitted since the adjustment entry type shipped and was missing from
1284
+ * this enum.
1285
+ * @enum {string}
1286
+ */
1287
+ readonly entry_type: "purchase" | "bonus" | "deduction" | "refund" | "adjustment";
1174
1288
  /**
1175
1289
  * @description Sub-category that distinguishes transaction fees from compliance
1176
1290
  * fees and similar for refunds. `unknown` indicates a legacy row
1177
1291
  * written before this column existed.
1178
1292
  * @enum {string}
1179
1293
  */
1180
- readonly category: "transaction_fee" | "compliance_fee" | "transaction_refund" | "compliance_refund" | "purchase" | "adjustment" | "unknown";
1294
+ readonly category: "transaction_fee" | "compliance_fee" | "transaction_refund" | "compliance_refund" | "purchase" | "bonus" | "adjustment" | "unknown";
1181
1295
  /**
1182
1296
  * Format: int64
1183
1297
  * @example -5000
@@ -1207,12 +1321,39 @@ type components = {
1207
1321
  readonly SelfServeCreditTier: {
1208
1322
  /**
1209
1323
  * Format: int64
1210
- * @example 10000
1324
+ * @description Amount charged via Stripe Checkout, in USD cents.
1325
+ * @example 3600000
1211
1326
  */
1212
1327
  readonly price_cents: number;
1213
1328
  /**
1214
1329
  * Format: int64
1215
- * @example 2000000
1330
+ * @description Total credit balance granted for this tier, in USD cents of transfer
1331
+ * fee. Equal to `price_cents` for standard tiers; larger for bulk
1332
+ * tiers, where the difference is `bonus_cents`.
1333
+ * @example 6000000
1334
+ */
1335
+ readonly credit_cents?: number;
1336
+ /**
1337
+ * Format: int64
1338
+ * @description Promotional credit granted on top of `price_cents`, i.e.
1339
+ * `credit_cents - price_cents`. `0` for standard tiers.
1340
+ * @example 2400000
1341
+ */
1342
+ readonly bonus_cents?: number;
1343
+ /**
1344
+ * Format: float
1345
+ * @description Blended rate this tier delivers, rounded to two decimals:
1346
+ * `transfer_fee_bps * price_cents / credit_cents`. Credits are still
1347
+ * consumed at the client's `transfer_fee_bps`; the discount is
1348
+ * delivered entirely as `bonus_cents` at purchase time.
1349
+ * @example 15
1350
+ */
1351
+ readonly effective_fee_bps?: number;
1352
+ /**
1353
+ * Format: int64
1354
+ * @description Transfer volume `credit_cents` buys at the client's `transfer_fee_bps`,
1355
+ * floored. Banking and compliance fees are charged on top and reduce it.
1356
+ * @example 2400000000
1216
1357
  */
1217
1358
  readonly transfer_capacity_cents: number;
1218
1359
  };
@@ -1337,6 +1478,35 @@ type components = {
1337
1478
  * @example 2024-01-01T00:00:00Z
1338
1479
  */
1339
1480
  readonly updatedAt: string;
1481
+ /**
1482
+ * @description Per-asset-pair transfer fee exceptions. Always present; empty
1483
+ * when the client has none, in which case transferFeeBps applies
1484
+ * to every pair.
1485
+ */
1486
+ readonly transferFeeOverrides: readonly components["schemas"]["TransferFeeOverride"][];
1487
+ };
1488
+ /**
1489
+ * @description Overrides transferFeeBps for exactly one (sourceAsset,
1490
+ * destinationAsset) pair. Assets are network-agnostic symbols: USDC on
1491
+ * any chain is the same key.
1492
+ */
1493
+ readonly TransferFeeOverride: {
1494
+ /**
1495
+ * @description Asset symbol the transfer moves from, network-agnostic.
1496
+ * @example USDT
1497
+ */
1498
+ readonly sourceAsset: string;
1499
+ /**
1500
+ * @description Asset symbol the transfer moves to, network-agnostic.
1501
+ * @example RD
1502
+ */
1503
+ readonly destinationAsset: string;
1504
+ /**
1505
+ * Format: float
1506
+ * @description Transfer fee in basis points for this pair. Whole numbers only.
1507
+ * @example 5
1508
+ */
1509
+ readonly feeBps: number;
1340
1510
  };
1341
1511
  /** @description Request body for creating a new client user */
1342
1512
  readonly CreateClientUserRequest: {
@@ -1396,6 +1566,37 @@ type components = {
1396
1566
  */
1397
1567
  readonly has_more_before: boolean;
1398
1568
  };
1569
+ /** @description Reviewer-selected resubmission scope for an RFI. */
1570
+ readonly RFIRequestedItems: {
1571
+ /** @description Whether the applicant may edit the business description on the resubmit page. */
1572
+ readonly business_description?: boolean;
1573
+ readonly documents?: readonly {
1574
+ /** @enum {string} */
1575
+ readonly category: "business" | "individual" | "edd";
1576
+ /** @description Entity id for individual docs; empty for business/edd. */
1577
+ readonly individual_id?: string;
1578
+ /** @description document_id|document_type for an on-file doc, or purpose for a missing doc. */
1579
+ readonly ref: string;
1580
+ }[];
1581
+ /**
1582
+ * @description Free-text compliance questions the reviewer is asking. Rendered on
1583
+ * the resubmit page as required answer fields, tracked separately from
1584
+ * the standard application questions.
1585
+ */
1586
+ readonly questions?: readonly {
1587
+ /** @description Stable identifier for this question; generated if omitted. Used to store the applicant's answer. */
1588
+ readonly key?: string;
1589
+ /** @description The free-text question the reviewer is asking the applicant. */
1590
+ readonly prompt: string;
1591
+ /** @description Whether the applicant must also attach a document when answering this question. */
1592
+ readonly require_document?: boolean;
1593
+ }[];
1594
+ };
1595
+ /** @description Meta information about a transaction list response. Extends the shared pagination meta with the transaction resource family the request resolved to, so an empty page is self-explaining. */
1596
+ readonly TransactionListMeta: components["schemas"]["Meta"] & {
1597
+ /** @description The transaction resource family this response lists. Either the `transaction_type` that was requested, or the family inferred from the other query parameters. `total_count` counts only this family. */
1598
+ readonly transaction_type: components["schemas"]["TransactionResourceType"];
1599
+ };
1399
1600
  readonly PersonaImportJobSummary: {
1400
1601
  readonly job_id?: string;
1401
1602
  /** @description running, paused, cancelled, or completed */
@@ -1423,6 +1624,66 @@ type components = {
1423
1624
  /** Format: int64 */
1424
1625
  readonly token_expires_at?: number;
1425
1626
  };
1627
+ /**
1628
+ * Legal Document
1629
+ * @description One published revision of a legal document.
1630
+ *
1631
+ * A revision is IMMUTABLE: `version` identifies an exact text, and that
1632
+ * text never changes once published. Correcting a document produces a new
1633
+ * revision rather than editing an existing one, so an acceptance recorded
1634
+ * against a version always refers to the same words.
1635
+ */
1636
+ readonly LegalDocument: {
1637
+ /**
1638
+ * @description Stable identifier for the document across all its revisions.
1639
+ * @example dakota_tos
1640
+ */
1641
+ readonly key: string;
1642
+ /**
1643
+ * @description The published revision identifier, taken from the document itself.
1644
+ * Treat it as opaque — do not parse or compare it for ordering.
1645
+ * @example 2026-07-23
1646
+ */
1647
+ readonly version: string;
1648
+ /**
1649
+ * @description Monotonic ordinal within `key`. Unlike `version`, this is ordered:
1650
+ * a higher number is a later revision.
1651
+ * @example 4
1652
+ */
1653
+ readonly revision: number;
1654
+ /** @example Dakota Terms of Service */
1655
+ readonly title?: string;
1656
+ /**
1657
+ * @description The document text, in `content_type` format. Render this to your
1658
+ * customer before capturing acceptance.
1659
+ *
1660
+ * Present when a single document is fetched by key. OMITTED from the
1661
+ * `GET /legal/documents` index, which carries identity and revision
1662
+ * only — fetch the document you intend to display.
1663
+ * @example This Platform Services Agreement (the "Agreement")…
1664
+ */
1665
+ readonly content?: string;
1666
+ /**
1667
+ * @description Media type of `content`.
1668
+ * @default text/markdown
1669
+ * @example text/markdown
1670
+ */
1671
+ readonly content_type: string;
1672
+ /**
1673
+ * @description Where the document is published for humans to read.
1674
+ * @example https://dakota.xyz/terms
1675
+ */
1676
+ readonly content_url?: string;
1677
+ /**
1678
+ * @description The date printed inside the document — what the customer reads as
1679
+ * "Last Updated". Show this alongside the text.
1680
+ *
1681
+ * Absent for imported historical revisions whose stated date could not
1682
+ * be established.
1683
+ * @example 2026-07-23
1684
+ */
1685
+ readonly effective_date?: string;
1686
+ };
1426
1687
  /**
1427
1688
  * @description Error response following RFC 9457 Problem Details.
1428
1689
  * Public API error responses use this format.
@@ -1471,6 +1732,30 @@ type components = {
1471
1732
  readonly request_id?: string;
1472
1733
  /** @description Field-level validation errors (present for validation failures). */
1473
1734
  readonly errors?: readonly components["schemas"]["ValidationError"][];
1735
+ /**
1736
+ * Format: uri
1737
+ * @description A link the customer can follow to CLEAR this error, present only on
1738
+ * problems with a concrete self-service remedy.
1739
+ *
1740
+ * Today this is returned by
1741
+ * `#terms-not-accepted`, where it points at the hosted flow in which
1742
+ * the outstanding agreement can be signed. The link is token-gated and
1743
+ * usable as-is — send the customer to it directly rather than parsing
1744
+ * it out of `detail`.
1745
+ * @example https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c
1746
+ */
1747
+ readonly resolution_url?: string;
1748
+ /**
1749
+ * @description A plain-language rendition of `detail` written for the end
1750
+ * customer, present when one exists for this error. `detail` names
1751
+ * request fields and actions so a machine caller (such as a payment
1752
+ * agent drafting proposals) can self-correct; `user_message` says the
1753
+ * same thing without API vocabulary. Clients that relay errors into a
1754
+ * human surface (chat, email, UI) should show `user_message` when
1755
+ * present and fall back to `detail`.
1756
+ * @example ACH payments pay out USD, so a USDC payout isn't possible on this rail. Change the payout currency to USD and try again.
1757
+ */
1758
+ readonly user_message?: string;
1474
1759
  };
1475
1760
  readonly ValidationError: {
1476
1761
  /**
@@ -1695,7 +1980,7 @@ type components = {
1695
1980
  readonly application_url: string;
1696
1981
  /**
1697
1982
  * Format: int64
1698
- * @description Unix timestamp (nanoseconds) when the application token expires (30 days from creation)
1983
+ * @description Unix timestamp (nanoseconds) when the application token expires (90 days from creation)
1699
1984
  * @example 1734567890000000000
1700
1985
  */
1701
1986
  readonly application_expires_at: number;
@@ -1793,6 +2078,36 @@ type components = {
1793
2078
  */
1794
2079
  readonly severity: "required" | "requested";
1795
2080
  };
2081
+ /**
2082
+ * @description The single client-facing customer status. One value collapses the
2083
+ * frozen state, the application decision, and the application lifecycle,
2084
+ * so the dashboard shows, filters, and counts by one status. See the
2085
+ * `status` field on `Customer` for the derivation precedence.
2086
+ * @example info_requested
2087
+ * @enum {string}
2088
+ */
2089
+ readonly CustomerStatus: "frozen" | "declined" | "withdrawn" | "approved" | "info_requested" | "submitted" | "pending";
2090
+ /**
2091
+ * @description Count of customers per unified `CustomerStatus`, for the dashboard's
2092
+ * status header. Every field is optional; a status absent from the object
2093
+ * has a count of zero.
2094
+ */
2095
+ readonly CustomerStatusCounts: {
2096
+ /** @example 2 */
2097
+ readonly frozen?: number;
2098
+ /** @example 4 */
2099
+ readonly declined?: number;
2100
+ /** @example 1 */
2101
+ readonly withdrawn?: number;
2102
+ /** @example 128 */
2103
+ readonly approved?: number;
2104
+ /** @example 7 */
2105
+ readonly info_requested?: number;
2106
+ /** @example 12 */
2107
+ readonly submitted?: number;
2108
+ /** @example 9 */
2109
+ readonly pending?: number;
2110
+ };
1796
2111
  /** @description Response containing the current status of a KYB verification process including provider-specific statuses. */
1797
2112
  readonly Customer: {
1798
2113
  readonly id: components["schemas"]["KSUID"];
@@ -1884,10 +2199,54 @@ type components = {
1884
2199
  */
1885
2200
  readonly decision?: "approved" | "declined" | "auto_declined" | "withdrawn";
1886
2201
  /**
1887
- * @description URL for accessing the onboarding application
2202
+ * @description Why the application was decided. Populated for withdrawn/declined
2203
+ * applications — for example, the fixed reason recorded when an
2204
+ * applicant withdraws from an RFI resubmission email. Omitted when there
2205
+ * is no decision or no reason was recorded.
2206
+ * @example User withdrew the application from the request-for-information (RFI) email
2207
+ */
2208
+ readonly decision_reason?: string;
2209
+ /**
2210
+ * @description The single client-facing status for this customer, derived
2211
+ * server-side. It collapses three signals into one badge so a client
2212
+ * never has to reconcile `kyb_status`, `kyc_status`, and
2213
+ * `application_status` by hand.
2214
+ *
2215
+ * **Precedence (first match wins):**
2216
+ * 1. `frozen` — the customer has an open freeze; surfaced over a stale
2217
+ * approval so an actionable freeze is never masked.
2218
+ * 2. the most-recent application's decision — `approved`, `declined`
2219
+ * (declined or auto_declined), or `withdrawn`.
2220
+ * 3. the most-recent application's lifecycle — `info_requested` when a
2221
+ * request for information is open (the customer owes a response);
2222
+ * the internal in-review states collapse to `submitted`; `pending`
2223
+ * otherwise.
2224
+ * 4. `pending` when the customer has no application yet.
2225
+ *
2226
+ * Once a customer is `approved` / `declined` / `withdrawn`, that is the
2227
+ * final answer and `kyb_status` / `kyc_status` do not change it. Use
2228
+ * those fields only for the underlying breakdown.
2229
+ */
2230
+ readonly status?: components["schemas"]["CustomerStatus"];
2231
+ /**
2232
+ * @description URL for accessing the onboarding application. Always present when the
2233
+ * customer has an onboarding application, including during an open RFI
2234
+ * loop. In an RFI loop the additive `resubmit_url` is returned as well,
2235
+ * and the dashboard links to that resubmission page rather than this
2236
+ * plain application view.
1888
2237
  * @example https://onboarding.example.com/applications/abc123?token=xyz789
1889
2238
  */
1890
2239
  readonly application_url?: string;
2240
+ /**
2241
+ * @description The resubmission link for a customer in an open RFI loop — the exact
2242
+ * `/applications/{id}/resubmit?token=…` URL the applicant receives in
2243
+ * the RFI email, built from the customer's existing onboarding token
2244
+ * (no new token is minted on read). Present only when `status` is
2245
+ * `info_requested`, and returned alongside `application_url` rather than
2246
+ * in place of it.
2247
+ * @example https://onboarding.example.com/applications/abc123/resubmit?token=xyz789
2248
+ */
2249
+ readonly resubmit_url?: string;
1891
2250
  /**
1892
2251
  * @description Timestamp of when the link was created
1893
2252
  * @example 1234567890
@@ -2073,7 +2432,11 @@ type components = {
2073
2432
  readonly TransactionResourceType: "one_off" | "wallet" | "auto_account";
2074
2433
  /**
2075
2434
  * Capabilities
2076
- * @description List of payment capabilities supported by a rail. Currently, as input, you can only request one in this list. This constraint will be loosened in the future.
2435
+ * @description List of payment capabilities supported by a rail. Multiple values may
2436
+ * be supplied; the list is not limited to one entry. Which values are
2437
+ * valid depends on the resource: on-ramp accounts accept any rail and
2438
+ * expand `us_bank_account` to `ach` and `fedwire`; IBAN destinations
2439
+ * accept `swift` and `sepa` only.
2077
2440
  * @example [
2078
2441
  * "ach",
2079
2442
  * "fedwire"
@@ -2090,6 +2453,43 @@ type components = {
2090
2453
  /**
2091
2454
  * Account Create Request
2092
2455
  * @description Unified account create request for onramp/offramp/swap.
2456
+ *
2457
+ * One schema serves all three account types, so its properties are the
2458
+ * UNION of the three shapes: `account_type` decides which of them are
2459
+ * read. `account_type` is therefore the only field this schema can mark
2460
+ * required — everything else is required *per type*, and that contract is
2461
+ * this table:
2462
+ *
2463
+ * | Field | `onramp` | `offramp` | `swap` |
2464
+ * | --- | --- | --- | --- |
2465
+ * | `capabilities` | **required** | ignored | ignored |
2466
+ * | `rail` | optional | **required** | ignored |
2467
+ * | `crypto_destination_id` | **required** | ignored | **required** |
2468
+ * | `fiat_destination_id` | ignored | **required** | ignored |
2469
+ * | `destination_network_id` | **required** | ignored | **required** |
2470
+ * | `source_network_id` | ignored | **required** | **required** |
2471
+ * | `source_asset` | **required** | **required** | **required** |
2472
+ * | `destination_asset` | **required** | **required** | **required** |
2473
+ * | `payment_reference` | rejected | optional | rejected |
2474
+ * | `return_address` | ignored | optional | ignored |
2475
+ * | `return_crypto_address` | ignored | ignored | optional |
2476
+ *
2477
+ * "Ignored" means the field is accepted and has no effect — sending it
2478
+ * does not create the routing it names, so do not rely on it. The one
2479
+ * exception is `payment_reference`, which is REJECTED rather than ignored
2480
+ * on the types that cannot deliver it (see that field).
2481
+ *
2482
+ * `rail` on an `onramp` is optional because the account's inbound rails
2483
+ * come from `capabilities`. `swift` and `sepa` must appear in
2484
+ * `capabilities` and narrow the account to that rail. `ach`, `fedwire`
2485
+ * and `fednow` must also appear in `capabilities`, but all resolve to
2486
+ * `us_bank_account` — the same result as omitting `rail` when the
2487
+ * capabilities include a US rail. `us_bank_account` itself is accepted
2488
+ * as `rail` regardless of the capabilities list.
2489
+ *
2490
+ * A required field that you omit returns `400` (`invalid-request` or
2491
+ * `invalid-identifier`, depending on the field), with a `detail` that
2492
+ * identifies the problem.
2093
2493
  */
2094
2494
  readonly AccountCreateRequest: {
2095
2495
  readonly account_type: components["schemas"]["AccountType"];
@@ -2323,6 +2723,11 @@ type components = {
2323
2723
  * @example +12345678900
2324
2724
  */
2325
2725
  readonly bank_phone?: string;
2726
+ /**
2727
+ * @description Deposit attribution reference. When present, include it in the reference/memo field of any payment sent to this account, so the arriving funds can be matched to it. It is required whenever the deposit instructions above point at an account shared with other customers, where the account number alone does not identify the depositor. Null when the provider does not require one — the funds are then attributed by the account details alone. This is inbound and provider-issued, unlike the account-level `payment_reference` on an account create request, which is a memo carried on the payments this account sends OUT.
2728
+ * @example PRIFWEW6DDH
2729
+ */
2730
+ readonly payment_reference?: string | null;
2326
2731
  };
2327
2732
  /**
2328
2733
  * Destination Request Union
@@ -2747,8 +3152,10 @@ type components = {
2747
3152
  readonly sender_details?: components["schemas"]["SenderDetails"];
2748
3153
  };
2749
3154
  readonly TransactionResource: components["schemas"]["OneOffTransaction"] | components["schemas"]["WalletTransaction"] | components["schemas"]["Transaction"];
2750
- readonly PaginatedCustomerTransactionResponse: components["schemas"]["PaginatedListResponse"] & {
2751
- readonly data?: readonly components["schemas"]["Transaction"][];
3155
+ /** @description Wrapper for a paginated list of auto-account transactions. */
3156
+ readonly PaginatedCustomerTransactionResponse: {
3157
+ readonly data: readonly components["schemas"]["Transaction"][];
3158
+ readonly meta: components["schemas"]["TransactionListMeta"];
2752
3159
  };
2753
3160
  readonly PaginatedTransactionResourceResponse: components["schemas"]["PaginatedOneOffTransactionResponse"] | components["schemas"]["PaginatedCustomerTransactionResponse"] | components["schemas"]["PaginatedWalletTransactionResponse"];
2754
3161
  /** @description An amount of money with its asset. */
@@ -3057,6 +3464,11 @@ type components = {
3057
3464
  * @example 1234567890
3058
3465
  */
3059
3466
  readonly return_deadline?: number;
3467
+ /**
3468
+ * @description Decimal amount actually recovered when a returned transaction settled short, denominated in the transaction's own currency (the same basis as its face amount), so face amount minus this value is exactly what the bank withheld. Present only when a return came back short — absent when the full amount was recovered, or when the rail reports no net figure at all (ACH never does). Absent means the face amount is authoritative; it never means zero.
3469
+ * @example 24955
3470
+ */
3471
+ readonly net_recovered_amount?: string | null;
3060
3472
  /**
3061
3473
  * @description Lead Bank ACH reversal reason when the originator reverses the transaction (e.g., duplicate, receiver_incorrect).
3062
3474
  * @example duplicate
@@ -3311,6 +3723,11 @@ type components = {
3311
3723
  * @example 1234567890
3312
3724
  */
3313
3725
  readonly return_deadline?: number;
3726
+ /**
3727
+ * @description Decimal amount actually recovered when a returned transaction settled short, denominated in the transaction's own currency (the same basis as its face amount), so face amount minus this value is exactly what the bank withheld. Present only when a return came back short — absent when the full amount was recovered, or when the rail reports no net figure at all (ACH never does). Absent means the face amount is authoritative; it never means zero.
3728
+ * @example 24955
3729
+ */
3730
+ readonly net_recovered_amount?: string | null;
3314
3731
  /**
3315
3732
  * @description Lead Bank ACH reversal reason when the originator reverses the transaction (e.g., duplicate, receiver_incorrect).
3316
3733
  * @example duplicate
@@ -3333,11 +3750,15 @@ type components = {
3333
3750
  * @enum {string}
3334
3751
  */
3335
3752
  readonly OneOffTransactionStatus: "pending" | "processing" | "completed" | "failed" | "cancelled" | "reversed" | "pending_return" | "returned" | "pending_reversal";
3336
- readonly PaginatedOneOffTransactionResponse: components["schemas"]["PaginatedListResponse"] & {
3337
- readonly data?: readonly components["schemas"]["OneOffTransaction"][];
3753
+ /** @description Wrapper for a paginated list of one-off transactions. */
3754
+ readonly PaginatedOneOffTransactionResponse: {
3755
+ readonly data: readonly components["schemas"]["OneOffTransaction"][];
3756
+ readonly meta: components["schemas"]["TransactionListMeta"];
3338
3757
  };
3339
- readonly PaginatedWalletTransactionResponse: components["schemas"]["PaginatedListResponse"] & {
3340
- readonly data?: readonly components["schemas"]["WalletTransaction"][];
3758
+ /** @description Wrapper for a paginated list of wallet transactions. */
3759
+ readonly PaginatedWalletTransactionResponse: {
3760
+ readonly data: readonly components["schemas"]["WalletTransaction"][];
3761
+ readonly meta: components["schemas"]["TransactionListMeta"];
3341
3762
  };
3342
3763
  /** @description Non-custodial wallet managed by Dakota Platform with a single address usable across networks within the same family. */
3343
3764
  readonly Wallet: {
@@ -3524,7 +3945,12 @@ type components = {
3524
3945
  readonly SignerGroupCreateRequest: {
3525
3946
  /** @description Name of the signer group */
3526
3947
  readonly name: string;
3527
- /** @description Public keys of the members that make up the signer group */
3948
+ /**
3949
+ * @description Public keys of the members that make up the signer group. At most
3950
+ * 64 keys: each key is parsed and checked against the platform's
3951
+ * managed signing identities before the group is created, so an
3952
+ * unbounded list would let one request drive unbounded work.
3953
+ */
3528
3954
  readonly member_keys: readonly string[];
3529
3955
  };
3530
3956
  readonly Policy: {
@@ -3592,10 +4018,21 @@ type components = {
3592
4018
  */
3593
4019
  readonly action: "allow" | "deny";
3594
4020
  /**
3595
- * @description Rule-specific configuration as JSON
4021
+ * @description Rule-specific configuration. The keys present depend on `rule_type`.
4022
+ * - `amount_threshold`: `min_amount` (integer), `threshold` (integer),
4023
+ * and `asset` (object) carrying `id`, the asset symbol, stored
4024
+ * upper case; `name` appears only when the rule was created with
4025
+ * one. `min_amount` is in the asset's smallest unit, and
4026
+ * `threshold` is the number of authorized endorsements required.
4027
+ * - `approval_threshold`: `threshold` (integer) and, when one was set,
4028
+ * `description` (string).
4029
+ * - `address_list`: `addresses` (array of strings).
3596
4030
  * @example {
3597
- * "min_amount": 0,
3598
- * "threshold": 1000000
4031
+ * "min_amount": 10000000000,
4032
+ * "threshold": 2,
4033
+ * "asset": {
4034
+ * "id": "USDC"
4035
+ * }
3599
4036
  * }
3600
4037
  */
3601
4038
  readonly definition: Record<string, never>;
@@ -3638,10 +4075,36 @@ type components = {
3638
4075
  */
3639
4076
  readonly action: "allow" | "deny";
3640
4077
  /**
3641
- * @description Rule-specific configuration as JSON
4078
+ * @description Rule-specific configuration. When a policy is created or a rule is
4079
+ * added, the accepted keys depend on `rule_type`. A key that is not
4080
+ * listed below is rejected with `400`, and the response names it.
4081
+ * - `amount_threshold`: `min_amount` (integer, 0 or greater,
4082
+ * required), `threshold` (integer, 1 or greater, required), and
4083
+ * `asset` (object, required) with `id` - the asset symbol, one of
4084
+ * `USDC`, `USDT`, or `RD`, stored upper case; optionally
4085
+ * `name`, a display label that plays no part in matching. Any other
4086
+ * key inside `asset` is rejected. There is no way to omit the
4087
+ * asset: a missing asset, or an `asset.id` that is empty or `any`,
4088
+ * is rejected with `400`. The rule governs transactions in that
4089
+ * asset on every network, unless the stored asset names one.
4090
+ * `min_amount` is an amount of that asset in its smallest unit -
4091
+ * USDC has 6 decimals, so 10000000000 is 10,000 USDC - and
4092
+ * `threshold` is the number of authorized endorsements required
4093
+ * once a transaction reaches `min_amount`.
4094
+ * - `approval_threshold`: `threshold` (integer, 1 or greater,
4095
+ * required), `description` (string, optional).
4096
+ * - `address_list`: `addresses` (array of one or more strings,
4097
+ * required).
4098
+ * Every integer must be whole. The server rejects a fractional value
4099
+ * instead of truncating it.
4100
+ * Updating an existing rule is validated more strictly - see
4101
+ * `updated_definition`.
3642
4102
  * @example {
3643
- * "min_amount": 0,
3644
- * "threshold": 1000000
4103
+ * "min_amount": 10000000000,
4104
+ * "threshold": 2,
4105
+ * "asset": {
4106
+ * "id": "USDC"
4107
+ * }
3645
4108
  * }
3646
4109
  */
3647
4110
  readonly definition: Record<string, never>;
@@ -3650,7 +4113,7 @@ type components = {
3650
4113
  /** @description List of signatures over the intent */
3651
4114
  readonly signatures: readonly string[];
3652
4115
  /** @description The intent being endorsed */
3653
- readonly intent: components["schemas"]["SendTransactionIntent"] | components["schemas"]["AttachGroupToWalletIntent"] | components["schemas"]["DetachGroupFromWalletIntent"] | components["schemas"]["AttachPolicyToWalletIntent"] | components["schemas"]["DetachPolicyFromWalletIntent"] | components["schemas"]["AddPolicyRuleIntent"] | components["schemas"]["RemovePolicyRuleIntent"] | components["schemas"]["UpdatePolicyRuleIntent"] | components["schemas"]["DeletePolicyIntent"];
4116
+ readonly intent: components["schemas"]["SendTransactionIntent"] | components["schemas"]["AttachGroupToWalletIntent"] | components["schemas"]["DetachGroupFromWalletIntent"] | components["schemas"]["AttachPolicyToWalletIntent"] | components["schemas"]["DetachPolicyFromWalletIntent"] | components["schemas"]["AddPolicyRuleIntent"] | components["schemas"]["RemovePolicyRuleIntent"] | components["schemas"]["UpdatePolicyRuleIntent"] | components["schemas"]["DeletePolicyIntent"] | components["schemas"]["EnableCardSettlementIntent"];
3654
4117
  };
3655
4118
  readonly SendTransactionIntent: {
3656
4119
  /** @description Unique identifier for the wallet */
@@ -3800,7 +4263,30 @@ type components = {
3800
4263
  */
3801
4264
  readonly action: "allow" | "deny";
3802
4265
  /**
3803
- * @description Rule-specific configuration. Structure depends on rule_type
4266
+ * @description Rule-specific configuration. When a policy is created or a rule is
4267
+ * added, the accepted keys depend on `rule_type`. A key that is not
4268
+ * listed below is rejected with `400`, and the response names it.
4269
+ * - `amount_threshold`: `min_amount` (integer, 0 or greater,
4270
+ * required), `threshold` (integer, 1 or greater, required), and
4271
+ * `asset` (object, required) with `id` - the asset symbol, one of
4272
+ * `USDC`, `USDT`, or `RD`, stored upper case; optionally
4273
+ * `name`, a display label that plays no part in matching. Any other
4274
+ * key inside `asset` is rejected. There is no way to omit the
4275
+ * asset: a missing asset, or an `asset.id` that is empty or `any`,
4276
+ * is rejected with `400`. The rule governs transactions in that
4277
+ * asset on every network, unless the stored asset names one.
4278
+ * `min_amount` is an amount of that asset in its smallest unit -
4279
+ * USDC has 6 decimals, so 10000000000 is 10,000 USDC - and
4280
+ * `threshold` is the number of authorized endorsements required
4281
+ * once a transaction reaches `min_amount`.
4282
+ * - `approval_threshold`: `threshold` (integer, 1 or greater,
4283
+ * required), `description` (string, optional).
4284
+ * - `address_list`: `addresses` (array of one or more strings,
4285
+ * required).
4286
+ * Every integer must be whole. The server rejects a fractional value
4287
+ * instead of truncating it.
4288
+ * Updating an existing rule is validated more strictly - see
4289
+ * `updated_definition`.
3804
4290
  * @example {
3805
4291
  * "threshold": 2,
3806
4292
  * "description": "Require 2 approvals"
@@ -3852,8 +4338,8 @@ type components = {
3852
4338
  */
3853
4339
  readonly rule_id: string;
3854
4340
  /**
3855
- * @description The updated rule definition as JSON string
3856
- * @example {"amount": "15000", "currency": "USD"}
4341
+ * @description The updated rule definition as a JSON string. It replaces the existing definition, so it must be complete and must match the schema of the rule's type; any key outside that schema is rejected. An `amount_threshold` definition requires `asset.id`, a `threshold` greater than zero and a `min_amount` of zero or more. The remaining asset fields are optional — whatever the stored rule already records for the same asset is kept.
4342
+ * @example {"min_amount": 100, "threshold": 1, "asset": {"id": "USDC"}}
3857
4343
  */
3858
4344
  readonly updated_definition: string;
3859
4345
  /**
@@ -3862,6 +4348,34 @@ type components = {
3862
4348
  */
3863
4349
  readonly idempotency_key: string;
3864
4350
  };
4351
+ /**
4352
+ * @description Intent to enable card settlement on a wallet. It grants the client's
4353
+ * settlement signer the ability to pull funds from the wallet to exactly
4354
+ * `settlement_destination` — and nothing else. The intent is semantic
4355
+ * and client-constructible; it never names internal policy or group ids.
4356
+ */
4357
+ readonly EnableCardSettlementIntent: {
4358
+ /**
4359
+ * @example enable_card_settlement
4360
+ * @enum {string}
4361
+ */
4362
+ readonly type: "enable_card_settlement";
4363
+ /** @description The wallet to enable card settlement on */
4364
+ readonly wallet_id: string;
4365
+ /**
4366
+ * @description The only address the settlement signer may pull funds to. Must
4367
+ * match the platform-configured settlement destination returned by
4368
+ * the card-enablement discovery endpoint.
4369
+ */
4370
+ readonly settlement_destination: string;
4371
+ /**
4372
+ * @description A unique key to ensure idempotency of the request. Must be a UUID:
4373
+ * this key is part of the endorsed intent and the policy engine
4374
+ * requires that form, so anything else is rejected with a 400.
4375
+ * @example 7d3f6c2e-9a41-4f3b-bd1c-2e5a8f0c4b19
4376
+ */
4377
+ readonly idempotency_key: string;
4378
+ };
3865
4379
  readonly DeletePolicyIntent: {
3866
4380
  /**
3867
4381
  * @example delete_policy
@@ -4084,7 +4598,7 @@ type components = {
4084
4598
  * @example articles_of_incorporation
4085
4599
  * @enum {string}
4086
4600
  */
4087
- readonly ApplicationDocumentType: "certificate_of_incorporation" | "articles_of_incorporation" | "certificate_of_good_standing" | "corporate_registry_extract" | "shareholder_registry" | "bank_reference_letter" | "operating_agreement" | "memorandum" | "articles_of_association" | "proof_of_address" | "bank_statement" | "utility_bill" | "source_of_funds" | "crypto_statement" | "investment_statement" | "subscription_agreement" | "safe_agreement" | "convertible_note" | "loan_agreement" | "promissory_note" | "pitch_deck" | "marketing_material" | "business_plan" | "regulatory_license" | "payslip" | "employment_contract" | "shareholders_agreement" | "income_verification_letter" | "savings_statement" | "ein_confirmation_letter" | "authorization_document";
4601
+ readonly ApplicationDocumentType: "certificate_of_incorporation" | "articles_of_incorporation" | "certificate_of_good_standing" | "corporate_registry_extract" | "shareholder_registry" | "bank_reference_letter" | "operating_agreement" | "memorandum" | "articles_of_association" | "proof_of_address" | "bank_statement" | "utility_bill" | "source_of_funds" | "crypto_statement" | "investment_statement" | "subscription_agreement" | "safe_agreement" | "convertible_note" | "loan_agreement" | "promissory_note" | "pitch_deck" | "marketing_material" | "business_plan" | "regulatory_license" | "payslip" | "employment_contract" | "shareholders_agreement" | "income_verification_letter" | "savings_statement" | "ein_confirmation_letter" | "authorization_document" | "other";
4088
4602
  /** @description Request to upload an application-level document */
4089
4603
  readonly ApplicationDocumentUploadRequest: {
4090
4604
  readonly document_type: components["schemas"]["ApplicationDocumentType"];
@@ -4118,10 +4632,12 @@ type components = {
4118
4632
  readonly document_type: components["schemas"]["ApplicationDocumentType"];
4119
4633
  readonly file_type: components["schemas"]["FileType"];
4120
4634
  /**
4121
- * @description ISO 3166-1 alpha-2 country code for the document
4635
+ * @description ISO 3166-1 alpha-2 country code for the document. Optional: some
4636
+ * supporting documents (e.g. the generic `other` type) have no issuing
4637
+ * country.
4122
4638
  * @example US
4123
4639
  */
4124
- readonly country: string;
4640
+ readonly country?: string;
4125
4641
  /** @description Optional ID/registration number. Required for formation documents. */
4126
4642
  readonly id_number?: string;
4127
4643
  /**
@@ -4894,6 +5410,15 @@ type components = {
4894
5410
  };
4895
5411
  /** @description Attestation validation state */
4896
5412
  readonly AttestationValidation: {
5413
+ /**
5414
+ * @description Whether every required attestation has been collected, in a valid
5415
+ * order, by an applicant whose name still matches the application.
5416
+ *
5417
+ * Unaffected by `missing_documents`, which reports documents never
5418
+ * accepted at all.
5419
+ * @example true
5420
+ */
5421
+ readonly ready: boolean;
4897
5422
  /** @description Attestations that have been completed with details */
4898
5423
  readonly completed: readonly components["schemas"]["CompletedAttestation"][];
4899
5424
  /**
@@ -4904,6 +5429,48 @@ type components = {
4904
5429
  * ]
4905
5430
  */
4906
5431
  readonly missing: readonly components["schemas"]["AttestationType"][];
5432
+ /**
5433
+ * @description Legal documents the customer has never accepted. Fetch the text to
5434
+ * display with `GET /legal/documents/{document_key}`.
5435
+ *
5436
+ * Accepting any revision clears a document from this list — having
5437
+ * signed an older revision than the one in force does not put it
5438
+ * back. Informational only: this does not affect `ready`, and note
5439
+ * that a customer absent from this list may still be refused a
5440
+ * capability that requires a later revision.
5441
+ */
5442
+ readonly missing_documents?: readonly components["schemas"]["OutstandingLegalDocument"][];
5443
+ };
5444
+ /**
5445
+ * @description A legal document the customer has never accepted.
5446
+ *
5447
+ * The revision named is the one currently in force. Fetch its text with
5448
+ * `GET /legal/documents/{document_key}` — it is deliberately not inlined
5449
+ * here, because these documents run to tens of kilobytes each and this
5450
+ * field rides on every application read.
5451
+ */
5452
+ readonly OutstandingLegalDocument: {
5453
+ /**
5454
+ * @description Stable identifier of the document
5455
+ * @example dakota_tos
5456
+ */
5457
+ readonly key: string;
5458
+ /**
5459
+ * @description Version of the revision that needs accepting
5460
+ * @example 2026-08-04
5461
+ */
5462
+ readonly version: string;
5463
+ /**
5464
+ * @description Monotonic ordinal of the revision within this document
5465
+ * @example 5
5466
+ */
5467
+ readonly revision: number;
5468
+ /**
5469
+ * @description Human-readable title
5470
+ * @example Dakota Terms of Service
5471
+ */
5472
+ readonly title: string;
5473
+ readonly attestation_type?: components["schemas"]["AttestationType"];
4907
5474
  };
4908
5475
  /** @description Details of a completed attestation */
4909
5476
  readonly CompletedAttestation: {
@@ -4919,6 +5486,17 @@ type components = {
4919
5486
  * @example John Doe
4920
5487
  */
4921
5488
  readonly attested_by: string;
5489
+ /**
5490
+ * @description Version of the legal document that was accepted. Absent for
5491
+ * attestations recorded before documents were versioned.
5492
+ * @example 2026-07-23
5493
+ */
5494
+ readonly version?: string;
5495
+ /**
5496
+ * @description Title of the legal document that was accepted
5497
+ * @example Dakota Terms of Service
5498
+ */
5499
+ readonly title?: string;
4922
5500
  };
4923
5501
  /** @description Complete validation state for an application (computed at retrieval time) */
4924
5502
  readonly ApplicationValidation: {
@@ -4958,6 +5536,17 @@ type components = {
4958
5536
  * @example John Doe
4959
5537
  */
4960
5538
  readonly attested_by: string;
5539
+ /**
5540
+ * @description Version of the legal document that was accepted. Absent for
5541
+ * attestations recorded before documents were versioned.
5542
+ * @example 2026-07-23
5543
+ */
5544
+ readonly version?: string;
5545
+ /**
5546
+ * @description Title of the legal document that was accepted
5547
+ * @example Dakota Terms of Service
5548
+ */
5549
+ readonly title?: string;
4961
5550
  };
4962
5551
  /** @description Terms of service attestation (if completed) */
4963
5552
  readonly terms_of_service?: {
@@ -4972,6 +5561,17 @@ type components = {
4972
5561
  * @example John Doe
4973
5562
  */
4974
5563
  readonly attested_by: string;
5564
+ /**
5565
+ * @description Version of the legal document that was accepted. Absent for
5566
+ * attestations recorded before documents were versioned.
5567
+ * @example 2026-07-23
5568
+ */
5569
+ readonly version?: string;
5570
+ /**
5571
+ * @description Title of the legal document that was accepted
5572
+ * @example Dakota Terms of Service
5573
+ */
5574
+ readonly title?: string;
4975
5575
  };
4976
5576
  /** @description Privacy policy attestation (if completed) */
4977
5577
  readonly privacy_policy?: {
@@ -4986,6 +5586,17 @@ type components = {
4986
5586
  * @example John Doe
4987
5587
  */
4988
5588
  readonly attested_by: string;
5589
+ /**
5590
+ * @description Version of the legal document that was accepted. Absent for
5591
+ * attestations recorded before documents were versioned.
5592
+ * @example 2026-07-23
5593
+ */
5594
+ readonly version?: string;
5595
+ /**
5596
+ * @description Title of the legal document that was accepted
5597
+ * @example Dakota Terms of Service
5598
+ */
5599
+ readonly title?: string;
4989
5600
  };
4990
5601
  /** @description Funds transfer agreement attestation (if completed) */
4991
5602
  readonly funds_transfer_agreement?: {
@@ -5000,6 +5611,17 @@ type components = {
5000
5611
  * @example John Doe
5001
5612
  */
5002
5613
  readonly attested_by: string;
5614
+ /**
5615
+ * @description Version of the legal document that was accepted. Absent for
5616
+ * attestations recorded before documents were versioned.
5617
+ * @example 2026-07-23
5618
+ */
5619
+ readonly version?: string;
5620
+ /**
5621
+ * @description Title of the legal document that was accepted
5622
+ * @example Dakota Terms of Service
5623
+ */
5624
+ readonly title?: string;
5003
5625
  };
5004
5626
  /** @description Lead Bank privacy policy attestation (if completed) */
5005
5627
  readonly lead_bank_privacy_policy?: {
@@ -5014,7 +5636,26 @@ type components = {
5014
5636
  * @example John Doe
5015
5637
  */
5016
5638
  readonly attested_by: string;
5639
+ /**
5640
+ * @description Version of the legal document that was accepted. Absent for
5641
+ * attestations recorded before documents were versioned.
5642
+ * @example 2026-07-23
5643
+ */
5644
+ readonly version?: string;
5645
+ /**
5646
+ * @description Title of the legal document that was accepted
5647
+ * @example Dakota Terms of Service
5648
+ */
5649
+ readonly title?: string;
5017
5650
  };
5651
+ /**
5652
+ * @description Legal documents the customer has never accepted. Fetch the text to
5653
+ * display with `GET /legal/documents/{document_key}`. Accepting any
5654
+ * revision clears a document from this list. Informational: this does
5655
+ * NOT affect `validation.ready` or whether an application can be
5656
+ * submitted.
5657
+ */
5658
+ readonly missing_documents?: readonly components["schemas"]["OutstandingLegalDocument"][];
5018
5659
  /** @description E-sign attestation (if completed) */
5019
5660
  readonly e_sign?: {
5020
5661
  /**
@@ -5028,6 +5669,17 @@ type components = {
5028
5669
  * @example John Doe
5029
5670
  */
5030
5671
  readonly attested_by: string;
5672
+ /**
5673
+ * @description Version of the legal document that was accepted. Absent for
5674
+ * attestations recorded before documents were versioned.
5675
+ * @example 2026-07-23
5676
+ */
5677
+ readonly version?: string;
5678
+ /**
5679
+ * @description Title of the legal document that was accepted
5680
+ * @example Dakota Terms of Service
5681
+ */
5682
+ readonly title?: string;
5031
5683
  };
5032
5684
  };
5033
5685
  /** @description Application response with separated entity data and validation state */
@@ -5064,6 +5716,9 @@ type components = {
5064
5716
  * @example 2024-01-17T16:00:00Z
5065
5717
  */
5066
5718
  readonly application_submitted_at?: string | null;
5719
+ readonly rfi_requested_items?: components["schemas"]["RFIRequestedItems"];
5720
+ /** @description Whether the applicant has already submitted in response to the latest scoped RFI (drives the resubmit page's "already submitted" state). */
5721
+ readonly rfi_resubmitted?: boolean;
5067
5722
  /**
5068
5723
  * @description Decision outcome for the application (only present after decision is made). Note: auto_declined is mapped to declined in the API response.
5069
5724
  * @example approved
@@ -5406,6 +6061,74 @@ type components = {
5406
6061
  * @enum {string}
5407
6062
  */
5408
6063
  readonly AttestationType: "information_accuracy" | "terms_of_service" | "privacy_policy" | "funds_transfer_agreement" | "lead_bank_privacy_policy" | "e_sign";
6064
+ /**
6065
+ * @description The minimum an acceptance page needs: what is still owed, and who may
6066
+ * sign it. Deliberately NOT the application — see the endpoint description.
6067
+ */
6068
+ readonly LegalAcceptanceContext: {
6069
+ /**
6070
+ * @description Decides whether a signer is chosen or stated. A business may have
6071
+ * several control persons; an individual application has exactly one
6072
+ * permissible attestor, so asking them to pick themselves from a list
6073
+ * of one is a step with no purpose.
6074
+ * @enum {string}
6075
+ */
6076
+ readonly application_type: "business" | "individual";
6077
+ /**
6078
+ * @description Agreements this application has not accepted at the revision now in
6079
+ * force. Identity only — no document text. The bodies are served by
6080
+ * `GET /legal/documents/{document_key}`, which is cacheable and shared
6081
+ * with the published pages, and are ~120KB of markdown that would
6082
+ * otherwise ride this response.
6083
+ */
6084
+ readonly outstanding_documents: readonly components["schemas"]["OutstandingLegalDocument"][];
6085
+ /**
6086
+ * @description People permitted to record an acceptance for this application. For a
6087
+ * business this is its control persons; the API enforces the same rule
6088
+ * on submission, so offering anyone else would only produce a 400.
6089
+ */
6090
+ readonly attestors: readonly components["schemas"]["LegalAcceptanceAttestor"][];
6091
+ /**
6092
+ * @description What is already on file, per attestation type. The page compares each
6093
+ * against the revision now in force to decide whether an agreement is
6094
+ * genuinely outstanding — having signed an OLDER revision is not the
6095
+ * same as never having signed, and the two need different copy.
6096
+ *
6097
+ * Separate from `outstanding_documents`, which reports only documents
6098
+ * never accepted at all. A customer on a superseded revision appears
6099
+ * here and not there.
6100
+ */
6101
+ readonly accepted_agreements?: readonly components["schemas"]["AcceptedAgreement"][];
6102
+ };
6103
+ readonly AcceptedAgreement: {
6104
+ /**
6105
+ * @description The attestation type this acceptance was recorded under.
6106
+ * @example terms_of_service
6107
+ */
6108
+ readonly attestation_type: string;
6109
+ /**
6110
+ * @description The revision accepted. Empty for an acceptance predating the registry,
6111
+ * whose revision is derived from its timestamp rather than stored.
6112
+ * @example 2026-07-23
6113
+ */
6114
+ readonly version?: string;
6115
+ };
6116
+ readonly LegalAcceptanceAttestor: {
6117
+ /**
6118
+ * @description The applicant id to submit as `applicant_id`. This is the
6119
+ * application-individual link, not the individual — the same value the
6120
+ * attestation endpoint validates against.
6121
+ */
6122
+ readonly id: components["schemas"]["KSUID"];
6123
+ /**
6124
+ * @description Display name. NOTHING else about the person is returned: this page
6125
+ * shows a name in a picker, and date of birth, nationality and email
6126
+ * are exactly the fields the scoped credential exists to keep out of an
6127
+ * emailed link.
6128
+ * @example Ada Lovelace
6129
+ */
6130
+ readonly name: string;
6131
+ };
5409
6132
  /**
5410
6133
  * @description Request to submit an attestation for a KYB application.
5411
6134
  *
@@ -5449,6 +6172,24 @@ type components = {
5449
6172
  * @example 2026-06
5450
6173
  */
5451
6174
  readonly disclosure_version?: string;
6175
+ /**
6176
+ * @description Optional. The version of the Dakota-published document the customer
6177
+ * was actually shown, as returned by
6178
+ * `GET /legal/documents/{document_key}`.
6179
+ *
6180
+ * Pass it whenever you render the text yourself. Without it the
6181
+ * acceptance is pinned to whichever revision is in force when the
6182
+ * request arrives — which is not necessarily the one on the
6183
+ * customer's screen, if a new revision went live between render and
6184
+ * submit. Rejected with 400 if that version is not currently in force,
6185
+ * so a stale page fails loudly instead of recording consent to text
6186
+ * nobody read.
6187
+ *
6188
+ * Ignored when `disclosure_id` is present; use `disclosure_version`
6189
+ * for partner disclosures.
6190
+ * @example 2026-07-23
6191
+ */
6192
+ readonly legal_document_version?: string;
5452
6193
  };
5453
6194
  /** @description Error response when a self-serve client lacks the credits required to perform an action. */
5454
6195
  readonly InsufficientCreditsError: {
@@ -5741,12 +6482,24 @@ interface operations {
5741
6482
  * application are excluded when this filter is set.
5742
6483
  */
5743
6484
  readonly application_statuses?: string;
6485
+ /**
6486
+ * @description Filter customers by one or more unified customer statuses.
6487
+ * Comma-separated list (e.g. `frozen,info_requested`). Values mirror
6488
+ * the `CustomerStatus` enum (`frozen`, `declined`, `withdrawn`,
6489
+ * `approved`, `info_requested`, `submitted`, `pending`).
6490
+ *
6491
+ * This is the single client-facing status that the dashboard shows,
6492
+ * filters, and counts by. It collapses the frozen state, the
6493
+ * application decision, and the application lifecycle into one value
6494
+ * (see the `status` field on `Customer` for the precedence).
6495
+ */
6496
+ readonly status?: string;
5744
6497
  /** @description Filter customers by sub-client association. Returns only customers associated with the specified sub-client. */
5745
6498
  readonly sub_client_id?: components["schemas"]["KSUID"];
5746
6499
  /** @description When true, returns only customers that are sub-clients (designated as such at creation). When false or omitted, returns all customers. */
5747
6500
  readonly is_sub_client?: boolean;
5748
6501
  /** @description Field to sort customers by. Defaults to `name`. */
5749
- readonly sort_by?: "application_status" | "created_at" | "customer_type" | "id" | "kyb_status" | "kyc_status" | "name";
6502
+ readonly sort_by?: "application_status" | "created_at" | "customer_type" | "id" | "kyb_status" | "kyc_status" | "name" | "status";
5750
6503
  /** @description Sort direction. Defaults to `asc`. */
5751
6504
  readonly sort_dir?: "asc" | "desc";
5752
6505
  /** @description Filter customers created at or after this ISO 8601 datetime (e.g. 2024-01-01T00:00:00Z). */
@@ -5816,6 +6569,13 @@ interface operations {
5816
6569
  readonly "application/json": {
5817
6570
  readonly data: readonly components["schemas"]["Customer"][];
5818
6571
  readonly meta: components["schemas"]["Meta"];
6572
+ /**
6573
+ * @description How many customers hold each unified status, across the
6574
+ * same filters (search, date, sub-client) but ignoring the
6575
+ * `status` selection itself, so the dashboard can render a
6576
+ * count per status chip while a status filter is active.
6577
+ */
6578
+ readonly status_counts?: components["schemas"]["CustomerStatusCounts"];
5819
6579
  };
5820
6580
  };
5821
6581
  };
@@ -6524,7 +7284,14 @@ interface operations {
6524
7284
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
6525
7285
  };
6526
7286
  };
6527
- /** @description Customer has no approved application to re-engage */
7287
+ /**
7288
+ * @description Customer has no approved application to re-engage.
7289
+ *
7290
+ * A customer whose application is still pending does not need
7291
+ * re-engagement: reuse the `application_url` already returned by
7292
+ * `GET /customers/{customer_id}`. That original link stays valid for
7293
+ * 90 days from creation.
7294
+ */
6528
7295
  readonly 409: {
6529
7296
  headers: {
6530
7297
  readonly [name: string]: unknown;
@@ -7313,9 +8080,9 @@ interface operations {
7313
8080
  readonly ending_before?: components["parameters"]["EndingBeforeParam"];
7314
8081
  /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. */
7315
8082
  readonly limit?: components["parameters"]["LimitParam"];
7316
- /** @description Filter by transaction resource family. */
8083
+ /** @description Select the transaction resource family (`one_off`, `auto_account`, or `wallet`) to return. When omitted, the family is inferred from the other parameters (see the endpoint description). */
7317
8084
  readonly transaction_type?: components["schemas"]["TransactionResourceType"];
7318
- /** @description Filter transactions by customer ID. */
8085
+ /** @description Filter transactions by customer ID, within the selected resource family. Note: when `transaction_type` is omitted, supplying `customer_id` alone selects the `auto_account` family, so the result is that customer's auto-account transactions. To filter one-off transactions by customer, also send `transaction_type=one_off`. */
7319
8086
  readonly customer_id?: components["schemas"]["KSUID"];
7320
8087
  /** @description Filter wallet transactions by wallet ID. Only valid with `transaction_type=wallet`. */
7321
8088
  readonly wallet_id?: components["schemas"]["KSUID"];
@@ -7445,7 +8212,8 @@ interface operations {
7445
8212
  * "meta": {
7446
8213
  * "total_count": 100,
7447
8214
  * "has_more_after": true,
7448
- * "has_more_before": false
8215
+ * "has_more_before": false,
8216
+ * "transaction_type": "one_off"
7449
8217
  * }
7450
8218
  * }
7451
8219
  */
@@ -7732,22 +8500,16 @@ interface operations {
7732
8500
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
7733
8501
  };
7734
8502
  };
7735
- /** @description Forbidden */
8503
+ /**
8504
+ * @description Forbidden. Returned when the caller is not authorized for the
8505
+ * operation, or when the transfer would send over a rail covered by
8506
+ * an agreement the customer has not accepted (`terms_not_accepted`).
8507
+ */
7736
8508
  readonly 403: {
7737
8509
  headers: {
7738
8510
  readonly [name: string]: unknown;
7739
8511
  };
7740
8512
  content: {
7741
- /**
7742
- * @example {
7743
- * "type": "https://docs.dakota.xyz/api-reference/errors#forbidden",
7744
- * "title": "Forbidden",
7745
- * "status": 403,
7746
- * "detail": "Forbidden",
7747
- * "instance": "https://api.platform.dakota.xyz/transactions",
7748
- * "request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
7749
- * }
7750
- */
7751
8513
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
7752
8514
  };
7753
8515
  };
@@ -7789,6 +8551,25 @@ interface operations {
7789
8551
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
7790
8552
  };
7791
8553
  };
8554
+ /** @description Service unavailable */
8555
+ readonly 503: {
8556
+ headers: {
8557
+ readonly [name: string]: unknown;
8558
+ };
8559
+ content: {
8560
+ /**
8561
+ * @example {
8562
+ * "type": "https://docs.dakota.xyz/api-reference/errors#eligibility-unavailable",
8563
+ * "title": "Service unavailable",
8564
+ * "status": 503,
8565
+ * "detail": "Eligibility could not be evaluated. Retry shortly.",
8566
+ * "instance": "https://api.platform.dakota.xyz/transactions",
8567
+ * "request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
8568
+ * }
8569
+ */
8570
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
8571
+ };
8572
+ };
7792
8573
  /** @description Unexpected error */
7793
8574
  readonly default: {
7794
8575
  headers: {
@@ -9378,31 +10159,6 @@ interface operations {
9378
10159
  };
9379
10160
  readonly requestBody: {
9380
10161
  readonly content: {
9381
- /**
9382
- * @example {
9383
- * "account_type": "onramp",
9384
- * "capabilities": [
9385
- * "ach",
9386
- * "fedwire"
9387
- * ],
9388
- * "rail": "ach",
9389
- * "crypto_destination_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
9390
- * "fiat_destination_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
9391
- * "destination_network_id": "ethereum-mainnet",
9392
- * "source_network_id": "ethereum-mainnet",
9393
- * "source_asset": "USDC",
9394
- * "destination_asset": "USDC",
9395
- * "return_address": {
9396
- * "network_id": "ethereum-mainnet",
9397
- * "crypto_address": "0x165cd37b4c644c2921454429e7f9358d18a45e14"
9398
- * },
9399
- * "return_crypto_address": {
9400
- * "network_id": "ethereum-mainnet",
9401
- * "crypto_address": "0x165cd37b4c644c2921454429e7f9358d18a45e14"
9402
- * },
9403
- * "developer_fee_bps": 50
9404
- * }
9405
- */
9406
10162
  readonly "application/json": components["schemas"]["AccountCreateRequest"];
9407
10163
  };
9408
10164
  };
@@ -9512,9 +10268,11 @@ interface operations {
9512
10268
  };
9513
10269
  /**
9514
10270
  * @description Forbidden. Returned when the caller is not authorized for the
9515
- * operation, or when the requested onramp/swap account would deal in
10271
+ * operation, when the requested onramp/swap account would deal in
9516
10272
  * RD but RD is not available in the customer's US state
9517
- * (`state_restricted_rd`).
10273
+ * (`state_restricted_rd`), or when the account would use a rail
10274
+ * covered by an agreement the customer has not accepted
10275
+ * (`terms_not_accepted`).
9518
10276
  */
9519
10277
  readonly 403: {
9520
10278
  headers: {
@@ -10077,22 +10835,18 @@ interface operations {
10077
10835
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
10078
10836
  };
10079
10837
  };
10080
- /** @description Forbidden */
10838
+ /**
10839
+ * @description Forbidden. Returned when the caller is not authorized for the
10840
+ * operation, or when the update would give the account a rail covered
10841
+ * by an agreement the customer has not accepted (`terms_not_accepted`)
10842
+ * — for example pointing it at a destination that adds an
10843
+ * international payout route.
10844
+ */
10081
10845
  readonly 403: {
10082
10846
  headers: {
10083
10847
  readonly [name: string]: unknown;
10084
10848
  };
10085
10849
  content: {
10086
- /**
10087
- * @example {
10088
- * "type": "https://docs.dakota.xyz/api-reference/errors#forbidden",
10089
- * "title": "Forbidden",
10090
- * "status": 403,
10091
- * "detail": "Forbidden",
10092
- * "instance": "https://api.platform.dakota.xyz/accounts/example-id",
10093
- * "request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
10094
- * }
10095
- */
10096
10850
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
10097
10851
  };
10098
10852
  };
@@ -12506,6 +13260,7 @@ interface operations {
12506
13260
  * }
12507
13261
  * },
12508
13262
  * "attestations": {
13263
+ * "ready": false,
12509
13264
  * "completed": [
12510
13265
  * {
12511
13266
  * "type": "information_accuracy",
@@ -12648,6 +13403,76 @@ interface operations {
12648
13403
  };
12649
13404
  };
12650
13405
  };
13406
+ readonly getLegalAcceptanceContext: {
13407
+ readonly parameters: {
13408
+ readonly query?: never;
13409
+ readonly header?: never;
13410
+ readonly path: {
13411
+ /** @description The unique identifier for the application */
13412
+ readonly application_id: components["schemas"]["KSUID"];
13413
+ };
13414
+ readonly cookie?: never;
13415
+ };
13416
+ readonly requestBody?: never;
13417
+ readonly responses: {
13418
+ /** @description Outstanding agreements and permitted attestors */
13419
+ readonly 200: {
13420
+ headers: {
13421
+ readonly [name: string]: unknown;
13422
+ };
13423
+ content: {
13424
+ /**
13425
+ * @example {
13426
+ * "application_type": "business",
13427
+ * "outstanding_documents": [
13428
+ * {
13429
+ * "key": "dakota_tos",
13430
+ * "title": "Dakota Terms of Service",
13431
+ * "version": "2026-09",
13432
+ * "revision": 4
13433
+ * }
13434
+ * ],
13435
+ * "accepted_agreements": [
13436
+ * {
13437
+ * "attestation_type": "terms_of_service",
13438
+ * "version": "2026-02"
13439
+ * },
13440
+ * {
13441
+ * "attestation_type": "e_sign",
13442
+ * "version": "2025-11"
13443
+ * }
13444
+ * ],
13445
+ * "attestors": [
13446
+ * {
13447
+ * "id": "3H96fIU3lr1KQwe5cXmgD5x6kHy",
13448
+ * "name": "Ada Lovelace"
13449
+ * }
13450
+ * ]
13451
+ * }
13452
+ */
13453
+ readonly "application/json": components["schemas"]["LegalAcceptanceContext"];
13454
+ };
13455
+ };
13456
+ /** @description Invalid or expired token, or a token not scoped to this action */
13457
+ readonly 403: {
13458
+ headers: {
13459
+ readonly [name: string]: unknown;
13460
+ };
13461
+ content: {
13462
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
13463
+ };
13464
+ };
13465
+ /** @description Application not found */
13466
+ readonly 404: {
13467
+ headers: {
13468
+ readonly [name: string]: unknown;
13469
+ };
13470
+ content: {
13471
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
13472
+ };
13473
+ };
13474
+ };
13475
+ };
12651
13476
  readonly downloadDocument: {
12652
13477
  readonly parameters: {
12653
13478
  readonly query?: never;
@@ -14028,6 +14853,7 @@ interface operations {
14028
14853
  * }
14029
14854
  * },
14030
14855
  * "attestations": {
14856
+ * "ready": false,
14031
14857
  * "completed": [
14032
14858
  * {
14033
14859
  * "type": "information_accuracy",
@@ -15136,6 +15962,7 @@ interface operations {
15136
15962
  * {
15137
15963
  * "id": "pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
15138
15964
  * "client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
15965
+ * "signer_group_id": "grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
15139
15966
  * "version": 1,
15140
15967
  * "name": "High Value Transaction Policy",
15141
15968
  * "description": "Requires approval for transactions above $10,000",
@@ -15146,8 +15973,11 @@ interface operations {
15146
15973
  * "rule_type": "amount_threshold",
15147
15974
  * "action": "deny",
15148
15975
  * "definition": {
15149
- * "min_amount": 0,
15150
- * "threshold": 1000000
15976
+ * "min_amount": 10000000000,
15977
+ * "threshold": 2,
15978
+ * "asset": {
15979
+ * "id": "USDC"
15980
+ * }
15151
15981
  * },
15152
15982
  * "created_at": 1640995200
15153
15983
  * }
@@ -15287,8 +16117,11 @@ interface operations {
15287
16117
  * "rule_type": "amount_threshold",
15288
16118
  * "action": "deny",
15289
16119
  * "definition": {
15290
- * "min_amount": 0,
15291
- * "threshold": 1000000
16120
+ * "min_amount": 10000000000,
16121
+ * "threshold": 2,
16122
+ * "asset": {
16123
+ * "id": "USDC"
16124
+ * }
15292
16125
  * }
15293
16126
  * }
15294
16127
  * ]
@@ -15308,6 +16141,7 @@ interface operations {
15308
16141
  * @example {
15309
16142
  * "id": "pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
15310
16143
  * "client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
16144
+ * "signer_group_id": "grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
15311
16145
  * "version": 1,
15312
16146
  * "name": "High Value Transaction Policy",
15313
16147
  * "description": "Requires approval for transactions above $10,000",
@@ -15318,8 +16152,11 @@ interface operations {
15318
16152
  * "rule_type": "amount_threshold",
15319
16153
  * "action": "deny",
15320
16154
  * "definition": {
15321
- * "min_amount": 0,
15322
- * "threshold": 1000000
16155
+ * "min_amount": 10000000000,
16156
+ * "threshold": 2,
16157
+ * "asset": {
16158
+ * "id": "USDC"
16159
+ * }
15323
16160
  * },
15324
16161
  * "created_at": 1640995200
15325
16162
  * }
@@ -15611,7 +16448,7 @@ interface operations {
15611
16448
  * "type": "update_policy_rule",
15612
16449
  * "policy_id": "pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
15613
16450
  * "rule_id": "rule_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
15614
- * "updated_definition": "{\"amount\": \"15000\", \"currency\": \"USD\"}",
16451
+ * "updated_definition": "{\"min_amount\": 100, \"threshold\": 1, \"asset\": {\"id\": \"USDC\"}}",
15615
16452
  * "idempotency_key": "idem_2N4YkKpKu7M3mKpGYmF8kcJ8oZT"
15616
16453
  * }
15617
16454
  * }
@@ -15630,6 +16467,7 @@ interface operations {
15630
16467
  * @example {
15631
16468
  * "id": "pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
15632
16469
  * "client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
16470
+ * "signer_group_id": "grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
15633
16471
  * "version": 1,
15634
16472
  * "name": "High Value Transaction Policy",
15635
16473
  * "description": "Requires approval for transactions above $10,000",
@@ -15640,8 +16478,11 @@ interface operations {
15640
16478
  * "rule_type": "amount_threshold",
15641
16479
  * "action": "deny",
15642
16480
  * "definition": {
15643
- * "min_amount": 0,
15644
- * "threshold": 1000000
16481
+ * "min_amount": 10000000000,
16482
+ * "threshold": 2,
16483
+ * "asset": {
16484
+ * "id": "USDC"
16485
+ * }
15645
16486
  * },
15646
16487
  * "created_at": 1640995200
15647
16488
  * }
@@ -16219,6 +17060,7 @@ interface operations {
16219
17060
  * @example {
16220
17061
  * "id": "pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
16221
17062
  * "client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
17063
+ * "signer_group_id": "grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
16222
17064
  * "version": 1,
16223
17065
  * "name": "High Value Transaction Policy",
16224
17066
  * "description": "Requires approval for transactions above $10,000",
@@ -16229,8 +17071,11 @@ interface operations {
16229
17071
  * "rule_type": "amount_threshold",
16230
17072
  * "action": "deny",
16231
17073
  * "definition": {
16232
- * "min_amount": 0,
16233
- * "threshold": 1000000
17074
+ * "min_amount": 10000000000,
17075
+ * "threshold": 2,
17076
+ * "asset": {
17077
+ * "id": "USDC"
17078
+ * }
16234
17079
  * },
16235
17080
  * "created_at": 1640995200
16236
17081
  * }
@@ -16667,6 +17512,7 @@ interface operations {
16667
17512
  * @example {
16668
17513
  * "id": "pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
16669
17514
  * "client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
17515
+ * "signer_group_id": "grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
16670
17516
  * "version": 1,
16671
17517
  * "name": "High Value Transaction Policy",
16672
17518
  * "description": "Requires approval for transactions above $10,000",
@@ -16677,8 +17523,11 @@ interface operations {
16677
17523
  * "rule_type": "amount_threshold",
16678
17524
  * "action": "deny",
16679
17525
  * "definition": {
16680
- * "min_amount": 0,
16681
- * "threshold": 1000000
17526
+ * "min_amount": 10000000000,
17527
+ * "threshold": 2,
17528
+ * "asset": {
17529
+ * "id": "USDC"
17530
+ * }
16682
17531
  * },
16683
17532
  * "created_at": 1640995200
16684
17533
  * }
@@ -17105,6 +17954,23 @@ interface operations {
17105
17954
  };
17106
17955
  };
17107
17956
  readonly responses: {
17957
+ /** @description Signer already registered to you. The submitted public key already belongs to one of your existing signers, so no new signer was created. The response carries that signer's persisted `id`, `public_key` and `key_type` (use the returned `key_type` to sign — it is authoritative and may differ from the one submitted); `name` echoes the request. Registration is idempotent: re-running setup returns a usable id instead of an error. A public key held by a different client returns `409` and no details about that signer. */
17958
+ readonly 200: {
17959
+ headers: {
17960
+ readonly [name: string]: unknown;
17961
+ };
17962
+ content: {
17963
+ /**
17964
+ * @example {
17965
+ * "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
17966
+ * "name": "Marc",
17967
+ * "public_key": "string",
17968
+ * "key_type": "ES256"
17969
+ * }
17970
+ */
17971
+ readonly "application/json": components["schemas"]["Signer"];
17972
+ };
17973
+ };
17108
17974
  /** @description Signer created successfully */
17109
17975
  readonly 201: {
17110
17976
  headers: {
@@ -17180,7 +18046,7 @@ interface operations {
17180
18046
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
17181
18047
  };
17182
18048
  };
17183
- /** @description Conflict - duplicate request detected */
18049
+ /** @description Conflict - the public key is already registered to a live signer belonging to a different client, or a duplicate request was detected. A public key belongs to exactly one client, so a key registered by someone else cannot be registered again; register a distinct key instead. The response deliberately carries no detail about the existing signer. */
17184
18050
  readonly 409: {
17185
18051
  headers: {
17186
18052
  readonly [name: string]: unknown;
@@ -21834,6 +22700,84 @@ interface operations {
21834
22700
  };
21835
22701
  };
21836
22702
  };
22703
+ readonly getLegalDocument: {
22704
+ readonly parameters: {
22705
+ readonly query?: {
22706
+ /**
22707
+ * @description A specific published revision. Omit for the revision in force now.
22708
+ * @example 2026-07-23
22709
+ */
22710
+ readonly version?: string;
22711
+ };
22712
+ readonly header?: never;
22713
+ readonly path: {
22714
+ /**
22715
+ * @description Document identifier, e.g. `dakota_tos`.
22716
+ * @example dakota_tos
22717
+ */
22718
+ readonly document_key: string;
22719
+ };
22720
+ readonly cookie?: never;
22721
+ };
22722
+ readonly requestBody?: never;
22723
+ readonly responses: {
22724
+ /** @description The requested revision. */
22725
+ readonly 200: {
22726
+ headers: {
22727
+ readonly [name: string]: unknown;
22728
+ };
22729
+ content: {
22730
+ /**
22731
+ * @example {
22732
+ * "key": "dakota_tos",
22733
+ * "version": "2026-08-04",
22734
+ * "revision": 5,
22735
+ * "title": "Dakota Terms of Service",
22736
+ * "content": "# Dakota Terms of Service\n\nLast updated 2026-08-04...",
22737
+ * "content_type": "text/markdown",
22738
+ * "content_url": "https://dakota.xyz/terms",
22739
+ * "effective_date": "2026-08-04"
22740
+ * }
22741
+ */
22742
+ readonly "application/json": components["schemas"]["LegalDocument"];
22743
+ };
22744
+ };
22745
+ /** @description No such document, or no revision is currently in force. */
22746
+ readonly 404: {
22747
+ headers: {
22748
+ readonly [name: string]: unknown;
22749
+ };
22750
+ content: {
22751
+ /**
22752
+ * @example {
22753
+ * "type": "https://docs.dakota.xyz/api-reference/errors#not-found",
22754
+ * "title": "Legal Document Not Found",
22755
+ * "status": 404,
22756
+ * "detail": "No published revision of dakota_tos was found."
22757
+ * }
22758
+ */
22759
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
22760
+ };
22761
+ };
22762
+ /** @description Internal error */
22763
+ readonly 500: {
22764
+ headers: {
22765
+ readonly [name: string]: unknown;
22766
+ };
22767
+ content: {
22768
+ /**
22769
+ * @example {
22770
+ * "type": "https://docs.dakota.xyz/api-reference/errors#internal-error",
22771
+ * "title": "Internal error",
22772
+ * "status": 500,
22773
+ * "detail": "An unexpected error occurred."
22774
+ * }
22775
+ */
22776
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
22777
+ };
22778
+ };
22779
+ };
22780
+ };
21837
22781
  readonly getPaymentAgent: {
21838
22782
  readonly parameters: {
21839
22783
  readonly query?: never;
@@ -22386,16 +23330,19 @@ interface operations {
22386
23330
  };
22387
23331
  };
22388
23332
  };
22389
- readonly getSelfServeCreditsBalance: {
23333
+ readonly getRDMarketingFeeStatement: {
22390
23334
  readonly parameters: {
22391
23335
  readonly query?: never;
22392
23336
  readonly header?: never;
22393
- readonly path?: never;
23337
+ readonly path: {
23338
+ /** @description First day of the month (UTC). */
23339
+ readonly month: string;
23340
+ };
22394
23341
  readonly cookie?: never;
22395
23342
  };
22396
23343
  readonly requestBody?: never;
22397
23344
  readonly responses: {
22398
- /** @description Current credit balance */
23345
+ /** @description The month's statement */
22399
23346
  readonly 200: {
22400
23347
  headers: {
22401
23348
  readonly [name: string]: unknown;
@@ -22403,11 +23350,35 @@ interface operations {
22403
23350
  content: {
22404
23351
  /**
22405
23352
  * @example {
22406
- * "balance_cents": 45000,
22407
- * "transfer_capacity_cents": 9000000
23353
+ * "month": "2026-08-01",
23354
+ * "y_bps_monthly": 15,
23355
+ * "days_in_month": 31,
23356
+ * "days_stamped": 2,
23357
+ * "daily": [
23358
+ * {
23359
+ * "date": "2026-08-01",
23360
+ * "balance_minor": "1250000"
23361
+ * },
23362
+ * {
23363
+ * "date": "2026-08-02",
23364
+ * "balance_minor": "0"
23365
+ * },
23366
+ * {
23367
+ * "date": "2026-08-03"
23368
+ * }
23369
+ * ]
22408
23370
  * }
22409
23371
  */
22410
- readonly "application/json": components["schemas"]["SelfServeCreditsBalanceResponse"];
23372
+ readonly "application/json": components["schemas"]["RDMarketingFeeStatement"];
23373
+ };
23374
+ };
23375
+ /** @description Invalid request */
23376
+ readonly 400: {
23377
+ headers: {
23378
+ readonly [name: string]: unknown;
23379
+ };
23380
+ content: {
23381
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
22411
23382
  };
22412
23383
  };
22413
23384
  /** @description Unauthorized */
@@ -22416,60 +23387,39 @@ interface operations {
22416
23387
  readonly [name: string]: unknown;
22417
23388
  };
22418
23389
  content: {
22419
- /**
22420
- * @example {
22421
- * "type": "https://docs.dakota.xyz/api-reference/errors#authentication-error",
22422
- * "title": "Authentication Required",
22423
- * "status": 401,
22424
- * "detail": "Missing or invalid authentication credentials."
22425
- * }
22426
- */
22427
23390
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
22428
23391
  };
22429
23392
  };
22430
- /** @description Credit management is only available for self-serve customers */
22431
- readonly 403: {
23393
+ /** @description No statement for this client and month */
23394
+ readonly 404: {
22432
23395
  headers: {
22433
23396
  readonly [name: string]: unknown;
22434
23397
  };
22435
23398
  content: {
22436
- /**
22437
- * @example {
22438
- * "type": "https://docs.dakota.xyz/api-reference/errors#forbidden",
22439
- * "title": "Forbidden",
22440
- * "status": 403,
22441
- * "detail": "Credit management is only available for self-serve customers."
22442
- * }
22443
- */
22444
23399
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
22445
23400
  };
22446
23401
  };
22447
- /** @description Unexpected error */
22448
- readonly default: {
23402
+ /** @description Internal server error */
23403
+ readonly 500: {
22449
23404
  headers: {
22450
23405
  readonly [name: string]: unknown;
22451
23406
  };
22452
- content?: never;
23407
+ content: {
23408
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23409
+ };
22453
23410
  };
22454
23411
  };
22455
23412
  };
22456
- readonly listSelfServeCreditsLedger: {
23413
+ readonly listLegalDocuments: {
22457
23414
  readonly parameters: {
22458
- readonly query?: {
22459
- /** @description Return entries created before this timestamp. */
22460
- readonly cursor?: string;
22461
- /** @description Maximum number of entries to return. */
22462
- readonly limit?: number;
22463
- /** @description Optional ledger entry type filter. */
22464
- readonly type?: "purchase" | "deduction" | "refund";
22465
- };
23415
+ readonly query?: never;
22466
23416
  readonly header?: never;
22467
23417
  readonly path?: never;
22468
23418
  readonly cookie?: never;
22469
23419
  };
22470
23420
  readonly requestBody?: never;
22471
23421
  readonly responses: {
22472
- /** @description Paginated credit ledger entries */
23422
+ /** @description The in-force revision of each document, without its text. */
22473
23423
  readonly 200: {
22474
23424
  headers: {
22475
23425
  readonly [name: string]: unknown;
@@ -22477,16 +23427,160 @@ interface operations {
22477
23427
  content: {
22478
23428
  /**
22479
23429
  * @example {
22480
- * "entries": [
23430
+ * "data": [
22481
23431
  * {
22482
- * "id": "2WCn7YQ2QqA4oQ7wYpQyQ1QZKp1",
22483
- * "entry_type": "purchase",
22484
- * "category": "purchase",
22485
- * "amount_cents": 10000,
22486
- * "balance_after_cents": 10000,
22487
- * "transaction_id": null,
22488
- * "description": "Purchased 10000 cents of credits",
22489
- * "created_at": "2026-03-19T10:15:00Z"
23432
+ * "key": "dakota_tos",
23433
+ * "version": "2026-08-04",
23434
+ * "revision": 5,
23435
+ * "title": "Dakota Terms of Service",
23436
+ * "content_type": "text/markdown",
23437
+ * "effective_date": "2026-08-04"
23438
+ * },
23439
+ * {
23440
+ * "key": "dakota_privacy",
23441
+ * "version": "2026-07-23",
23442
+ * "revision": 3,
23443
+ * "title": "Dakota Privacy Policy",
23444
+ * "content_type": "text/markdown",
23445
+ * "effective_date": "2026-07-23"
23446
+ * }
23447
+ * ]
23448
+ * }
23449
+ */
23450
+ readonly "application/json": {
23451
+ readonly data: readonly components["schemas"]["LegalDocument"][];
23452
+ };
23453
+ };
23454
+ };
23455
+ /** @description Internal error */
23456
+ readonly 500: {
23457
+ headers: {
23458
+ readonly [name: string]: unknown;
23459
+ };
23460
+ content: {
23461
+ /**
23462
+ * @example {
23463
+ * "type": "https://docs.dakota.xyz/api-reference/errors#internal-error",
23464
+ * "title": "Internal error",
23465
+ * "status": 500,
23466
+ * "detail": "An unexpected error occurred."
23467
+ * }
23468
+ */
23469
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23470
+ };
23471
+ };
23472
+ };
23473
+ };
23474
+ readonly getSelfServeCreditsBalance: {
23475
+ readonly parameters: {
23476
+ readonly query?: never;
23477
+ readonly header?: never;
23478
+ readonly path?: never;
23479
+ readonly cookie?: never;
23480
+ };
23481
+ readonly requestBody?: never;
23482
+ readonly responses: {
23483
+ /** @description Current credit balance */
23484
+ readonly 200: {
23485
+ headers: {
23486
+ readonly [name: string]: unknown;
23487
+ };
23488
+ content: {
23489
+ /**
23490
+ * @example {
23491
+ * "balance_cents": 45000,
23492
+ * "transfer_capacity_cents": 9000000
23493
+ * }
23494
+ */
23495
+ readonly "application/json": components["schemas"]["SelfServeCreditsBalanceResponse"];
23496
+ };
23497
+ };
23498
+ /** @description Unauthorized */
23499
+ readonly 401: {
23500
+ headers: {
23501
+ readonly [name: string]: unknown;
23502
+ };
23503
+ content: {
23504
+ /**
23505
+ * @example {
23506
+ * "type": "https://docs.dakota.xyz/api-reference/errors#authentication-error",
23507
+ * "title": "Authentication Required",
23508
+ * "status": 401,
23509
+ * "detail": "Missing or invalid authentication credentials."
23510
+ * }
23511
+ */
23512
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23513
+ };
23514
+ };
23515
+ /** @description Credit management is only available for self-serve customers */
23516
+ readonly 403: {
23517
+ headers: {
23518
+ readonly [name: string]: unknown;
23519
+ };
23520
+ content: {
23521
+ /**
23522
+ * @example {
23523
+ * "type": "https://docs.dakota.xyz/api-reference/errors#forbidden",
23524
+ * "title": "Forbidden",
23525
+ * "status": 403,
23526
+ * "detail": "Credit management is only available for self-serve customers."
23527
+ * }
23528
+ */
23529
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23530
+ };
23531
+ };
23532
+ /** @description Unexpected error */
23533
+ readonly default: {
23534
+ headers: {
23535
+ readonly [name: string]: unknown;
23536
+ };
23537
+ content?: never;
23538
+ };
23539
+ };
23540
+ };
23541
+ readonly listSelfServeCreditsLedger: {
23542
+ readonly parameters: {
23543
+ readonly query?: {
23544
+ /** @description Return entries created before this timestamp. */
23545
+ readonly cursor?: string;
23546
+ /**
23547
+ * @description Tiebreaker for `cursor`. Entries written in the same transaction share
23548
+ * an identical `created_at`, so ordering by timestamp alone is not total
23549
+ * and a page boundary that splits them can drop a row. When supplied
23550
+ * alongside `cursor`, entries are returned strictly before
23551
+ * `(cursor, cursor_id)` in `(created_at, id)` order. Pass the `id` of the
23552
+ * last entry on the previous page. Ignored unless `cursor` is also present.
23553
+ */
23554
+ readonly cursor_id?: string;
23555
+ /** @description Maximum number of entries to return. */
23556
+ readonly limit?: number;
23557
+ /** @description Optional ledger entry type filter. */
23558
+ readonly type?: "purchase" | "bonus" | "deduction" | "refund" | "adjustment";
23559
+ };
23560
+ readonly header?: never;
23561
+ readonly path?: never;
23562
+ readonly cookie?: never;
23563
+ };
23564
+ readonly requestBody?: never;
23565
+ readonly responses: {
23566
+ /** @description Paginated credit ledger entries */
23567
+ readonly 200: {
23568
+ headers: {
23569
+ readonly [name: string]: unknown;
23570
+ };
23571
+ content: {
23572
+ /**
23573
+ * @example {
23574
+ * "entries": [
23575
+ * {
23576
+ * "id": "2WCn7YQ2QqA4oQ7wYpQyQ1QZKp1",
23577
+ * "entry_type": "purchase",
23578
+ * "category": "purchase",
23579
+ * "amount_cents": 10000,
23580
+ * "balance_after_cents": 10000,
23581
+ * "transaction_id": null,
23582
+ * "description": "Purchased 10000 cents of credits",
23583
+ * "created_at": "2026-03-19T10:15:00Z"
22490
23584
  * },
22491
23585
  * {
22492
23586
  * "id": "2WCn7d4W2KzGdYJZmkQ8q2rKQm8",
@@ -22516,7 +23610,7 @@ interface operations {
22516
23610
  * "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
22517
23611
  * "title": "Invalid Request",
22518
23612
  * "status": 400,
22519
- * "detail": "type must be one of purchase, deduction, refund"
23613
+ * "detail": "type must be one of purchase, bonus, deduction, refund, adjustment"
22520
23614
  * }
22521
23615
  */
22522
23616
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
@@ -22671,7 +23765,8 @@ interface operations {
22671
23765
  * "kybFeeCents": 2500,
22672
23766
  * "effectiveFrom": "2024-01-01T00:00:00Z",
22673
23767
  * "createdAt": "2024-01-01T00:00:00Z",
22674
- * "updatedAt": "2024-01-01T00:00:00Z"
23768
+ * "updatedAt": "2024-01-01T00:00:00Z",
23769
+ * "transferFeeOverrides": []
22675
23770
  * }
22676
23771
  */
22677
23772
  readonly "application/json": components["schemas"]["ClientPricingConfig"];
@@ -22720,6 +23815,207 @@ interface operations {
22720
23815
  };
22721
23816
  };
22722
23817
  };
23818
+ readonly listRDMarketingFeeStatements: {
23819
+ readonly parameters: {
23820
+ readonly query?: never;
23821
+ readonly header?: never;
23822
+ readonly path?: never;
23823
+ readonly cookie?: never;
23824
+ };
23825
+ readonly requestBody?: never;
23826
+ readonly responses: {
23827
+ /** @description The client's statement months, newest first */
23828
+ readonly 200: {
23829
+ headers: {
23830
+ readonly [name: string]: unknown;
23831
+ };
23832
+ content: {
23833
+ /**
23834
+ * @example {
23835
+ * "months": [
23836
+ * "2026-08-01",
23837
+ * "2026-07-01",
23838
+ * "2026-06-01"
23839
+ * ]
23840
+ * }
23841
+ */
23842
+ readonly "application/json": components["schemas"]["RDMarketingFeeStatementList"];
23843
+ };
23844
+ };
23845
+ /** @description Unauthorized */
23846
+ readonly 401: {
23847
+ headers: {
23848
+ readonly [name: string]: unknown;
23849
+ };
23850
+ content: {
23851
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23852
+ };
23853
+ };
23854
+ /** @description This client has no marketing-fee contract */
23855
+ readonly 404: {
23856
+ headers: {
23857
+ readonly [name: string]: unknown;
23858
+ };
23859
+ content: {
23860
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23861
+ };
23862
+ };
23863
+ /** @description Internal server error */
23864
+ readonly 500: {
23865
+ headers: {
23866
+ readonly [name: string]: unknown;
23867
+ };
23868
+ content: {
23869
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23870
+ };
23871
+ };
23872
+ };
23873
+ };
23874
+ readonly getClientAgenticPolicy: {
23875
+ readonly parameters: {
23876
+ readonly query?: never;
23877
+ readonly header?: never;
23878
+ readonly path?: never;
23879
+ readonly cookie?: never;
23880
+ };
23881
+ readonly requestBody?: never;
23882
+ readonly responses: {
23883
+ /** @description The client's registered agentic policy, normalized. */
23884
+ readonly 200: {
23885
+ headers: {
23886
+ readonly [name: string]: unknown;
23887
+ };
23888
+ content: {
23889
+ /**
23890
+ * @example {
23891
+ * "policy": {
23892
+ * "payee_model": "flat",
23893
+ * "mandate_strategy": "external_only",
23894
+ * "payout_route": "bank_only",
23895
+ * "labels": {
23896
+ * "limit": "spending limit",
23897
+ * "limit_unit": "USD",
23898
+ * "payee": "recipient"
23899
+ * }
23900
+ * },
23901
+ * "created_at": 1761600000,
23902
+ * "updated_at": 1761686400
23903
+ * }
23904
+ */
23905
+ readonly "application/json": components["schemas"]["RegisteredAgenticClientPolicy"];
23906
+ };
23907
+ };
23908
+ /** @description Bad Request */
23909
+ readonly 400: {
23910
+ headers: {
23911
+ readonly [name: string]: unknown;
23912
+ };
23913
+ content: {
23914
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23915
+ };
23916
+ };
23917
+ /** @description Unauthorized */
23918
+ readonly 401: {
23919
+ headers: {
23920
+ readonly [name: string]: unknown;
23921
+ };
23922
+ content: {
23923
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23924
+ };
23925
+ };
23926
+ /** @description This client has no registered policy. */
23927
+ readonly 404: {
23928
+ headers: {
23929
+ readonly [name: string]: unknown;
23930
+ };
23931
+ content: {
23932
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23933
+ };
23934
+ };
23935
+ };
23936
+ };
23937
+ readonly updateClientAgenticPolicy: {
23938
+ readonly parameters: {
23939
+ readonly query?: never;
23940
+ readonly header: {
23941
+ /** @description Unique key to ensure request idempotency. If the same key is used within a certain time window, the original response will be returned instead of executing the request again. */
23942
+ readonly "x-idempotency-key": components["parameters"]["IdempotencyKeyHeader"];
23943
+ };
23944
+ readonly path?: never;
23945
+ readonly cookie?: never;
23946
+ };
23947
+ readonly requestBody: {
23948
+ readonly content: {
23949
+ /**
23950
+ * @example {
23951
+ * "payee_model": "flat",
23952
+ * "mandate_strategy": "external_only",
23953
+ * "payout_route": "bank_only",
23954
+ * "labels": {
23955
+ * "limit": "spending limit",
23956
+ * "limit_unit": "USD",
23957
+ * "payee": "recipient"
23958
+ * }
23959
+ * }
23960
+ */
23961
+ readonly "application/json": components["schemas"]["AgenticClientPolicy"];
23962
+ };
23963
+ };
23964
+ readonly responses: {
23965
+ /** @description The registered policy, normalized as it will be applied. */
23966
+ readonly 200: {
23967
+ headers: {
23968
+ readonly [name: string]: unknown;
23969
+ };
23970
+ content: {
23971
+ /**
23972
+ * @example {
23973
+ * "policy": {
23974
+ * "payee_model": "flat",
23975
+ * "mandate_strategy": "external_only",
23976
+ * "payout_route": "bank_only",
23977
+ * "labels": {
23978
+ * "limit": "spending limit",
23979
+ * "limit_unit": "USD",
23980
+ * "payee": "recipient"
23981
+ * }
23982
+ * },
23983
+ * "created_at": 1761600000,
23984
+ * "updated_at": 1761686400
23985
+ * }
23986
+ */
23987
+ readonly "application/json": components["schemas"]["RegisteredAgenticClientPolicy"];
23988
+ };
23989
+ };
23990
+ /** @description The policy is not one this server can enforce — an unknown key, an unsupported value, or a label for an unimplemented concept. */
23991
+ readonly 400: {
23992
+ headers: {
23993
+ readonly [name: string]: unknown;
23994
+ };
23995
+ content: {
23996
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23997
+ };
23998
+ };
23999
+ /** @description Unauthorized */
24000
+ readonly 401: {
24001
+ headers: {
24002
+ readonly [name: string]: unknown;
24003
+ };
24004
+ content: {
24005
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
24006
+ };
24007
+ };
24008
+ /** @description Not Found */
24009
+ readonly 404: {
24010
+ headers: {
24011
+ readonly [name: string]: unknown;
24012
+ };
24013
+ content: {
24014
+ readonly "application/problem+json": components["schemas"]["ProblemDetails"];
24015
+ };
24016
+ };
24017
+ };
24018
+ };
22723
24019
  readonly getFeePayoutDestination: {
22724
24020
  readonly parameters: {
22725
24021
  readonly query?: never;
@@ -23023,95 +24319,18 @@ interface operations {
23023
24319
  * "target_type": "recipient",
23024
24320
  * "targets": [
23025
24321
  * "2vWxRecipient000000000000000"
23026
- * ],
23027
- * "asset": "USDC",
23028
- * "window": "MONTHLY",
23029
- * "max_amount_in_window": "20000"
23030
- * }
23031
- * }
23032
- */
23033
- readonly "application/json": components["schemas"]["AmendMandateRequest"];
23034
- };
23035
- };
23036
- readonly responses: {
23037
- /** @description The mandate at its new version. `version` is the version just created; `rule` is now that version's rule. */
23038
- readonly 200: {
23039
- headers: {
23040
- readonly [name: string]: unknown;
23041
- };
23042
- content: {
23043
- /**
23044
- * @example {
23045
- * "id": "2vWxMandate00000000000000000",
23046
- * "status": "active",
23047
- * "version": 2
23048
- * }
23049
- */
23050
- readonly "application/json": components["schemas"]["Mandate"];
23051
- };
23052
- };
23053
- /** @description Invalid request */
23054
- readonly 400: {
23055
- headers: {
23056
- readonly [name: string]: unknown;
23057
- };
23058
- content: {
23059
- /**
23060
- * @example {
23061
- * "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
23062
- * "title": "Invalid Request",
23063
- * "status": 400,
23064
- * "detail": "window cannot change between mandate versions (currently \"MONTHLY\", requested \"WEEKLY\") — cancel this mandate and create a new one"
23065
- * }
23066
- */
23067
- readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23068
- };
23069
- };
23070
- /** @description Agentic payments not enabled, or the resource was not found */
23071
- readonly 404: {
23072
- headers: {
23073
- readonly [name: string]: unknown;
23074
- };
23075
- content: {
23076
- /**
23077
- * @example {
23078
- * "type": "https://docs.dakota.xyz/api-reference/errors#not-found",
23079
- * "title": "Not Found",
23080
- * "status": 404,
23081
- * "detail": "agentic payments are not enabled"
23082
- * }
23083
- */
23084
- readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23085
- };
23086
- };
23087
- };
23088
- };
23089
- readonly cancelMandate: {
23090
- readonly parameters: {
23091
- readonly query?: never;
23092
- readonly header?: never;
23093
- readonly path: {
23094
- readonly mandate_id: string;
23095
- };
23096
- readonly cookie?: never;
23097
- };
23098
- readonly requestBody: {
23099
- readonly content: {
23100
- /**
23101
- * @example {
23102
- * "signer_public_key": "BHkSignerKeyQm",
23103
- * "signature": "MEUCIQExampleSignature"
24322
+ * ],
24323
+ * "asset": "USDC",
24324
+ * "window": "MONTHLY",
24325
+ * "max_amount_in_window": "20000"
24326
+ * }
23104
24327
  * }
23105
24328
  */
23106
- readonly "application/json": components["schemas"]["CancelMandateRequest"];
24329
+ readonly "application/json": components["schemas"]["AmendMandateRequest"];
23107
24330
  };
23108
24331
  };
23109
24332
  readonly responses: {
23110
- /**
23111
- * @description Mandate terminated — `rejected` if it was still pending, `revoked` if it was active.
23112
- *
23113
- * Scheduled payments are NOT cancelled. They are signer-scoped and decoupled from mandate lifecycle, so any payment this mandate was covering stays `scheduled` and then FAILS at its due date, when the executor finds no mandate authorizing it. Cancel those payments explicitly if they should not remain on the customer's schedule.
23114
- */
24333
+ /** @description The mandate at its new version. `version` is the version just created; `rule` is now that version's rule. */
23115
24334
  readonly 200: {
23116
24335
  headers: {
23117
24336
  readonly [name: string]: unknown;
@@ -23120,10 +24339,11 @@ interface operations {
23120
24339
  /**
23121
24340
  * @example {
23122
24341
  * "id": "2vWxMandate00000000000000000",
23123
- * "status": "revoked"
24342
+ * "status": "active",
24343
+ * "version": 2
23124
24344
  * }
23125
24345
  */
23126
- readonly "application/json": components["schemas"]["MandateResponse"];
24346
+ readonly "application/json": components["schemas"]["Mandate"];
23127
24347
  };
23128
24348
  };
23129
24349
  /** @description Invalid request */
@@ -23137,7 +24357,7 @@ interface operations {
23137
24357
  * "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
23138
24358
  * "title": "Invalid Request",
23139
24359
  * "status": 400,
23140
- * "detail": "mandate is done, not cancellable"
24360
+ * "detail": "window cannot change between mandate versions (currently \"MONTHLY\", requested \"WEEKLY\") — cancel this mandate and create a new one"
23141
24361
  * }
23142
24362
  */
23143
24363
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
@@ -23162,7 +24382,7 @@ interface operations {
23162
24382
  };
23163
24383
  };
23164
24384
  };
23165
- readonly approveMandate: {
24385
+ readonly cancelMandate: {
23166
24386
  readonly parameters: {
23167
24387
  readonly query?: never;
23168
24388
  readonly header?: never;
@@ -23175,15 +24395,19 @@ interface operations {
23175
24395
  readonly content: {
23176
24396
  /**
23177
24397
  * @example {
23178
- * "approver_public_key": "BHkApproverKeyQm",
24398
+ * "signer_public_key": "BHkSignerKeyQm",
23179
24399
  * "signature": "MEUCIQExampleSignature"
23180
24400
  * }
23181
24401
  */
23182
- readonly "application/json": components["schemas"]["ApproveMandateRequest"];
24402
+ readonly "application/json": components["schemas"]["CancelMandateRequest"];
23183
24403
  };
23184
24404
  };
23185
24405
  readonly responses: {
23186
- /** @description Mandate activated */
24406
+ /**
24407
+ * @description Mandate terminated — `rejected` if it was still pending, `revoked` if it was active.
24408
+ *
24409
+ * Scheduled payments are NOT cancelled. They are signer-scoped and decoupled from mandate lifecycle, so any payment this mandate was covering stays `scheduled` and then FAILS at its due date, when the executor finds no mandate authorizing it. Cancel those payments explicitly if they should not remain on the customer's schedule.
24410
+ */
23187
24411
  readonly 200: {
23188
24412
  headers: {
23189
24413
  readonly [name: string]: unknown;
@@ -23192,8 +24416,7 @@ interface operations {
23192
24416
  /**
23193
24417
  * @example {
23194
24418
  * "id": "2vWxMandate00000000000000000",
23195
- * "status": "active",
23196
- * "approved_by_signer_id": "2vWxApprover0000000000000000"
24419
+ * "status": "revoked"
23197
24420
  * }
23198
24421
  */
23199
24422
  readonly "application/json": components["schemas"]["MandateResponse"];
@@ -23210,7 +24433,7 @@ interface operations {
23210
24433
  * "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
23211
24434
  * "title": "Invalid Request",
23212
24435
  * "status": 400,
23213
- * "detail": "approver must differ from the bound signer"
24436
+ * "detail": "mandate is done, not cancellable"
23214
24437
  * }
23215
24438
  */
23216
24439
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
@@ -23235,15 +24458,12 @@ interface operations {
23235
24458
  };
23236
24459
  };
23237
24460
  };
23238
- readonly chatCustomerInsights: {
24461
+ readonly approveMandate: {
23239
24462
  readonly parameters: {
23240
24463
  readonly query?: never;
23241
- readonly header: {
23242
- /** @description Unique key to ensure request idempotency. If the same key is used within a certain time window, the original response will be returned instead of executing the request again. */
23243
- readonly "x-idempotency-key": components["parameters"]["IdempotencyKeyHeader"];
23244
- };
24464
+ readonly header?: never;
23245
24465
  readonly path: {
23246
- readonly customer_id: string;
24466
+ readonly mandate_id: string;
23247
24467
  };
23248
24468
  readonly cookie?: never;
23249
24469
  };
@@ -23251,19 +24471,15 @@ interface operations {
23251
24471
  readonly content: {
23252
24472
  /**
23253
24473
  * @example {
23254
- * "messages": [
23255
- * {
23256
- * "role": "user",
23257
- * "content": "Anything I should know about my account this week?"
23258
- * }
23259
- * ]
24474
+ * "approver_public_key": "BHkApproverKeyQm",
24475
+ * "signature": "MEUCIQExampleSignature"
23260
24476
  * }
23261
24477
  */
23262
- readonly "application/json": components["schemas"]["InsightChatRequest"];
24478
+ readonly "application/json": components["schemas"]["ApproveMandateRequest"];
23263
24479
  };
23264
24480
  };
23265
24481
  readonly responses: {
23266
- /** @description The assistant's reply */
24482
+ /** @description Mandate activated */
23267
24483
  readonly 200: {
23268
24484
  headers: {
23269
24485
  readonly [name: string]: unknown;
@@ -23271,13 +24487,15 @@ interface operations {
23271
24487
  content: {
23272
24488
  /**
23273
24489
  * @example {
23274
- * "reply": "You have 3 payments (5200 USDC) due in the next two weeks, and your Operating wallet shows $3100.25 — about 2100 USDC short. Consider topping it up before July 14."
24490
+ * "id": "2vWxMandate00000000000000000",
24491
+ * "status": "active",
24492
+ * "approved_by_signer_id": "2vWxApprover0000000000000000"
23275
24493
  * }
23276
24494
  */
23277
- readonly "application/json": components["schemas"]["InsightChatResponse"];
24495
+ readonly "application/json": components["schemas"]["MandateResponse"];
23278
24496
  };
23279
24497
  };
23280
- /** @description Invalid request, or the insight chat layer is not configured */
24498
+ /** @description Invalid request */
23281
24499
  readonly 400: {
23282
24500
  headers: {
23283
24501
  readonly [name: string]: unknown;
@@ -23288,13 +24506,13 @@ interface operations {
23288
24506
  * "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
23289
24507
  * "title": "Invalid Request",
23290
24508
  * "status": 400,
23291
- * "detail": "insight chat is not enabled (no LLM configured)"
24509
+ * "detail": "approver must differ from the bound signer"
23292
24510
  * }
23293
24511
  */
23294
24512
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23295
24513
  };
23296
24514
  };
23297
- /** @description Agentic payments not enabled, or the customer was not found */
24515
+ /** @description Agentic payments not enabled, or the resource was not found */
23298
24516
  readonly 404: {
23299
24517
  headers: {
23300
24518
  readonly [name: string]: unknown;
@@ -23305,24 +24523,7 @@ interface operations {
23305
24523
  * "type": "https://docs.dakota.xyz/api-reference/errors#not-found",
23306
24524
  * "title": "Not Found",
23307
24525
  * "status": 404,
23308
- * "detail": "customer not found"
23309
- * }
23310
- */
23311
- readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23312
- };
23313
- };
23314
- /** @description The per-customer insight-chat rate limit was exceeded (an hourly burst window and a daily window). Back off and retry later. */
23315
- readonly 429: {
23316
- headers: {
23317
- readonly [name: string]: unknown;
23318
- };
23319
- content: {
23320
- /**
23321
- * @example {
23322
- * "type": "https://docs.dakota.xyz/api-reference/errors#rate-limited",
23323
- * "title": "Rate Limited",
23324
- * "status": 429,
23325
- * "detail": "insight chat rate limit reached for this customer (hour window) — retry later"
24526
+ * "detail": "agentic payments are not enabled"
23326
24527
  * }
23327
24528
  */
23328
24529
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
@@ -23541,207 +24742,62 @@ interface operations {
23541
24742
  readonly path: {
23542
24743
  readonly scheduled_payment_id: string;
23543
24744
  };
23544
- readonly cookie?: never;
23545
- };
23546
- readonly requestBody?: never;
23547
- readonly responses: {
23548
- /** @description The cancelled scheduled payment. */
23549
- readonly 200: {
23550
- headers: {
23551
- readonly [name: string]: unknown;
23552
- };
23553
- content: {
23554
- /**
23555
- * @example {
23556
- * "id": "2vWxScheduled000000000000000",
23557
- * "wallet_id": "2vWxWallet000000000000000000",
23558
- * "amount": "10000",
23559
- * "asset": "USDC",
23560
- * "address": "0xa11ce00000000000000000000000000000000001",
23561
- * "network_id": "base-sepolia",
23562
- * "status": "cancelled",
23563
- * "scheduled_at": 1781481600
23564
- * }
23565
- */
23566
- readonly "application/json": components["schemas"]["ScheduledPaymentResponse"];
23567
- };
23568
- };
23569
- /** @description Unknown payment or not cancellable (executed, failed, or already cancelled). */
23570
- readonly 400: {
23571
- headers: {
23572
- readonly [name: string]: unknown;
23573
- };
23574
- content: {
23575
- /**
23576
- * @example {
23577
- * "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
23578
- * "title": "Invalid Request",
23579
- * "status": 400,
23580
- * "detail": "scheduled payment is executed, not cancellable"
23581
- * }
23582
- */
23583
- readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23584
- };
23585
- };
23586
- /** @description Agentic payments not enabled, or the resource was not found */
23587
- readonly 404: {
23588
- headers: {
23589
- readonly [name: string]: unknown;
23590
- };
23591
- content: {
23592
- /**
23593
- * @example {
23594
- * "type": "https://docs.dakota.xyz/api-reference/errors#not-found",
23595
- * "title": "Not Found",
23596
- * "status": 404,
23597
- * "detail": "agentic payments are not enabled"
23598
- * }
23599
- */
23600
- readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23601
- };
23602
- };
23603
- };
23604
- };
23605
- readonly getClientAgenticPolicy: {
23606
- readonly parameters: {
23607
- readonly query?: never;
23608
- readonly header?: never;
23609
- readonly path?: never;
23610
- readonly cookie?: never;
23611
- };
23612
- readonly requestBody?: never;
23613
- readonly responses: {
23614
- /** @description The client's registered agentic policy, normalized. */
23615
- readonly 200: {
23616
- headers: {
23617
- readonly [name: string]: unknown;
23618
- };
23619
- content: {
23620
- /**
23621
- * @example {
23622
- * "policy": {
23623
- * "payee_model": "flat",
23624
- * "mandate_strategy": "external_only",
23625
- * "payout_route": "bank_only",
23626
- * "labels": {
23627
- * "limit": "spending limit",
23628
- * "limit_unit": "USD",
23629
- * "payee": "recipient"
23630
- * }
23631
- * },
23632
- * "created_at": 1761600000,
23633
- * "updated_at": 1761686400
23634
- * }
23635
- */
23636
- readonly "application/json": components["schemas"]["RegisteredAgenticClientPolicy"];
23637
- };
23638
- };
23639
- /** @description Bad Request */
23640
- readonly 400: {
23641
- headers: {
23642
- readonly [name: string]: unknown;
23643
- };
23644
- content: {
23645
- readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23646
- };
23647
- };
23648
- /** @description Unauthorized */
23649
- readonly 401: {
23650
- headers: {
23651
- readonly [name: string]: unknown;
23652
- };
23653
- content: {
23654
- readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23655
- };
23656
- };
23657
- /** @description This client has no registered policy. */
23658
- readonly 404: {
23659
- headers: {
23660
- readonly [name: string]: unknown;
23661
- };
23662
- content: {
23663
- readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23664
- };
23665
- };
23666
- };
23667
- };
23668
- readonly updateClientAgenticPolicy: {
23669
- readonly parameters: {
23670
- readonly query?: never;
23671
- readonly header: {
23672
- /** @description Unique key to ensure request idempotency. If the same key is used within a certain time window, the original response will be returned instead of executing the request again. */
23673
- readonly "x-idempotency-key": components["parameters"]["IdempotencyKeyHeader"];
23674
- };
23675
- readonly path?: never;
23676
- readonly cookie?: never;
23677
- };
23678
- readonly requestBody: {
23679
- readonly content: {
23680
- /**
23681
- * @example {
23682
- * "payee_model": "flat",
23683
- * "mandate_strategy": "external_only",
23684
- * "payout_route": "bank_only",
23685
- * "labels": {
23686
- * "limit": "spending limit",
23687
- * "limit_unit": "USD",
23688
- * "payee": "recipient"
23689
- * }
23690
- * }
23691
- */
23692
- readonly "application/json": components["schemas"]["AgenticClientPolicy"];
23693
- };
23694
- };
23695
- readonly responses: {
23696
- /** @description The registered policy, normalized as it will be applied. */
23697
- readonly 200: {
23698
- headers: {
23699
- readonly [name: string]: unknown;
23700
- };
23701
- content: {
23702
- /**
23703
- * @example {
23704
- * "policy": {
23705
- * "payee_model": "flat",
23706
- * "mandate_strategy": "external_only",
23707
- * "payout_route": "bank_only",
23708
- * "labels": {
23709
- * "limit": "spending limit",
23710
- * "limit_unit": "USD",
23711
- * "payee": "recipient"
23712
- * }
23713
- * },
23714
- * "created_at": 1761600000,
23715
- * "updated_at": 1761686400
23716
- * }
23717
- */
23718
- readonly "application/json": components["schemas"]["RegisteredAgenticClientPolicy"];
23719
- };
23720
- };
23721
- /** @description The policy is not one this server can enforce — an unknown key, an unsupported value, or a label for an unimplemented concept. */
23722
- readonly 400: {
24745
+ readonly cookie?: never;
24746
+ };
24747
+ readonly requestBody?: never;
24748
+ readonly responses: {
24749
+ /** @description The cancelled scheduled payment. */
24750
+ readonly 200: {
23723
24751
  headers: {
23724
24752
  readonly [name: string]: unknown;
23725
24753
  };
23726
24754
  content: {
23727
- readonly "application/problem+json": components["schemas"]["ProblemDetails"];
24755
+ /**
24756
+ * @example {
24757
+ * "id": "2vWxScheduled000000000000000",
24758
+ * "wallet_id": "2vWxWallet000000000000000000",
24759
+ * "amount": "10000",
24760
+ * "asset": "USDC",
24761
+ * "address": "0xa11ce00000000000000000000000000000000001",
24762
+ * "network_id": "base-sepolia",
24763
+ * "status": "cancelled",
24764
+ * "scheduled_at": 1781481600
24765
+ * }
24766
+ */
24767
+ readonly "application/json": components["schemas"]["ScheduledPaymentResponse"];
23728
24768
  };
23729
24769
  };
23730
- /** @description Unauthorized */
23731
- readonly 401: {
24770
+ /** @description Unknown payment or not cancellable (executed, failed, or already cancelled). */
24771
+ readonly 400: {
23732
24772
  headers: {
23733
24773
  readonly [name: string]: unknown;
23734
24774
  };
23735
24775
  content: {
24776
+ /**
24777
+ * @example {
24778
+ * "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
24779
+ * "title": "Invalid Request",
24780
+ * "status": 400,
24781
+ * "detail": "scheduled payment is executed, not cancellable"
24782
+ * }
24783
+ */
23736
24784
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23737
24785
  };
23738
24786
  };
23739
- /** @description Not Found */
24787
+ /** @description Agentic payments not enabled, or the resource was not found */
23740
24788
  readonly 404: {
23741
24789
  headers: {
23742
24790
  readonly [name: string]: unknown;
23743
24791
  };
23744
24792
  content: {
24793
+ /**
24794
+ * @example {
24795
+ * "type": "https://docs.dakota.xyz/api-reference/errors#not-found",
24796
+ * "title": "Not Found",
24797
+ * "status": 404,
24798
+ * "detail": "agentic payments are not enabled"
24799
+ * }
24800
+ */
23745
24801
  readonly "application/problem+json": components["schemas"]["ProblemDetails"];
23746
24802
  };
23747
24803
  };
@@ -23791,6 +24847,28 @@ type CustomerCreateRequest = Omit<components['schemas']['CustomerCreateRequest']
23791
24847
  type CustomerCreateResponse = components['schemas']['CustomerCreateResponse'];
23792
24848
  /** KYB status */
23793
24849
  type KybStatus = Customer['kyb_status'];
24850
+ /**
24851
+ * The single client-facing customer status.
24852
+ *
24853
+ * One value collapsing the frozen state, the application decision, and the
24854
+ * application lifecycle — what the dashboard shows, filters, and counts by.
24855
+ * See `Customer.status` for the derivation precedence.
24856
+ *
24857
+ * Distinct from {@link KybStatus}, which reports only the KYB leg.
24858
+ */
24859
+ type CustomerStatus = components['schemas']['CustomerStatus'];
24860
+ /**
24861
+ * How many customers hold each unified status.
24862
+ *
24863
+ * Returned alongside a customer page as `status_counts`, computed under the
24864
+ * same filters (search, date, sub-client) but IGNORING the `status` selection
24865
+ * itself — so a status chip keeps its count while that status is the active
24866
+ * filter. A status absent from the object has a count of zero.
24867
+ *
24868
+ * `customers.list()` iterates rows, so reach this with
24869
+ * {@link CustomersResource.listPage}.
24870
+ */
24871
+ type CustomerStatusCounts = components['schemas']['CustomerStatusCounts'];
23794
24872
  /** Request to update the sub-client association for a customer */
23795
24873
  type UpdateCustomerSubClientRequest = components['schemas']['UpdateCustomerSubClientRequest'];
23796
24874
  /** Summary of a sub-client including the count of associated customers */
@@ -23962,6 +25040,16 @@ type ApplicationListItem = components['schemas']['ApplicationListItem'];
23962
25040
  type Application = components['schemas']['Application'];
23963
25041
  /** Application status */
23964
25042
  type ApplicationStatus = components['schemas']['ApplicationStatus'];
25043
+ /**
25044
+ * The reviewer-selected resubmission scope for an RFI (request for
25045
+ * information).
25046
+ *
25047
+ * Present on `Application.rfi_requested_items` while an RFI is open: which
25048
+ * documents to replace, whether the business description is editable, and any
25049
+ * free-text compliance questions to answer. Render the resubmit page from
25050
+ * this rather than reopening the whole application form.
25051
+ */
25052
+ type RFIRequestedItems = components['schemas']['RFIRequestedItems'];
23965
25053
  /**
23966
25054
  * Business application creation request.
23967
25055
  *
@@ -24123,6 +25211,57 @@ interface WebhookHistoryResponse {
24123
25211
  has_more: boolean;
24124
25212
  cursor?: string | null;
24125
25213
  }
25214
+ /**
25215
+ * One published revision of a legal document.
25216
+ *
25217
+ * A revision is IMMUTABLE: `version` identifies an exact text that never
25218
+ * changes once published, and a correction produces a new revision rather than
25219
+ * editing this one. So an acceptance recorded against a version always refers
25220
+ * to the same words, and a fetched `(key, version)` can be cached forever.
25221
+ *
25222
+ * `content` is present only on {@link LegalResource.get} — the list is an
25223
+ * index without the text.
25224
+ */
25225
+ type LegalDocument = components['schemas']['LegalDocument'];
25226
+ /**
25227
+ * A legal document the customer has never accepted, at the revision now in
25228
+ * force. Identity only — fetch the text with {@link LegalResource.get}.
25229
+ */
25230
+ type OutstandingLegalDocument = components['schemas']['OutstandingLegalDocument'];
25231
+ /** An agreement this application has already accepted, and at which revision. */
25232
+ type AcceptedAgreement = components['schemas']['AcceptedAgreement'];
25233
+ /**
25234
+ * Someone permitted to accept this application's agreements.
25235
+ *
25236
+ * An id and a display name, and NOTHING else about the person: the credential
25237
+ * that reaches this endpoint travels in an emailed URL, and date of birth,
25238
+ * nationality and email are exactly what that scoping exists to keep out.
25239
+ */
25240
+ type LegalAcceptanceAttestor = components['schemas']['LegalAcceptanceAttestor'];
25241
+ /**
25242
+ * What an accept-agreements page renders: the agreements still owed, and the
25243
+ * people permitted to accept them.
25244
+ *
25245
+ * Deliberately NOT the application — see
25246
+ * {@link ApplicationsResource.getLegalAcceptance}.
25247
+ */
25248
+ type LegalAcceptanceContext = components['schemas']['LegalAcceptanceContext'];
25249
+ /**
25250
+ * One month of a client's reserve-management marketing-fee statement.
25251
+ *
25252
+ * Absent is not zero: `owed_minor` and `avg_daily_balance_minor` are absent
25253
+ * until the month is priced, and a zero there would instead assert that
25254
+ * nothing is owed.
25255
+ */
25256
+ type RDMarketingFeeStatement = components['schemas']['RDMarketingFeeStatement'];
25257
+ /**
25258
+ * One calendar day of a marketing-fee statement.
25259
+ *
25260
+ * Every day of the month gets a row. An ABSENT `balance_minor` means the day
25261
+ * is not stamped yet; a present `'0'` means the client genuinely held no RD
25262
+ * that day. The two are different facts and must not render alike.
25263
+ */
25264
+ type RDMarketingFeeDailyRow = components['schemas']['RDMarketingFeeDailyRow'];
24126
25265
  /** Country info */
24127
25266
  type Country = components['schemas']['Country'];
24128
25267
  /** Network info - generic structure for network responses */
@@ -24405,8 +25544,20 @@ type SelfServeCreditsPricingResponse = ClientPricingConfig;
24405
25544
  type SelfServeCreditsLedgerEntryType = SelfServeCreditsLedgerEntry['entry_type'];
24406
25545
  /** Parameters for listing self-serve credits ledger entries */
24407
25546
  interface SelfServeCreditsLedgerParams {
24408
- /** Cursor for pagination (ISO 8601 datetime) */
25547
+ /** Cursor for pagination (ISO 8601 datetime). Returns entries created BEFORE it. */
24409
25548
  cursor?: string;
25549
+ /**
25550
+ * Tiebreaker for `cursor` — pass the `id` of the last entry on the previous
25551
+ * page, alongside its `created_at` as `cursor`.
25552
+ *
25553
+ * Entries written in one transaction share an identical `created_at`, so
25554
+ * ordering by timestamp alone is not total and a page boundary landing
25555
+ * inside such a group SILENTLY DROPS rows. With both, entries come back
25556
+ * strictly before `(cursor, cursor_id)` in `(created_at, id)` order.
25557
+ *
25558
+ * Ignored unless `cursor` is also present.
25559
+ */
25560
+ cursor_id?: string;
24410
25561
  /** Number of entries to return (1-100, default 20) */
24411
25562
  limit?: number;
24412
25563
  /** Filter by entry type */
@@ -24483,38 +25634,215 @@ interface ListParams {
24483
25634
  limit?: number;
24484
25635
  [key: string]: unknown;
24485
25636
  }
24486
- /** Customer list parameters */
25637
+ /**
25638
+ * Customer list parameters.
25639
+ *
25640
+ * The `*_statuses` filters take a COMMA-SEPARATED list in one string, not an
25641
+ * array — `'active,frozen'`, not `['active', 'frozen']`.
25642
+ */
24487
25643
  interface CustomerListParams extends ListParams {
24488
25644
  external_id?: string;
25645
+ /** Name, email, or customer id. Case-insensitive. */
24489
25646
  search?: string;
25647
+ /** A single KYB status. Use `kyb_statuses` for several. */
24490
25648
  kyb_status?: KybStatus;
25649
+ /** Several KYB statuses, comma-separated (e.g. `'active,frozen'`). */
25650
+ kyb_statuses?: string;
25651
+ /**
25652
+ * Several effective KYC/B link statuses, comma-separated. Values mirror
25653
+ * `KybLinkStatus`: `not_started`, `pending`, `in_review`, `approved`,
25654
+ * `expired`, `rejected`.
25655
+ */
25656
+ kyc_statuses?: string;
25657
+ /**
25658
+ * Several onboarding application statuses, comma-separated. Values mirror
25659
+ * {@link ApplicationStatus}. Customers with NO application are excluded
25660
+ * when this filter is set.
25661
+ */
25662
+ application_statuses?: string;
25663
+ /**
25664
+ * Several unified customer statuses, comma-separated (e.g.
25665
+ * `'frozen,info_requested'`). Values mirror {@link CustomerStatus}.
25666
+ *
25667
+ * This is the one client-facing status the dashboard shows, filters, and
25668
+ * counts by — it collapses the frozen state, the application decision, and
25669
+ * the application lifecycle into a single value.
25670
+ */
25671
+ status?: string;
24491
25672
  sub_client_id?: string;
25673
+ /** True returns ONLY sub-clients. False or omitted returns everything. */
24492
25674
  is_sub_client?: boolean;
25675
+ /** Defaults to `name`. */
25676
+ sort_by?: 'application_status' | 'created_at' | 'customer_type' | 'id' | 'kyb_status' | 'kyc_status' | 'name' | 'status';
25677
+ /** Defaults to `asc`. */
25678
+ sort_dir?: 'asc' | 'desc';
25679
+ /** RFC 3339 lower bound on `created_at`. */
25680
+ created_at_from?: string;
25681
+ /** RFC 3339 upper bound on `created_at`. */
25682
+ created_at_to?: string;
25683
+ }
25684
+ /**
25685
+ * One page of customers, plus the per-status counts the dashboard header
25686
+ * renders. Returned by {@link CustomersResource.listPage}.
25687
+ */
25688
+ interface CustomerPage {
25689
+ data: Customer[];
25690
+ meta?: Meta;
25691
+ /**
25692
+ * Counts under the same filters but ignoring the `status` selection, so a
25693
+ * status chip keeps its count while it is the active filter. Absent when
25694
+ * the server did not compute them.
25695
+ */
25696
+ status_counts?: CustomerStatusCounts;
24493
25697
  }
24494
- /** Transaction list parameters */
24495
- interface TransactionListParams extends ListParams {
24496
- /** Filter by resource family: one_off, wallet, auto_account */
24497
- transaction_type?: 'one_off' | 'wallet' | 'auto_account';
25698
+ /** The transaction resource family a `GET /transactions` page belongs to. */
25699
+ type TransactionResourceType = components['schemas']['TransactionResourceType'];
25700
+ /**
25701
+ * Meta on a transaction list page.
25702
+ *
25703
+ * The shared pagination meta plus `transaction_type`, which names the family
25704
+ * the server actually listed — so an empty page still says what it searched,
25705
+ * and `total_count` is read as a count of that family alone.
25706
+ */
25707
+ type TransactionListMeta = components['schemas']['TransactionListMeta'];
25708
+ /** Filters every transaction family accepts. */
25709
+ interface TransactionListParamsBase extends ListParams {
24498
25710
  customer_id?: string;
25711
+ /** Free-text search across the family's rows. */
25712
+ search?: string;
25713
+ sort_by?: 'amount' | 'created_at' | 'customer_name' | 'status';
25714
+ sort_dir?: 'asc' | 'desc';
25715
+ /** RFC 3339 lower bound on `created_at`, inclusive. */
25716
+ created_at_from?: string;
25717
+ /** RFC 3339 upper bound on `created_at`, inclusive. */
25718
+ created_at_to?: string;
25719
+ /** Decimal string, e.g. `'100.00'`. */
25720
+ amount_min?: string;
25721
+ /** Decimal string, e.g. `'5000.00'`. */
25722
+ amount_max?: string;
25723
+ }
25724
+ /**
25725
+ * Filters for the `one_off` family — the default family of
25726
+ * {@link TransactionsResource.list}.
25727
+ */
25728
+ interface OneOffTransactionListParams extends TransactionListParamsBase {
25729
+ transaction_type?: 'one_off';
24499
25730
  destination_id?: string;
24500
25731
  status?: TransactionStatus;
25732
+ /** Several statuses at once, comma-separated (e.g. `'pending,completed'`). */
25733
+ statuses?: string;
24501
25734
  source_network_id?: string;
24502
25735
  source_asset?: string;
24503
25736
  destination_asset?: string;
24504
- /**
24505
- * Filter wallet transactions by wallet ID.
24506
- * Only valid with `transaction_type: 'wallet'`.
24507
- */
25737
+ }
25738
+ /**
25739
+ * Filters for the `wallet` family.
25740
+ *
25741
+ * `transaction_type: 'wallet'` is REQUIRED — it is the only way to reach this
25742
+ * family, and the server rejects `wallet_id` or `direction` without it with a
25743
+ * 400 rather than inferring it.
25744
+ */
25745
+ interface WalletTransactionListParams extends TransactionListParamsBase {
25746
+ transaction_type: 'wallet';
25747
+ /** Filter to one wallet. */
24508
25748
  wallet_id?: string;
24509
25749
  /**
24510
- * Filter wallet transactions by direction relative to the wallet:
24511
- * - `'out'` — transactions sent FROM the wallet
24512
- * - `'in'` — transactions recorded with the wallet as the recipient
24513
- *
24514
- * Only valid with `transaction_type: 'wallet'`.
25750
+ * Direction relative to the wallet:
25751
+ * - `'out'` — sent FROM the wallet
25752
+ * - `'in'` — recorded with the wallet as the recipient
24515
25753
  */
24516
25754
  direction?: 'in' | 'out';
24517
25755
  }
25756
+ /**
25757
+ * Filters for the `auto_account` family.
25758
+ *
25759
+ * `customer_id` is required: the server rejects
25760
+ * `transaction_type=auto_account` without one with a 400.
25761
+ */
25762
+ interface AutoAccountTransactionListParams extends TransactionListParamsBase {
25763
+ transaction_type: 'auto_account';
25764
+ customer_id: string;
25765
+ }
25766
+ /**
25767
+ * Transaction list parameters, discriminated by family.
25768
+ *
25769
+ * `GET /transactions` serves three families from one path and infers the
25770
+ * family from the filters when `transaction_type` is absent — so the type is
25771
+ * a union rather than one bag of optional fields, and a wallet-only filter
25772
+ * cannot be written without naming the wallet family.
25773
+ */
25774
+ type TransactionListParams = OneOffTransactionListParams | WalletTransactionListParams | AutoAccountTransactionListParams;
25775
+ /**
25776
+ * Auto-transaction list parameters.
25777
+ *
25778
+ * `statuses` and `types` take a COMMA-SEPARATED string, not an array. Dates
25779
+ * are Unix epoch SECONDS, not ISO strings — unlike every other list endpoint
25780
+ * here.
25781
+ */
25782
+ interface AutoTransactionListParams extends ListParams {
25783
+ auto_account_id?: string;
25784
+ destination_id?: string;
25785
+ status?: TransactionStatus;
25786
+ /** Several statuses at once, comma-separated (e.g. `'pending,processing'`). */
25787
+ statuses?: string;
25788
+ type?: string;
25789
+ /** Several types at once, comma-separated (e.g. `'onramp,offramp'`). */
25790
+ types?: string;
25791
+ provider_id?: string;
25792
+ source_crypto_address?: string;
25793
+ destination_crypto_address?: string;
25794
+ source_network_id?: string;
25795
+ destination_network_id?: string;
25796
+ transaction_hash?: string;
25797
+ /** Created on or after this instant. Epoch SECONDS. */
25798
+ start_date?: number;
25799
+ /** Created on or before this instant. Epoch SECONDS. */
25800
+ end_date?: number;
25801
+ input_asset?: string;
25802
+ destination_asset?: string;
25803
+ /** Decimal string, e.g. `'100.00'`. */
25804
+ outgoing_amount_min?: string;
25805
+ /** Decimal string, e.g. `'5000.00'`. */
25806
+ outgoing_amount_max?: string;
25807
+ /** Only `created_at` is supported today, which is also the default. */
25808
+ sort_by?: 'created_at';
25809
+ /** Defaults to `desc`. */
25810
+ sort_dir?: 'asc' | 'desc';
25811
+ }
25812
+ /** Destination list parameters. */
25813
+ interface DestinationListParams extends ListParams {
25814
+ destination_type?: 'crypto' | 'fiat_us' | 'fiat_iban';
25815
+ }
25816
+ /** User list parameters. */
25817
+ interface UserListParams extends ListParams {
25818
+ /** Fuzzy match across first/last name, email, and user id. */
25819
+ search?: string;
25820
+ /** ISO 8601, e.g. `'2026-01-01T00:00:00Z'`. */
25821
+ created_at_from?: string;
25822
+ /** ISO 8601, e.g. `'2026-12-31T23:59:59Z'`. */
25823
+ created_at_to?: string;
25824
+ /** One or more roles, comma-separated (e.g. `'admin,member'`). */
25825
+ roles?: string;
25826
+ /** Defaults to `created_at`. */
25827
+ sort_by?: 'created_at' | 'email' | 'name' | 'role';
25828
+ /** Defaults to `desc`. */
25829
+ sort_dir?: 'asc' | 'desc';
25830
+ }
25831
+ /**
25832
+ * Which extra sections to inline on an application read.
25833
+ *
25834
+ * Comma-separated, e.g. `'entities,validation'`, or `'all'`. Each section adds
25835
+ * weight to the response — `'all'` carries the full KYB record, including every
25836
+ * associated individual's date of birth, nationality and email — so ask for
25837
+ * what the page renders rather than defaulting to `'all'`.
25838
+ *
25839
+ * To render an accept-agreements page, use
25840
+ * {@link ApplicationsResource.getLegalAcceptance} instead: it returns exactly
25841
+ * that page's inputs and none of the personal data.
25842
+ */
25843
+ interface ApplicationGetParams {
25844
+ include?: string;
25845
+ }
24518
25846
  /** Event list parameters */
24519
25847
  interface EventListParams extends ListParams {
24520
25848
  event_type?: string;
@@ -24620,12 +25948,6 @@ type InsightItem = components['schemas']['InsightItem'];
24620
25948
  type InsightEvidence = components['schemas']['InsightEvidence'];
24621
25949
  /** The typed-facts snapshot inside an InsightReport. */
24622
25950
  type InsightSnapshot = components['schemas']['InsightSnapshot'];
24623
- /** One conversation turn for the insight chat. */
24624
- type InsightChatMessage = components['schemas']['InsightChatMessage'];
24625
- /** Request body for POST /customers/{id}/insights/chat (stateless; send the whole conversation). */
24626
- type InsightChatRequest = components['schemas']['InsightChatRequest'];
24627
- /** The insight-chat assistant's reply. */
24628
- type InsightChatResponse = components['schemas']['InsightChatResponse'];
24629
25951
  /** Parameters for listing mandates. */
24630
25952
  interface MandateListParams extends ListParams {
24631
25953
  customer_id?: string;
@@ -24647,6 +25969,25 @@ interface ScheduledPaymentListParams extends ListParams {
24647
25969
  * combination, e.g. 'scheduled,executed'. Omit for all.
24648
25970
  */
24649
25971
  status?: NonNullable<ScheduledPayment['status']> | (string & NonNullable<unknown>);
25972
+ /**
25973
+ * Only payments that executed under this VERSION of the mandate — "which
25974
+ * payments were judged against v2's caps".
25975
+ *
25976
+ * Use together with `mandate_id`, and like it this matches EXECUTED rows
25977
+ * only: the version is stamped at fire time, so a scheduled-but-unfired row
25978
+ * carries none.
25979
+ */
25980
+ mandate_version?: number;
25981
+ /**
25982
+ * 1-based page number, used only alongside `limit`.
25983
+ *
25984
+ * On its own it has nothing to page through and is ignored. A page past the
25985
+ * end is an empty list, not an error.
25986
+ *
25987
+ * Note this endpoint returns EVERY matching payment when `limit` is omitted
25988
+ * — the iterator's usual cursor paging does not apply here.
25989
+ */
25990
+ page?: number;
24650
25991
  }
24651
25992
 
24652
25993
  /**
@@ -24711,11 +26052,41 @@ declare class CustomersResource extends BaseResource {
24711
26052
  * // With filters
24712
26053
  * const active = client.customers.list({ kyb_status: 'active' });
24713
26054
  *
26055
+ * // Several statuses at once — one comma-separated string, not an array
26056
+ * const needsAttention = client.customers.list({
26057
+ * status: 'info_requested,frozen',
26058
+ * });
26059
+ *
24714
26060
  * // Collect all to array
24715
26061
  * const all = await client.customers.list().toArray();
24716
26062
  * ```
24717
26063
  */
24718
26064
  list(params?: CustomerListParams): PaginatedIterator<Customer>;
26065
+ /**
26066
+ * One page of customers, with the per-status counts.
26067
+ *
26068
+ * {@link list} iterates rows and drops the envelope, so `status_counts` —
26069
+ * the counts a dashboard's status header renders — is unreachable through
26070
+ * it. This returns the raw page instead: same filters, one request, no
26071
+ * iteration.
26072
+ *
26073
+ * The counts are computed under the same filters but IGNORING the `status`
26074
+ * selection, so every chip keeps its count while one of them is the active
26075
+ * filter.
26076
+ *
26077
+ * @param params - The same filters {@link list} accepts
26078
+ * @returns One page: rows, pagination meta, and `status_counts`
26079
+ *
26080
+ * @example
26081
+ * ```typescript
26082
+ * const page = await client.customers.listPage({ limit: 25 });
26083
+ * console.log(page.status_counts?.info_requested ?? 0);
26084
+ * for (const customer of page.data) {
26085
+ * console.log(customer.name, customer.status);
26086
+ * }
26087
+ * ```
26088
+ */
26089
+ listPage(params?: CustomerListParams): Promise<CustomerPage>;
24719
26090
  /**
24720
26091
  * Get a customer by ID.
24721
26092
  *
@@ -25061,7 +26432,7 @@ declare class DestinationsResource extends BaseResource {
25061
26432
  * }
25062
26433
  * ```
25063
26434
  */
25064
- list(recipientId: string, params?: ListParams): PaginatedIterator<Destination>;
26435
+ list(recipientId: string, params?: DestinationListParams): PaginatedIterator<Destination>;
25065
26436
  /**
25066
26437
  * Delete a destination.
25067
26438
  *
@@ -25204,6 +26575,18 @@ declare class AccountsResource extends BaseResource {
25204
26575
  * Transactions resource.
25205
26576
  */
25206
26577
 
26578
+ /**
26579
+ * The row shape `GET /transactions` yields for a given set of filters.
26580
+ *
26581
+ * The family decides the shape, so the filters decide the element type: name
26582
+ * `wallet` or `auto_account` and you get that family's rows, anything else is
26583
+ * the `one_off` family this endpoint defaults to.
26584
+ */
26585
+ type TransactionRowFor<P extends TransactionListParams | undefined> = P extends {
26586
+ transaction_type: 'wallet';
26587
+ } ? WalletTransaction : P extends {
26588
+ transaction_type: 'auto_account';
26589
+ } ? AutoTransaction : OneOffTransaction;
25207
26590
  /**
25208
26591
  * Transactions API resource.
25209
26592
  */
@@ -25242,25 +26625,56 @@ declare class TransactionsResource extends BaseResource {
25242
26625
  */
25243
26626
  create(data: OneOffTransactionRequest, options?: RequestOptions): Promise<OneOffTransaction>;
25244
26627
  /**
25245
- * List one-off transactions.
26628
+ * List transactions.
26629
+ *
26630
+ * `GET /transactions` serves three resource families from one path, and the
26631
+ * family decides the row shape — so the family you ask for decides what this
26632
+ * iterator yields:
26633
+ *
26634
+ * | `transaction_type` | Yields |
26635
+ * |--------------------|--------|
26636
+ * | omitted or `'one_off'` | {@link OneOffTransaction} |
26637
+ * | `'wallet'` | {@link WalletTransaction} |
26638
+ * | `'auto_account'` | {@link AutoTransaction} (requires `customer_id`) |
26639
+ *
26640
+ * **The family is always named on the wire.** Left to the server, it is
26641
+ * INFERRED from the other filters, and `customer_id` on its own infers
26642
+ * `auto_account` — so `list({ customer_id })` would return that customer's
26643
+ * auto-account transactions while this method's type promised one-off ones.
26644
+ * Those rows parse into `OneOffTransaction` with missing fields rather than
26645
+ * failing, so nothing surfaced the substitution. Omitting the family here
26646
+ * therefore sends `transaction_type=one_off` rather than leaving it open.
26647
+ *
26648
+ * The family the server reports back (`meta.transaction_type`) is checked
26649
+ * against the one requested, and a mismatch throws instead of yielding rows
26650
+ * of the wrong shape.
25246
26651
  *
25247
26652
  * @param params - Filter and pagination parameters
25248
- * @returns Async iterator of transactions
26653
+ * @returns Async iterator over the requested family
25249
26654
  *
25250
26655
  * @example
25251
26656
  * ```typescript
25252
- * // List all transactions
26657
+ * // One-off transactions (the default family)
25253
26658
  * for await (const tx of client.transactions.list()) {
25254
26659
  * console.log(tx.id, tx.status);
25255
26660
  * }
25256
26661
  *
25257
- * // Filter by customer and status
26662
+ * // This customer's ONE-OFF transactions
25258
26663
  * const completed = client.transactions.list({
25259
26664
  * customer_id: customerId,
25260
26665
  * status: 'completed',
25261
26666
  * });
25262
26667
  *
25263
- * // Wallet-scoped filters (require transaction_type: 'wallet')
26668
+ * // This customer's AUTO-ACCOUNT transactions — a different family,
26669
+ * // and a different row shape
26670
+ * for await (const tx of client.transactions.list({
26671
+ * transaction_type: 'auto_account',
26672
+ * customer_id: customerId,
26673
+ * })) {
26674
+ * console.log(tx.id);
26675
+ * }
26676
+ *
26677
+ * // Wallet transactions
25264
26678
  * const sent = client.transactions.list({
25265
26679
  * transaction_type: 'wallet',
25266
26680
  * wallet_id: walletId,
@@ -25268,7 +26682,7 @@ declare class TransactionsResource extends BaseResource {
25268
26682
  * });
25269
26683
  * ```
25270
26684
  */
25271
- list(params?: TransactionListParams): PaginatedIterator<OneOffTransaction>;
26685
+ list<P extends TransactionListParams | undefined = undefined>(params?: P): PaginatedIterator<TransactionRowFor<P>>;
25272
26686
  /**
25273
26687
  * Get a transaction by ID.
25274
26688
  *
@@ -25306,10 +26720,24 @@ declare class AutoTransactionsResource extends BaseResource {
25306
26720
  /**
25307
26721
  * List auto transactions.
25308
26722
  *
25309
- * @param params - Pagination parameters
26723
+ * `statuses` and `types` take a comma-separated string, not an array, and
26724
+ * `start_date` / `end_date` are Unix epoch SECONDS rather than the ISO
26725
+ * strings the other list endpoints take.
26726
+ *
26727
+ * @param params - Filter and pagination parameters
25310
26728
  * @returns Async iterator of auto transactions
26729
+ *
26730
+ * @example
26731
+ * ```typescript
26732
+ * const recent = client.autoTransactions.list({
26733
+ * auto_account_id: accountId,
26734
+ * statuses: 'pending,processing',
26735
+ * start_date: Math.floor(Date.now() / 1000) - 86_400,
26736
+ * sort_dir: 'desc',
26737
+ * });
26738
+ * ```
25311
26739
  */
25312
- list(params?: ListParams): PaginatedIterator<AutoTransaction>;
26740
+ list(params?: AutoTransactionListParams): PaginatedIterator<AutoTransaction>;
25313
26741
  /**
25314
26742
  * Get an auto transaction by ID.
25315
26743
  *
@@ -25502,10 +26930,28 @@ declare class ApplicationsResource extends BaseResource {
25502
26930
  /**
25503
26931
  * Get an application by ID.
25504
26932
  *
26933
+ * `include` inlines extra sections — a comma-separated list of `entities`,
26934
+ * `validation`, `edd`, `attestations`, or `all`. Each adds weight, and
26935
+ * `'all'` carries the full KYB record including every associated
26936
+ * individual's date of birth, nationality and email, so ask for what the
26937
+ * page renders.
26938
+ *
26939
+ * To render an accept-agreements page, use {@link getLegalAcceptance}
26940
+ * instead: it returns exactly that page's inputs and none of the personal
26941
+ * data.
26942
+ *
25505
26943
  * @param applicationId - Application ID
26944
+ * @param params - Optional `{ include }`
25506
26945
  * @returns Application record
26946
+ *
26947
+ * @example
26948
+ * ```typescript
26949
+ * const app = await client.applications.get(applicationId, {
26950
+ * include: 'entities,validation',
26951
+ * });
26952
+ * ```
25507
26953
  */
25508
- get(applicationId: string): Promise<Application>;
26954
+ get(applicationId: string, params?: ApplicationGetParams): Promise<Application>;
25509
26955
  /**
25510
26956
  * Submit an application for review.
25511
26957
  *
@@ -25561,6 +27007,43 @@ declare class ApplicationsResource extends BaseResource {
25561
27007
  * @param individualId - Individual ID
25562
27008
  */
25563
27009
  deleteIndividual(applicationId: string, individualId: string): Promise<void>;
27010
+ /**
27011
+ * What this application still needs to accept, and who may accept it.
27012
+ *
27013
+ * Exactly what an accept-agreements page renders, and deliberately nothing
27014
+ * more. `get(applicationId)` would answer with the full KYB record — the
27015
+ * business entity, and every associated individual's date of birth,
27016
+ * nationality and email — none of which that page displays. The link that
27017
+ * reaches this endpoint is EMAILED and travels in a URL query string, so its
27018
+ * credential is scoped to this call and the attestation submission, and
27019
+ * cannot read the application.
27020
+ *
27021
+ * Authenticates with an Application Token (`X-Application-Token`), including
27022
+ * the narrow legal-acceptance token a terms refusal issues.
27023
+ *
27024
+ * The documents come back as identity only. Fetch the text to display with
27025
+ * `client.legal.get(key)`, then pass the `version` you displayed back as
27026
+ * `legal_document_version` on {@link submitAttestation}.
27027
+ *
27028
+ * @param applicationId - Application ID
27029
+ * @returns Outstanding agreements, prior acceptances, and permitted attestors
27030
+ *
27031
+ * @example
27032
+ * ```typescript
27033
+ * const ctx = await client.applications.getLegalAcceptance(applicationId);
27034
+ *
27035
+ * for (const doc of ctx.outstanding_documents) {
27036
+ * const text = await client.legal.get(doc.key, doc.version);
27037
+ * render(text.content);
27038
+ * }
27039
+ *
27040
+ * // A business may have several control persons; an individual application
27041
+ * // has exactly one permissible attestor, so there is nobody to pick.
27042
+ * const attestor =
27043
+ * ctx.application_type === 'individual' ? ctx.attestors[0] : await pick(ctx.attestors);
27044
+ * ```
27045
+ */
27046
+ getLegalAcceptance(applicationId: string): Promise<LegalAcceptanceContext>;
25564
27047
  /**
25565
27048
  * Submit an attestation for an application.
25566
27049
  *
@@ -25981,7 +27464,7 @@ declare class UsersResource extends BaseResource {
25981
27464
  * @param params - Pagination parameters
25982
27465
  * @returns Async iterator of users
25983
27466
  */
25984
- list(params?: ListParams): PaginatedIterator<User>;
27467
+ list(params?: UserListParams): PaginatedIterator<User>;
25985
27468
  /**
25986
27469
  * Update a user.
25987
27470
  *
@@ -26118,6 +27601,134 @@ declare class InfoResource extends BaseResource {
26118
27601
  getNetworks(): Promise<string[]>;
26119
27602
  }
26120
27603
 
27604
+ /**
27605
+ * Legal documents resource.
27606
+ */
27607
+
27608
+ /**
27609
+ * Legal Documents API resource.
27610
+ *
27611
+ * The published terms a customer accepts during onboarding. **Unauthenticated**
27612
+ * — integrators need these before a customer relationship exists, so the
27613
+ * endpoints carry no credential and are safe to call from a signup page.
27614
+ */
27615
+ declare class LegalResource extends BaseResource {
27616
+ /**
27617
+ * List the revision of every legal document currently in force.
27618
+ *
27619
+ * An INDEX, not a bundle: each entry names a document and its in-force
27620
+ * revision, without the text. Fetch {@link get} for the one document you
27621
+ * are about to display — inlining every document would put the whole corpus
27622
+ * on every call.
27623
+ *
27624
+ * Not safe to cache indefinitely: it names whichever revision is in force
27625
+ * NOW, and that changes when a new one is published. A specific
27626
+ * `(key, version)` from {@link get} is a different matter — revisions are
27627
+ * immutable, so that text can be cached for as long as you like.
27628
+ *
27629
+ * @returns The in-force revision of each document, without its text
27630
+ *
27631
+ * @example
27632
+ * ```typescript
27633
+ * for (const doc of await client.legal.list()) {
27634
+ * console.log(doc.key, doc.version, doc.title);
27635
+ * }
27636
+ * ```
27637
+ */
27638
+ list(): Promise<LegalDocument[]>;
27639
+ /**
27640
+ * Get one legal document — the revision in force, or a specific one.
27641
+ *
27642
+ * Pass the `version` you displayed back as `legal_document_version` when
27643
+ * submitting an attestation, so the acceptance record names the exact text
27644
+ * the customer saw rather than whichever revision happened to be current
27645
+ * when the request arrived.
27646
+ *
27647
+ * @param documentKey - Document identifier, e.g. `'dakota_tos'`
27648
+ * @param version - A specific published revision. Omit for the one in force
27649
+ * @returns The requested revision, including its text
27650
+ *
27651
+ * @example
27652
+ * ```typescript
27653
+ * const tos = await client.legal.get('dakota_tos');
27654
+ * render(tos.content);
27655
+ *
27656
+ * await client.applications.submitAttestation(applicationId, {
27657
+ * attestation_type: 'terms_of_service',
27658
+ * legal_document_version: tos.version, // records what they actually saw
27659
+ * // ...
27660
+ * });
27661
+ * ```
27662
+ */
27663
+ get(documentKey: string, version?: string): Promise<LegalDocument>;
27664
+ }
27665
+
27666
+ /**
27667
+ * Reserve-management marketing-fee statements resource.
27668
+ */
27669
+
27670
+ /**
27671
+ * RD Marketing Fee API resource.
27672
+ *
27673
+ * The reserve-management statements for the calling client. The client comes
27674
+ * from the session and is never named in a request, so there is no id to pass
27675
+ * and no other client's statements to address.
27676
+ *
27677
+ * A client who has never had a rate gets a **404** from both methods: holding a
27678
+ * rate is what being in the programme means, and there is no separate
27679
+ * entitlement record to read.
27680
+ */
27681
+ declare class RDMarketingFeeResource extends BaseResource {
27682
+ /**
27683
+ * The months this client has a statement for, newest first.
27684
+ *
27685
+ * Runs from the start of their contract to the running month, and the
27686
+ * RUNNING month IS included. It cannot be priced yet — the bank's interest
27687
+ * posts in the month after it is earned — but the balance is real and
27688
+ * accruing, and a client checking mid-month has to be able to see it. Its
27689
+ * fee figures come back absent rather than zero.
27690
+ *
27691
+ * An EMPTY list means the contract is real but no month has started yet.
27692
+ * That is different from a 404, which means no contract at all.
27693
+ *
27694
+ * @returns Statement months as `YYYY-MM-DD` (first day of the month, UTC)
27695
+ *
27696
+ * @example
27697
+ * ```typescript
27698
+ * const months = await client.rdMarketingFee.listMonths();
27699
+ * if (months.length === 0) {
27700
+ * // Contract starts next month or later — "starting soon", not an error.
27701
+ * }
27702
+ * ```
27703
+ */
27704
+ listMonths(): Promise<string[]>;
27705
+ /**
27706
+ * One month's statement — one row per calendar day: the date, the RD
27707
+ * balance, and that day's fee.
27708
+ *
27709
+ * The rows are the STORED daily principals, read rather than recomputed, so
27710
+ * what the client reads and what Dakota priced cannot drift.
27711
+ *
27712
+ * Absent is not zero. A balance is absent when the day has not been derived
27713
+ * yet and `'0'` when the client genuinely held no RD; fees are absent for
27714
+ * every day of a month whose rate has not been derived. Neither unknown is
27715
+ * reported as a zero, so render an absent figure as unknown rather than
27716
+ * defaulting it.
27717
+ *
27718
+ * @param month - First day of the month, UTC, as `YYYY-MM-DD`
27719
+ * @returns The month's statement, one row per day
27720
+ *
27721
+ * @example
27722
+ * ```typescript
27723
+ * const statement = await client.rdMarketingFee.getStatement('2026-08-01');
27724
+ * for (const day of statement.daily) {
27725
+ * console.log(day.date, day.balance_minor ?? 'not yet derived');
27726
+ * }
27727
+ * ```
27728
+ */
27729
+ getStatement(month: string): Promise<RDMarketingFeeStatement>;
27730
+ }
27731
+
26121
27732
  /**
26122
27733
  * Sandbox resource for testing simulations.
26123
27734
  *
@@ -26379,6 +27990,17 @@ declare class SelfServeResource extends BaseResource {
26379
27990
  * type: 'purchase',
26380
27991
  * limit: 50,
26381
27992
  * });
27993
+ *
27994
+ * // Paging: carry BOTH halves of the cursor. Entries written in one
27995
+ * // transaction share a created_at, so a page boundary inside such a
27996
+ * // group drops rows when only `cursor` is sent.
27997
+ * const last = purchases.entries[purchases.entries.length - 1];
27998
+ * const next = await client.selfServe.listLedger({
27999
+ * type: 'purchase',
28000
+ * limit: 50,
28001
+ * cursor: last.created_at,
28002
+ * cursor_id: last.id,
28003
+ * });
26382
28004
  * ```
26383
28005
  */
26384
28006
  listLedger(params?: SelfServeCreditsLedgerParams): Promise<SelfServeCreditsLedgerResponse>;
@@ -26542,10 +28164,10 @@ declare class PaymentAgentsResource extends BaseResource {
26542
28164
  * alternatives. Branch on `blocker.code`, not on `reply`, and ignore codes
26543
28165
  * you do not recognize.
26544
28166
  *
26545
- * `data.client_policy` is a DEVELOPMENT override of the vocabulary the
26546
- * agent drafts under; prefer registering it once with
26547
- * `client.agenticPolicy.set()`, since forgetting to send it here fails
26548
- * silently.
28167
+ * The vocabulary the agent drafts under is the one registered with
28168
+ * `client.agenticPolicy.set()`. It is not a property of this request —
28169
+ * a policy sent here is ignored, which is why the option to send one is
28170
+ * gone.
26549
28171
  *
26550
28172
  * @param paymentAgentId - Payment agent ID
26551
28173
  * @param data - Prompt and/or messages
@@ -26601,7 +28223,7 @@ declare class InstructionsResource extends BaseResource {
26601
28223
  /**
26602
28224
  * Accept proposals — actuate them into persisted instructions.
26603
28225
  *
26604
- * Two optional fields shape the actuation:
28226
+ * One optional field shapes the actuation:
26605
28227
  *
26606
28228
  * - `developer_fee` declares your fee PER PAYOUT TYPE — `swap_bps` for a
26607
28229
  * crypto payout, `offramp_bps` for a bank payout. They are independent,
@@ -26611,8 +28233,10 @@ declare class InstructionsResource extends BaseResource {
26611
28233
  * amount, and the agent is told nothing about a fee it could mention.
26612
28234
  * Both are DEFAULTS for the auto-accounts this request creates — an
26613
28235
  * action-level `fee_bps` still wins outright.
26614
- * - `client_policy` is the same development override the proposals call
26615
- * takes. Prefer registering it once with `client.agenticPolicy.set()`.
28236
+ *
28237
+ * The vocabulary the actuation is judged against comes from the policy
28238
+ * registered with `client.agenticPolicy.set()` — the same one the drafting
28239
+ * turn used, which is the point of registering it rather than sending it.
26616
28240
  *
26617
28241
  * @param data - The payment agent id and the proposals to accept
26618
28242
  * @returns instruction_ids + the mandates the batch drafted (in full
@@ -26847,25 +28471,6 @@ declare class InsightsResource extends BaseResource {
26847
28471
  * @returns The customer's insight report
26848
28472
  */
26849
28473
  get(customerId: string): Promise<InsightReport>;
26850
- /**
26851
- * Ask about the customer's account.
26852
- *
26853
- * A read-only, advisory conversation. Stateless: send the conversation so
26854
- * far in `messages` on each call; the response is the assistant's next
26855
- * plain-text `reply`. The assistant narrates the same deterministic report
26856
- * {@link get} returns — it never originates a number, never proposes, and
26857
- * never moves money. Rate-limited per customer (hourly burst + daily
26858
- * window) — a 429 means back off and retry later.
26859
- *
26860
- * Model-backed, so it defaults to {@link AGENTIC_MODEL_TIMEOUT_MS} rather
26861
- * than the client's ordinary deadline. Pass `{ timeout }` to change it for
26862
- * one call; an explicit client-wide `timeout` still wins.
26863
- *
26864
- * @param customerId - Customer ID
26865
- * @param data - The conversation so far (1–40 messages)
26866
- * @returns The assistant's reply (+ how the boundary screen treated the turn)
26867
- */
26868
- chat(customerId: string, data: InsightChatRequest, options?: RequestOptions): Promise<InsightChatResponse>;
26869
28474
  }
26870
28475
 
26871
28476
  /**
@@ -26911,11 +28516,13 @@ declare class AgenticPolicyResource extends BaseResource {
26911
28516
  /**
26912
28517
  * Register — or fully replace — this client's agentic policy.
26913
28518
  *
26914
- * Declaring the vocabulary once removes a silent failure mode. Sending
26915
- * `client_policy` in each proposals request still works and still wins, but
26916
- * FORGETTING to send it fails silently: the agent just narrates in the
26917
- * platform's nouns again ("destination", "mandate") and nothing errors
26918
- * anywhere. A registration makes that impossible.
28519
+ * Registration is the ONLY way to set a policy. A policy is a property of
28520
+ * the CLIENT, not of a request: carried per request, a drafting turn and
28521
+ * the accept that followed it could be judged by different rules. The
28522
+ * platform accordingly stopped reading `client_policy` from request bodies,
28523
+ * and one sent there is now ignored — silently, since the agent simply
28524
+ * narrates in the platform's nouns again ("destination", "mandate") with no
28525
+ * error anywhere. Registering once removes that failure mode.
26919
28526
  *
26920
28527
  * FULL REPLACE, not a merge — the registration IS your declared vocabulary,
26921
28528
  * so an omitted field means you no longer want it, and an empty body (`{}`)
@@ -27021,10 +28628,19 @@ interface ConversationTurn {
27021
28628
  /** Whether the turn reported any blocker. */
27022
28629
  hasBlockers: boolean;
27023
28630
  /**
27024
- * The boundary screen's verdict for this turn: `"ok"` (normal), `"warned"`
27025
- * (off-topic — the customer was warned), or `"blocked"` (the chat is
27026
- * terminated; stop serving and offer a fresh conversation). Empty when
27027
- * the platform sent none.
28631
+ * The boundary screen's verdict for this turn:
28632
+ *
28633
+ * - `"ok"` — normal payments turn.
28634
+ * - `"warned"` — off-topic; the customer was warned but may continue.
28635
+ * - `"blocked"` — the chat is terminated; stop serving it and offer a fresh
28636
+ * conversation.
28637
+ * - `"rejected_input"` — this message was refused WHOLESALE (e.g. more
28638
+ * payees than one conversation supports). `reply` explains what to
28639
+ * resend; the conversation continues unaffected, and the SDK has already
28640
+ * dropped the refused message from the transcript for you.
28641
+ *
28642
+ * Empty when the platform sent none. Treat it as an OPEN set — new values
28643
+ * may be added.
27028
28644
  */
27029
28645
  conversationStatus: string;
27030
28646
  }
@@ -27058,19 +28674,19 @@ interface AgentConversationOptions {
27058
28674
  */
27059
28675
  timeout?: number;
27060
28676
  /**
27061
- * Per-turn `client_policy` override — the vocabulary and payout
27062
- * constraints the agent drafts under.
28677
+ * Your developer fee, declared PER PAYOUT TYPE — `swap_bps` for a crypto
28678
+ * payout, `offramp_bps` for a bank one. The two are independent, so one
28679
+ * conversation can charge a swap and stay silent about a bank payout.
27063
28680
  *
27064
- * This is a DEVELOPMENT override. It wins for the turns of this
27065
- * conversation and the server logs that it did. For production, register
27066
- * the policy once with `client.agenticPolicy.set(policy)`
27067
- * instead: forgetting to pass it here fails SILENTLY — the agent simply
27068
- * narrates in the platform's nouns again, with no error anywhere.
28681
+ * Set it here as well as on `instructions.create()`, not instead of it.
28682
+ * The accept is what CHARGES the fee; declaring it on the drafting turn is
28683
+ * what lets the agent MENTION it — omit it and the agent is told nothing
28684
+ * about a fee it could name, so the customer approves a summary that never
28685
+ * disclosed one and then gets charged it.
27069
28686
  *
27070
- * Resolution per request is: a non-empty policy here, else the client's
27071
- * registration, else platform defaults.
28687
+ * Resent on every turn, since the endpoint is stateless.
27072
28688
  */
27073
- clientPolicy?: AgenticClientPolicy;
28689
+ developerFee?: DeveloperFee;
27074
28690
  }
27075
28691
  /**
27076
28692
  * A stateful, multi-turn proposals chat with one agent.
@@ -27089,7 +28705,7 @@ declare class AgentConversation {
27089
28705
  private readonly paymentAgentId;
27090
28706
  private readonly timezone?;
27091
28707
  private readonly timeout?;
27092
- private readonly clientPolicy?;
28708
+ private readonly developerFee?;
27093
28709
  private history;
27094
28710
  constructor(client: DakotaClient, paymentAgentId: string, history?: ChatMessage[], options?: AgentConversationOptions);
27095
28711
  /**
@@ -27184,6 +28800,10 @@ declare class DakotaClient {
27184
28800
  readonly webhooks: WebhooksResource;
27185
28801
  /** Info API - query platform capabilities */
27186
28802
  readonly info: InfoResource;
28803
+ /** Legal API - the published terms customers accept (unauthenticated) */
28804
+ readonly legal: LegalResource;
28805
+ /** RD Marketing Fee API - this client's reserve-management statements */
28806
+ readonly rdMarketingFee: RDMarketingFeeResource;
27187
28807
  /** Sandbox API - testing simulations (sandbox only) */
27188
28808
  readonly sandbox: SandboxResource;
27189
28809
  /** Self-Serve Credits API - manage prepaid transfer credits */
@@ -27302,10 +28922,32 @@ declare class APIError extends Error {
27302
28922
  readonly rawBody: string | null;
27303
28923
  /** Whether this error is safe to retry */
27304
28924
  readonly retryable: boolean;
28925
+ /**
28926
+ * A plain-language rendition of the problem, written for the END CUSTOMER,
28927
+ * when one exists for this error.
28928
+ *
28929
+ * `message` names request fields and actions so a machine caller can
28930
+ * self-correct. This says the same thing without API vocabulary. Show it
28931
+ * when relaying an error into a human surface (chat, email, UI), and fall
28932
+ * back to `message` when it is null.
28933
+ */
28934
+ readonly userMessage: string | null;
28935
+ /**
28936
+ * A link the customer can follow to CLEAR this error, present only on
28937
+ * problems with a concrete self-service remedy.
28938
+ *
28939
+ * Today `terms-not-accepted` returns one, pointing at the hosted flow where
28940
+ * the outstanding agreement can be signed. It is token-gated and usable
28941
+ * as-is — send the customer to it rather than parsing one out of the
28942
+ * message.
28943
+ */
28944
+ readonly resolutionUrl: string | null;
27305
28945
  constructor(statusCode: number, code: string, message: string, options?: {
27306
28946
  details?: Record<string, unknown> | null;
27307
28947
  requestId?: string | null;
27308
28948
  rawBody?: string | null;
28949
+ userMessage?: string | null;
28950
+ resolutionUrl?: string | null;
27309
28951
  });
27310
28952
  /**
27311
28953
  * Create an APIError from an HTTP response.
@@ -27622,4 +29264,4 @@ declare function verifyMandateSignature(publicKeyBase64: string, payload: Uint8A
27622
29264
  */
27623
29265
  declare function canonicalJSON(value: unknown): string;
27624
29266
 
27625
- export { APIError, type Account, type AccountCreateRequest, type AccountListParams, type AccountUpdateRequest, AccountsResource, type Address, type AdvanceSimulationRequest, type AdvanceSimulationResult, AgentConversation, type AgentConversationOptions, type AgenticAction, type AgenticActionDownstream, type AgenticBlocker, type AgenticBlockerCode, type AgenticClientPolicy, type AgenticInstruction, type AgenticInstructionsResult, AgenticPolicyResource, type AgenticProposal, type AgenticProposalsProgress, type AgenticProposalsResult, type AmendMandateRequest, type ApiKey, type ApiKeyCreateRequest, type ApiKeyResponse, ApiKeysResource, type Application, type ApplicationDocumentType, type ApplicationDocumentUploadRequest, type ApplicationDocumentUploadUrlRequest, type ApplicationListItem, type ApplicationStatus, type ApplicationSubmissionRequest, ApplicationsResource, type ApproveMandateRequest, type AssociatedIndividual, type AssociatedIndividualRequest, type AttachedPolicy, type AttachedWallet, type Attachment, type AttachmentMediaType, 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 CancelMandateRequest, type Capability, type CapabilityRequirement, type ChatMessage, type ClientPricingConfig, ConfigurationError, type ConversationTurn, type Country, type CreateApiKeyForClientRequest, type CreateInstructionsRequest, type CreateMandateRequest, type CreateProposalsRequest, type CreateScheduledPaymentRequest, type CryptoDestination, type CryptoDestinationRequest, type CursorExtractor, type Customer, type CustomerCapabilities, type CustomerCreateRequest, type CustomerCreateResponse, type CustomerListParams, type CustomerReEngagementResponse, CustomersResource, DEFAULT_RETRY_POLICY, DakotaClient, type DakotaClientConfig, type Destination, type DestinationCreateResponse, type DestinationRequest, DestinationsResource, type DeveloperFee, type DocumentUploadResponse, type DocumentUploadUrlResponse, type EDDRequest, type EDDWithApplicationID, type EmploymentStatus, type EndorsedRequest, Environment, type Event, type EventListParams, type EventType, EventsResource, type ExpectedMonthlyDeposit, type Family, type FeePayoutDestination, FeePayoutDestinationResource, type FiatUSDestination, type FiatUSDestinationRequest, type ImportPersonaTokensRequest, type ImportPersonaTokensResponse, type IndividualDetailsResponse, type IndividualDocumentType, type IndividualDocumentUploadRequest, type IndividualDocumentUploadUrlRequest, type IndividualRequest, type IndividualRole, type IndividualTitle, InfoResource, type InsightChatMessage, type InsightChatRequest, type InsightChatResponse, type InsightEvidence, type InsightItem, type InsightReport, type InsightSnapshot, InsightsResource, InstructionsResource, type KSUID, type KybStatus, type LegalStructure, type ListParams, type Logger, type Mandate, type MandateAction, type MandateBudget, type MandateBudgetLine, type MandateListParams, type MandateResponse, type MandateRule, type MandateSigner, type MandateVersion, MandatesResource, type Meta, type Network, type NetworkId, type OfframpAccount, type OfframpAccountCreateRequest, type OneOffTransaction, type OneOffTransactionRequest, type OnrampAccount, type OnrampAccountCreateRequest, P256MandateSigner, type PageFetcher, PaginatedIterator, type PaginatedResponse, type PaginationMeta, type PaginationParams, type PaymentAgent, type PaymentAgentCreateRequest, type PaymentAgentSignerGroupRef, PaymentAgentsResource, type PaymentCapability, type PersonName, type PersonaImportJob, type PersonaImportJobListParams, type PersonaImportJobParams, type PersonaImportJobSummary, type PersonaImportJobsPage, type PersonaImportRowResult, PoliciesResource, type Policy, type PolicyCreateRequest, type PolicyRule, type PolicyRuleCreateRequest, type PutFeePayoutDestinationRequest, type Recipient, type RecipientRequest, type RecipientUpdateRequest, RecipientsResource, type RegisteredAgenticClientPolicy, type RequestOptions, type ResolvedConfig, type RetryPolicy, SandboxResource, type SandboxScenario, type ScheduledPayment, type ScheduledPaymentListParams, ScheduledPaymentsResource, type SelfServeCreditTier, type SelfServeCreditTiersResponse, type SelfServeCreditsBalanceResponse, type SelfServeCreditsLedgerEntry, type SelfServeCreditsLedgerEntryType, type SelfServeCreditsLedgerParams, type SelfServeCreditsLedgerResponse, type SelfServeCreditsPricingResponse, type SelfServeCreditsPurchaseRequest, type SelfServeCreditsPurchaseResponse, SelfServeResource, type SendTransactionIntent, type Signer, type SignerCreateRequest, type SignerGroup, type SignerGroupCreateRequest, type SignerGroupGetParams, type SignerGroupSignerAddRequest, 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 UsdcWalletPayoutDestination, 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, addPolicyRulePayload, attachGroupPayload, attachPolicyPayload, attachUserToWallet, canonicalJSON, consoleLogger, deletePolicyPayload, detachGroupPayload, detachPolicyPayload, detachUserFromWallet, getEnvironmentURL, mandateAmendSignPayload, mandateSignPayload, noopLogger, paginate, removePolicyRulePayload, updatePolicyRulePayload, verifyMandateSignature };
29267
+ export { APIError, type AcceptedAgreement, type Account, type AccountCreateRequest, type AccountListParams, type AccountUpdateRequest, AccountsResource, type Address, type AdvanceSimulationRequest, type AdvanceSimulationResult, AgentConversation, type AgentConversationOptions, type AgenticAction, type AgenticActionDownstream, type AgenticBlocker, type AgenticBlockerCode, type AgenticClientPolicy, type AgenticInstruction, type AgenticInstructionsResult, AgenticPolicyResource, type AgenticProposal, type AgenticProposalsProgress, type AgenticProposalsResult, type AmendMandateRequest, type ApiKey, type ApiKeyCreateRequest, type ApiKeyResponse, ApiKeysResource, type Application, type ApplicationDocumentType, type ApplicationDocumentUploadRequest, type ApplicationDocumentUploadUrlRequest, type ApplicationGetParams, type ApplicationListItem, type ApplicationStatus, type ApplicationSubmissionRequest, ApplicationsResource, type ApproveMandateRequest, type AssociatedIndividual, type AssociatedIndividualRequest, type AttachedPolicy, type AttachedWallet, type Attachment, type AttachmentMediaType, type AttestationSubmitRequest, type AttestationType, AuthMode, type AutoAccountTransactionListParams, type AutoTransaction, type AutoTransactionListParams, AutoTransactionsResource, type AverageMonthlyRevenue, type BulkImportSumsubTokensRequest, type BulkImportSumsubTokensResponse, type BulkImportSumsubTokensResult, type BusinessApplicationCreateRequest, type BusinessDetailsResponse, type BusinessPurposeOfAccount, type BusinessSourceOfFunds, type CancelMandateRequest, type Capability, type CapabilityRequirement, type ChatMessage, type ClientPricingConfig, ConfigurationError, type ConversationTurn, type Country, type CreateApiKeyForClientRequest, type CreateInstructionsRequest, type CreateMandateRequest, type CreateProposalsRequest, type CreateScheduledPaymentRequest, type CryptoDestination, type CryptoDestinationRequest, type CursorExtractor, type Customer, type CustomerCapabilities, type CustomerCreateRequest, type CustomerCreateResponse, type CustomerListParams, type CustomerPage, type CustomerReEngagementResponse, type CustomerStatus, type CustomerStatusCounts, CustomersResource, DEFAULT_RETRY_POLICY, DakotaClient, type DakotaClientConfig, type Destination, type DestinationCreateResponse, type DestinationListParams, type DestinationRequest, DestinationsResource, type DeveloperFee, type DocumentUploadResponse, type DocumentUploadUrlResponse, type EDDRequest, type EDDWithApplicationID, type EmploymentStatus, type EndorsedRequest, Environment, type Event, type EventListParams, type EventType, EventsResource, type ExpectedMonthlyDeposit, type Family, type FeePayoutDestination, FeePayoutDestinationResource, type FiatUSDestination, type FiatUSDestinationRequest, type ImportPersonaTokensRequest, type ImportPersonaTokensResponse, type IndividualDetailsResponse, type IndividualDocumentType, type IndividualDocumentUploadRequest, type IndividualDocumentUploadUrlRequest, type IndividualRequest, type IndividualRole, type IndividualTitle, InfoResource, type InsightEvidence, type InsightItem, type InsightReport, type InsightSnapshot, InsightsResource, InstructionsResource, type KSUID, type KybStatus, type LegalAcceptanceAttestor, type LegalAcceptanceContext, type LegalDocument, type LegalStructure, type ListParams, type Logger, type Mandate, type MandateAction, type MandateBudget, type MandateBudgetLine, type MandateListParams, type MandateResponse, type MandateRule, type MandateSigner, type MandateVersion, MandatesResource, type Meta, type Network, type NetworkId, type OfframpAccount, type OfframpAccountCreateRequest, type OneOffTransaction, type OneOffTransactionListParams, type OneOffTransactionRequest, type OnrampAccount, type OnrampAccountCreateRequest, type OutstandingLegalDocument, P256MandateSigner, type PageFetcher, PaginatedIterator, type PaginatedResponse, type PaginationMeta, type PaginationParams, type PaymentAgent, type PaymentAgentCreateRequest, type PaymentAgentSignerGroupRef, PaymentAgentsResource, type PaymentCapability, type PersonName, type PersonaImportJob, type PersonaImportJobListParams, type PersonaImportJobParams, type PersonaImportJobSummary, type PersonaImportJobsPage, type PersonaImportRowResult, PoliciesResource, type Policy, type PolicyCreateRequest, type PolicyRule, type PolicyRuleCreateRequest, type PutFeePayoutDestinationRequest, type RDMarketingFeeDailyRow, type RDMarketingFeeStatement, type RFIRequestedItems, type Recipient, type RecipientRequest, type RecipientUpdateRequest, RecipientsResource, type RegisteredAgenticClientPolicy, type RequestOptions, type ResolvedConfig, type RetryPolicy, SandboxResource, type SandboxScenario, type ScheduledPayment, type ScheduledPaymentListParams, ScheduledPaymentsResource, type SelfServeCreditTier, type SelfServeCreditTiersResponse, type SelfServeCreditsBalanceResponse, type SelfServeCreditsLedgerEntry, type SelfServeCreditsLedgerEntryType, type SelfServeCreditsLedgerParams, type SelfServeCreditsLedgerResponse, type SelfServeCreditsPricingResponse, type SelfServeCreditsPurchaseRequest, type SelfServeCreditsPurchaseResponse, SelfServeResource, type SendTransactionIntent, type Signer, type SignerCreateRequest, type SignerGroup, type SignerGroupCreateRequest, type SignerGroupGetParams, type SignerGroupSignerAddRequest, 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 TransactionListMeta, type TransactionListParams, type TransactionListParamsBase, type TransactionResourceType, type TransactionStatus, TransactionsResource, TransportError, type UpdateCustomerSubClientRequest, type UploadedDocumentMetadata, type UsdcWalletPayoutDestination, type User, type UserCreateRequest, type UserListParams, type UserUpdateRequest, UsersResource, type Wallet, type WalletBalance, type WalletBalances, type WalletCreateRequest, type WalletTransaction, type WalletTransactionListParams, type WalletTransactionRequest, WalletsResource, type WebhookEvent, type WebhookHistoryList, type WebhookHistoryListParams, type WebhookHistoryResponse, type WebhookReplayResponse, type WebhookTarget, type WebhookTargetCreateRequest, type WebhookTargetUpdateRequest, WebhooksResource, addPolicyRulePayload, attachGroupPayload, attachPolicyPayload, attachUserToWallet, canonicalJSON, consoleLogger, deletePolicyPayload, detachGroupPayload, detachPolicyPayload, detachUserFromWallet, getEnvironmentURL, mandateAmendSignPayload, mandateSignPayload, noopLogger, paginate, removePolicyRulePayload, updatePolicyRulePayload, verifyMandateSignature };