funding-beta

Update Funding Address

Update the name and/or description of a saved withdrawal address.

API Key Permissions Required: Funds permissions - Add withdrawal addresses

put/funding/v1/addresses/{id}

Request

  • Base URL: https://api.kraken.com
  • URL: https://api.kraken.com/funding/v1/addresses/{id}
  • Auth: one of:
    • API key in header API-Key and API key in header API-Sign and API key in header API-Nonce
    • API key in header API-Key and API key in header API-Sign and API key in header API-Nonce and API key in header API-OTP

Path parameters

idstring required

Unique identifier of the address to update.

Query parameters

account_idstring

Account ID

Request body

namestring

User provided name for the address. Must be unique and contain at least one non-whitespace character. Surrounding whitespace is removed.

descriptionstring

User provided description of the address.

Example request

{
  "name": "Personal Wallet",
  "description": "My hardware wallet address"
}

Response

verifiedboolean required

Whether the address is verified and ready for use.

Changes

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