> ## Documentation Index
> Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 地址簿

> 登记、查询和更新账户可提现的目标地址。

[Stablecoin Account API 发布方声明](/zh/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer)

提现只能发往地址簿中已登记的地址。每个条目记录地址本身、所属网络和币种、属于交易所还是个人钱包，以及合规要求时的受益人 Travel Rule 数据。新建条目会自动进行风险评估和校验。

<h2 id="create-an-entry">
  创建条目
</h2>

调用 [Create Address Book](/zh/stablecoin-account/v1.6/api-reference/create-address-book)，传入地址信息和与地址类型对应的法律声明：

```bash theme={null}
curl -X POST https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address \
  -H "x-auth-token: YOUR_API_TOKEN" \
  -H "x-idempotency-key: $(uuidgen | tr '[:upper:]' '[:lower:]')" \
  -H "Content-Type: application/json" \
  -d '{
    "address_label": "My USDT Wallet",
    "network": "ETH",
    "currency": "USDT",
    "address_type": 2000,
    "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "legal_declaration": "I_CERTIFY_THIS_ADDRESS_IS_MINE",
    "is_whitelist": 1
  }'
```

关键字段：

| 字段                  |            必填           | 描述                                                                                                                                   |
| ------------------- | :---------------------: | ------------------------------------------------------------------------------------------------------------------------------------ |
| `address_label`     |            是            | 用于识别该条目的名称                                                                                                                           |
| `network`           |            是            | 网络代码，例如 `ETH`                                                                                                                        |
| `currency`          |            是            | 币种代码，例如 `USDT`                                                                                                                       |
| `address_type`      |            是            | `1000` 表示交易所地址，`2000` 表示个人钱包                                                                                                         |
| `wallet_address`    |            是            | 目标地址                                                                                                                                 |
| `legal_declaration` |            是            | `address_type` 为 `1000` 时填 `I_CERTIFY_BENEFICIAL_OWNERSHIP_OF_EXCHANGE_ACCOUNT`；为 `2000` 时填 `I_CERTIFY_THIS_ADDRESS_IS_MINE`         |
| `address_source`    | `address_type=1000` 时必填 | 地址的来源                                                                                                                                |
| `is_whitelist`      |            否            | `1` 表示将该地址加入提现白名单，`0` 表示不加入                                                                                                          |
| `meta_data`         |           条件必填          | Travel Rule 数据 —— 第三方或交易所托管地址、以及经 Binance 通道的提现目标地址必填。参见 [Travel Rule 合规](/zh/stablecoin-account/v1.6/guide/travel-rule-compliance)。 |

响应返回已保存的条目，包括 `address_id`、`verification_status`（`1` 已验证，`2` 验证失败）和 `need_travel_rule` —— 条目尚无 Travel Rule 数据时为 `true`。

<h2 id="list-entries">
  查询条目
</h2>

用 [List Address Book](/zh/stablecoin-account/v1.6/api-reference/list-address-book) 查询，可按 `currency`、`network`、`address_type`、`verification_status`、`wallet_address` 或 `address_label` 过滤：

```bash theme={null}
curl "https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address?page_num=1&page_size=10&currency=USDT" \
  -H "x-auth-token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

<Note>
  `address_kind` 参数决定返回哪一类条目：`whitelist`（默认）返回提现目标地址；`deposit_sender` 返回通过 [Submit Deposit Sender Travel Rule](/zh/stablecoin-account/v1.6/api-reference/create-deposit-sender) 创建的发起方记录。
</Note>

利用每个条目的 `need_travel_rule` 标记，在用户发起需要该数据的提现之前，提示他们先补全受益人信息。

<h2 id="update-an-entry">
  更新条目
</h2>

[Update Address Book](/zh/stablecoin-account/v1.6/api-reference/update-address-book) 编辑已有条目 —— 修改名称、切换白名单标记，或添加和编辑 Travel Rule `meta_data`：

```bash theme={null}
curl -X POST https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update \
  -H "x-auth-token: YOUR_API_TOKEN" \
  -H "x-idempotency-key: $(uuidgen | tr '[:upper:]' '[:lower:]')" \
  -H "Content-Type: application/json" \
  -d '{
    "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
    "is_whitelist": 1,
    "address_label": "My USDT Wallet"
  }'
```

只有 `address_id` 必填，其余只传需要修改的字段。为创建时未带 Travel Rule 数据的地址补录 `meta_data`，就是通过这个接口完成的。

<h2 id="related">
  相关页面
</h2>

* [Create Address Book API](/zh/stablecoin-account/v1.6/api-reference/create-address-book)
* [Update Address Book API](/zh/stablecoin-account/v1.6/api-reference/update-address-book)
* [Travel Rule 合规](/zh/stablecoin-account/v1.6/guide/travel-rule-compliance) —— 何时必须提供 `meta_data` 以及如何填写
* [发起提现](/zh/stablecoin-account/v1.6/guide/send-withdrawals)