Wallet Policy

Get the policy attached to an agent wallet

get/v1/agent-wallets/{agentWalletId}/policy

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/agent-wallets/{agentWalletId}/policy
  • Auth: one of:
    • API key in header X-Api-Key
    • bearer (a scheme the document does not define)

Path parameters

agentWalletIdstring uuid required

Response

idstring uuid required

Entity UUID

createdAtstring date-time required

Creation date (ISO 8601)

updatedAtstring date-time required

Last update date (ISO 8601)

currencystring required

Reference currency the caps are denominated in, as an ISO 4217 code (e.g. EUR, USD, JPY). Any code the rate oracle can quote works — no enum.

maxAmountPerPaymentRefstring nullable

Per-signature ceiling, expressed as a non-negative integer in the smallest sub-unit of the policy reference currency. Null = no cap.

requireHumanAboveRefstring nullable

Threshold (same encoding as maxAmountPerPaymentRef) above which evaluateIntent returns require_human. Null = never require human approval.

volatilityMarginBpsinteger nullable

Volatility tolerance in basis points (100 = 1%, max 10000 = 100%) applied when re-validating an already-approved intent against a freshly re-priced amount. Absorbs rate drift between the human approval and the signature: a retry is honored while the value stays within this margin of the approved value, otherwise it is re-escalated for a fresh human decision. Null/0 = strict (no tolerance).

timezonestring nullable

IANA time zone the budget windows are computed in (e.g. Europe/Paris). Null = UTC.

maxAmountPerDayRefstring nullable

Spend envelope over the current calendar day (in the policy timezone). Same encoding as maxAmountPerPaymentRef. Null = no daily envelope.

maxAmountPerWeekRefstring nullable

Spend envelope over the current calendar week (Monday→Sunday, in the policy timezone). Same encoding as maxAmountPerPaymentRef. Null = no weekly envelope.

maxAmountPerMonthRefstring nullable

Spend envelope over the current calendar month (in the policy timezone). Same encoding as maxAmountPerPaymentRef. Null = no monthly envelope.

emergencyStopboolean required

Per-wallet emergency stop ("kill switch"). When true, all payment requests for this wallet are denied until an operator releases it.

Changes

No recorded changes to this operation across all 1 revision of this API.