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

# GET /private/update_in_address_book

`GET /private/update_in_address_book`

Updates beneficiary information for an address in the address book. This method allows you to add or modify beneficiary details required for compliance purposes when making withdrawals to certain addresses.

**📖 Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)

**Scope:** `wallet:read_write`

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

## Query parameters

- `currency` 'BTC' | 'ETH' | 'STETH' | 'ETHW' | 'USDC' | 'USDT' | 'EURR' | 'SOL' | 'XRP' | 'USYC' | 'PAXG' | 'BNB' | 'USDE', required — Currency, i.e `"BTC"`, `"ETH"`, `"USDC"`
- `type` 'transfer' | 'withdrawal' | 'deposit_source', required — Address book type
- `address` string, required
- `beneficiary_vasp_name` string, required — Name of beneficiary VASP
- `beneficiary_vasp_did` string, required — 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, required — Geographical address of the beneficiary
- `agreed` boolean, required — Indicates that the user agreed to shared provided information with 3rd parties
- `personal` boolean, required — The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
- `label` string, required — Label of the address book entry

## Response `200`

Success response

- PrivateUpdateInAddressBookResponse
  - `jsonrpc` '2.0', required — The JSON-RPC version (2.0)
  - `id` integer — The id that was sent in the request
  - `result` string, required — ok

---

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