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

# List Whitelist Addresses

> List the addresses on your crypto withdrawal whitelist, with optional filters and pagination.

Use this endpoint to list the active entries on your crypto withdrawal whitelist.

> [!NOTE]
>
> All requests must include the `X-BH-TOKEN` header with an access token. See [Authentication](https://docs.velafi.com/api-reference/authentication.md).

## Endpoint

`GET https://api.velafi.com/v2/user/whitelistAddress`

## Query Parameters

**crypto** `string`

Filter by token symbol.

**chainType** `string`

Filter by network name.

**address** `string`

Filter by address.

**addressTag** `string`

Filter by memo or tag.

**currentPage** `number` (default: 1)

Page number, starting at `1`. Defaults to `1`.

**pageSize** `number` (default: 10)

Records per page, from `1` to `1000`. Defaults to `10`.

## Response Fields

**code** `number`

`200` indicates success.

**msg** `string`

`SUCCESS` on success.

**data** `object`

**data fields**

**currentPage** `number`

Page number returned.

**size** `number`

Page size used for the query.

**total** `number`

Total number of matching entries.

**record** `array`

**record item fields**

**addressId** `number`

ID of the whitelist entry.

**crypto** `string`

Token symbol.

**chainType** `string`

Network name.

**address** `string`

Whitelisted address.

**addressTag** `string`

Memo or tag. Empty string if none.

**remark** `string`

Your label for this address.

## Example

```bash cURL theme={null}
curl -G https://api.velafi.com/v2/user/whitelistAddress \
  -H "X-BH-TOKEN: YOUR_ACCESS_TOKEN" \
  --data-urlencode "crypto=USDT" \
  --data-urlencode "chainType=TRC20"
```


## Related topics

- [Add a Whitelist Address](https://docs.velafi.com/api-reference/crypto-wallet/add-whitelist-address.md)
- [Delete a Whitelist Address](https://docs.velafi.com/api-reference/crypto-wallet/delete-whitelist-address.md)
- [Authentication](https://docs.velafi.com/api-reference/authentication.md)
- [Create an API Key](https://docs.velafi.com/docs/guides/creating-api-key.md)
- [Create a Crypto Withdrawal](https://docs.velafi.com/api-reference/crypto-wallet/create-crypto-withdrawal.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.