---
title: "GET /private/set_address_requires_security_key"
method: GET
path: "/private/set_address_requires_security_key"
tags: ["Wallet", "Private"]
---

# GET /private/set_address_requires_security_key

`GET /private/set_address_requires_security_key`

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](https://docs.deribit.com/articles/managing-withdrawals-api)

**Scope:** `wallet:read_write` and mainaccount

[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fset_address_requires_security_key)

## Query parameters

- `currency` 'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR', required — Currency, i.e `"BTC"`, `"ETH"`, `"USDC"`
- `type` 'transfer' | 'withdrawal', required — Address book type
- `address` string — Address in proper format for currency
- `network` string
- `tag` string
- `id` string
- `value` boolean, required

## Response `200`

Success response

- PrivateSetAddressRequiresSecurityKeyResponse
  - `jsonrpc` '2.0', required — The JSON-RPC version (2.0)
  - `id` integer — The id that was sent in the request
  - `result` union, required
    - AddressBookItem
      - `currency` 'BTC' | 'ETH' | 'STETH' | 'ETHW' | 'USDC' | 'USDT' | 'EURR' | 'SOL' | 'XRP' | 'USYC' | 'PAXG' | 'BNB' | 'USDE', required — Currency, i.e `"BTC"`, `"ETH"`, `"USDC"`
      - `address` string, required — Address in proper format for currency
      - `creation_timestamp` integer, required — The timestamp (milliseconds since the Unix epoch)
      - `type` 'transfer' | 'withdrawal' | 'deposit_source' — Address book type
      - `label` string — Label of the address book entry
      - `beneficiary_vasp_name` string — Name of beneficiary VASP
      - `beneficiary_vasp_did` string — DID of beneficiary VASP
      - `beneficiary_vasp_website` string — Website of the beneficiary VASP
      - `beneficiary_first_name` string — First name of the beneficiary (if beneficiary is a person)
      - `beneficiary_last_name` string — Last name of the beneficiary (if beneficiary is a person)
      - `beneficiary_company_name` string — Company name of the beneficiary (if beneficiary is a company)
      - `beneficiary_address` string — Geographical address of the beneficiary
      - `agreed` boolean — Indicates that the user agreed to shared provided information with 3rd parties
      - `personal` boolean — The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
      - `info_required` boolean — Signalises that addition information regarding the beneficiary of the address is required
      - `status` 'admin_locked' | 'waiting' | 'confirmed' | 'ready' — Wallet address status, values: [`admin_locked`, `waiting`, `confirmed`, `ready`]
      - `waiting_timestamp` boolean — Timestamp when the address will be ready
      - `requires_confirmation` boolean — If address requires email confirmation for withdrawals
      - `requires_confirmation_change` boolean — If email confirmation change is in progress
      - `requires_security_key` boolean — If withdrawals to this address require a security key
    - CoinbaseAddressBookItem — Address book entry of a Coinbase wallet type account. Returned instead of `address_book_item` for Coinbase wallet type users.
      - `id` string, required — Unique identifier (UUID7) of the address book entry
      - `currency` string, required — The currency symbol, or `"all"` for CTN counterparty entries that apply to all currencies
      - `address` string, required — The on-chain address, or the CTN counterparty identifier when `kind` is `"ctn"`
      - `type` 'deposit' | 'withdrawal' | 'transfer', required — Address book entry type
      - `kind` 'onchain' | 'ctn', required — Kind of the destination: `"onchain"` — blockchain address, `"ctn"` — Coinbase Travel Network counterparty
      - `label` string — Label of the address book entry
      - `creation_timestamp` integer, required — The timestamp (milliseconds since the Unix epoch)
      - `updated_timestamp` integer — The timestamp (milliseconds since the Unix epoch)
      - `status` 'active' | 'waiting' | 'ready' — Status of the entry: `"active"` for deposit addresses, `"waiting"` while the security delay is pending, `"ready"` otherwise
      - `waiting_timestamp` boolean — Timestamp when the address will be ready
      - `requires_confirmation` boolean — If address requires email confirmation for withdrawals
      - `requires_confirmation_change` boolean — If email confirmation change is in progress
      - `requires_security_key` boolean — If withdrawals to this address require a security key
      - `info_required` boolean — Signalises that addition information regarding the beneficiary of the address is required
      - `network` string — Network resource name of the destination (e.g. `"networks/ethereum-mainnet"`); absent for CTN entries
      - `network_display_name` string — Human-readable name of the network (e.g. `"Ethereum"`); absent for CTN entries
      - `tag` string — Destination tag / memo of the entry; absent when not set
      - `name` string — Beneficiary name — travel rule data (present when provided)
      - `country` string — Beneficiary country code (ISO 3166-1 alpha-2) — travel rule data (present when provided)
      - `financial_institution` string — Financial institution of the beneficiary — travel rule data (present when provided)
      - `account` string — Account identifier of the beneficiary — travel rule data (present when provided)
      - `account_location` string — Location of the beneficiary account — travel rule data (present when provided)
      - `entity_type` 'organization' | 'individual' — Type of the beneficiary entity — travel rule data (present when provided)
      - `wallet_type` 'exchange' | 'self_hosted' — Type of the beneficiary wallet — travel rule data (present when provided)
      - `is_self` boolean — Indicates that the beneficiary is the account owner — travel rule data (present when provided)
      - `beneficiary_created` integer — The timestamp (milliseconds since the Unix epoch)
      - `beneficiary_updated` integer — The timestamp (milliseconds since the Unix epoch)

## Changes

- **2026-09-01** `f1c92835a183` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/deribit/apis/deribit-api-2/changes/private/set_address_requires_security_key/get.md)

---

[API](https://skmtc.dev/deribit/apis/deribit-api-2.md) · [All operations](https://skmtc.dev/deribit/apis/deribit-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/deribit/deribit-api-2/revisions/f1c92835a183/schema)