Agent Wallets

Read the Keyban welcome offer

The organization's welcome offer: Keyban pays the first x402 payments of the wallet that earned it (walletId / walletAddress, the organization's first Base agent wallet) until the amount is spent or the offer expires. null when the organization never received one.

get/v1/agent-wallets/sponsor-grant

Request

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

Query parameters

applicationIdstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Application whose organization offer is read

Response

Welcome offer, or null when the organization has none

walletIdstring uuid required

Agent wallet the offer covers (the first Base agent wallet of the organization); no other wallet is sponsored

walletAddressstring required

On-chain address of the agent wallet the offer covers

network'EthereumAnvil' | 'BaseSepolia' | 'BaseMainnet' | 'XdcApothem' | 'XdcMainnet' | 'StellarQuickstart' | 'StellarTestnet' | 'StellarMainnet' required

Network on which Keyban covers the payments

amountstring required

Amount offered, in USDC base units (6 decimals)

remainingstring required

Amount still covered, in USDC base units (6 decimals)

grantedAtstring date-time required

When the offer was granted (first Base agent wallet)

expiresAtstring date-time required

When what remains stops being covered

status'active' | 'exhausted' | 'expired' required

active, exhausted (fully spent) or expired

Example response

{
  "walletId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "network": "BaseSepolia",
  "amount": "1000000",
  "remaining": "620000",
  "grantedAt": "2026-10-08T09:00:00.000Z",
  "expiresAt": "2026-11-07T09:00:00.000Z",
  "status": "active"
}

Changes

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