Agent Wallet Signers

Update a signer

Update the name of a signer.

patch/v1/agent-wallets/{walletId}/signers/{id}

Request

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

Path parameters

walletIdstring uuid required

The unique identifier of the agent wallet

idstring uuid required

The unique identifier of the signer

Request body

namestring required

Human-readable name of the signer

Response

Signer updated successfully

idstring uuid required

Entity UUID

createdAtstring date-time required

Creation date (ISO 8601)

updatedAtstring date-time required

Last update date (ISO 8601)

namestring required

Human-readable name of the signer

type'agentic' required

Type of the signer

status'pending' | 'ready' | 'active' | 'failed' | 'deleting' required

Current status of the signer

apiKeystring nullable

Plaintext API key for agentic signers (KEYBAN_API_KEY)

commitmentKeystring nullable

Plaintext invitation private key (KEYBAN_INVITE_KEY), set when the signer becomes ready. Retained after activation — the on-chain commitment is single-use and consumed, so the key is inert, but it keeps the MCP config re-downloadable.

frostPublicKeystring nullable

Public key of the FROST key, set once the DKG has completed (round2). Non-null means the DKG was already run for this signer and the one-shot invite key is consumed — the DKG must not run again (the admin "Initialize signer" action is hidden and the backend refuses a second round1 with 409).

Changes

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