DEderibit
Wallet
Private

Changed on

Sets whether withdrawals to the given address book address require a security key. Returns the updated address book entry.

Coinbase wallet type

For Coinbase wallet type accounts the entry is identified by one of address or id (the entry identifier returned by private/get_address_book) instead of address alone. Use network and tag together with address to disambiguate entries sharing the same address. The mainaccount scope is not required for Coinbase wallet type accounts.

📖 Related Article: Managing Withdrawals

Scope: wallet:read_write and mainaccount

Try in API console

get/private/set_address_requires_security_key

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/set_address_requires_security_key
  • Auth
    none declared

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR' required

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol. Legacy wallet type: wallet currencies only. Coinbase wallet type: any portfolio currency or "all".

type'transfer' | 'withdrawal' required

Address book type

Address book type. Legacy wallet type: only withdrawal is supported. Coinbase wallet type: withdrawal or transfer.

addressstring

Address in proper format for currency

Example:1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

Address in currency format, it must be in address book. Required for legacy wallet type. Coinbase wallet type: required when id is not provided; use network and tag to disambiguate entries sharing the same address.

networkstring
Example:networks/ethereum-mainnet

Blockchain network resource name (e.g. networks/ethereum-mainnet), for Coinbase wallet types. Available networks are returned by public/get_currencies in coinbase_networks. Requiredness depends on the operation. When resolving an existing address-book entry, it is optional if the entry resolves uniquely; it disambiguates an address present on multiple networks.

tagstring

Destination tag / memo for networks that support one. Coinbase wallet type only. Used together with address and network; also serves to disambiguate address book entries that share the same address.

idstring
Example:0190a1b2-7c3d-7e5f-8a9b-0c1d2e3f4a5b

Unique identifier (UUID7) of the address book entry, as returned in the id field of private/get_address_book results. Coinbase wallet type only. Can be used instead of address (with network and tag) to identify the entry.

valueboolean required
Example:true

If true, withdrawals to the address require a security key

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "creation_timestamp": 1536569522277,
    "label": "Main address",
    "beneficiary_vasp_name": "Money's Gone",
    "beneficiary_vasp_did": "did:example:123456789abcdefghi",
    "beneficiary_first_name": "John",
    "beneficiary_last_name": "Doe",
    "beneficiary_company_name": "Company Name",
    "beneficiary_address": "NL, Amsterdam, Street, 1",
    "agreed": true,
    "personal": true,
    "info_required": true,
    "waiting_timestamp": 1720252232860,
    "requires_confirmation": true,
    "requires_confirmation_change": true
  }
}

Changes

  • 82518876f388Revision changes
    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the ///// response's property type changed from boolean to integer for status

    • breaking

      the ///// response's property type changed from boolean to integer for status

  • d0d337dd9329Revision changes
    • info

      endpoint added