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

Scope: wallet:read_write and mainaccount

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/set_address_requires_security_key \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "private/set_address_requires_security_key",
  "params": {
    "currency": "BTC",
    "type": "withdrawal",
    "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj",
    "value": true
  }
}
'

200

response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj",
    "creation_timestamp": 1536569522277,
    "currency": "BTC",
    "type": "withdrawal",
    "label": "Main address",
    "status": "ready",
    "requires_confirmation": true,
    "requires_confirmation_change": false,
    "requires_security_key": true,
    "info_required": false
  }
}

Query Parameters

currency · enum<string> · required

The currency symbol. Legacy wallet type: wallet currencies only. Coinbase wallet type: any portfolio currency or "all". Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR

Example:

"BTC"

type · enum<string> · required

Address book type

Available options: transfer, withdrawal

Example:

"withdrawal"

address · string

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. Address in proper format for currency

Example:

"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj"

network · string

Blockchain network for the wallet operation, given as a network resource name (e.g. "networks/ethereum-mainnet"). Coinbase wallet type only. The networks available for each currency are returned by public/get_currencies in the coinbase_networks field. Required for operations that target an on-chain address or a deposit address; also used to disambiguate address book entries when the same address exists on multiple networks.

Example:

"networks/ethereum-mainnet"

tag · string

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.

id · string

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.

Example:

"0190a1b2-7c3d-7e5f-8a9b-0c1d2e3f4a5b"

value · boolean · required

If true, withdrawals to the address require a security key

Example:

true

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Option 1

Option 2

Hide child attributes

result. currency · enum<string> · required

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

Available options: BTC, ETH, STETH, ETHW, USDC, USDT, EURR, SOL, XRP, USYC, PAXG, BNB, USDE

result. address · string · required

Address in proper format for currency

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

result. creation_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. type · enum<string>

Address book type

Available options: transfer, withdrawal, deposit_source

result. label · string

Label of the address book entry

Example:

"Main address"

result. beneficiary_vasp_name · string

Name of beneficiary VASP

Example:

"Money's Gone"

result. beneficiary_vasp_did · string

DID of beneficiary VASP

Example:

"did:example:123456789abcdefghi"

result. beneficiary_vasp_website · string

Website of the beneficiary VASP

result. beneficiary_first_name · string

First name of the beneficiary (if beneficiary is a person)

Example:

"John"

result. beneficiary_last_name · string

Last name of the beneficiary (if beneficiary is a person)

Example:

"Doe"

result. beneficiary_company_name · string

Company name of the beneficiary (if beneficiary is a company)

Example:

"Company Name"

result. beneficiary_address · string

Geographical address of the beneficiary

Example:

"NL, Amsterdam, Street, 1"

result. agreed · boolean

Indicates that the user agreed to shared provided information with 3rd parties

Example:

true

result. personal · boolean

The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software

Example:

true

result. info_required · boolean

Signalises that addition information regarding the beneficiary of the address is required

Example:

true

result. status · enum<string>

Wallet address status, values: [admin_locked, waiting, confirmed, ready]

Available options: admin_locked, waiting, confirmed, ready

result. waiting_timestamp · boolean

Timestamp when the address will be ready

Example:

true

result. requires_confirmation · boolean

If address requires email confirmation for withdrawals

Example:

true

result. requires_confirmation_change · boolean

If email confirmation change is in progress

Example:

true

result. requires_security_key · boolean

If withdrawals to this address require a security key

Example:

false

id · integer

The id that was sent in the request