AddressBookService
Get Withdraw Whitelist View
Get external withdrawal whitelist status for one visible address book.
Method
GET
Path
/v1/auth/withdraw-whitelist
Visibility
Authentication
Session token or API key
MFA Requirement
Not required
GET
/v1/auth/withdraw-whitelist Request
Testnet
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/auth/withdraw-whitelist?subaccountId=6789012345678' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"view": {
"activeEntries": [
{
"canonicalAddress": "0x3333333333333333333333333333333333333333",
"polychainChainId": 1,
"rawAddressHex": "3333333333333333333333333333333333333333",
"updatedAt": "2025-01-01T00:00:00Z"
}
],
"externalWhitelistRequired": false,
"internalWhitelistRequired": false,
"scope": {
"rootAccountId": "7563897446546",
"scopeType": "ROOT",
"subaccountId": "39LcpTZDsDq"
}
}
} subaccountId string (int64)
Optional subaccount scope. Omit to use the root account withdraw whitelist view.
4 fields
3 fields
scopeType enum
Address-book scope type.
SCOPE_ROOT SCOPE_SUBACCOUNT
Example
ROOT rootAccountId string (fixed64)
Root account that owns this address book.
Example
7563897446546 subaccountId string (fixed64)
Subaccount for subaccount-scoped books. Empty for root account books.
Example
39LcpTZDsDq externalWhitelistRequired boolean
Whether external withdrawals are restricted to whitelisted destinations.
Example
false 4 fields
canonicalAddress string
Destination address on the selected external network.
Example
0x3333333333333333333333333333333333333333 rawAddressHex string
Encoded destination payload as lowercase hex, when available.
Example
3333333333333333333333333333333333333333 updatedAt string (date-time)
Time this whitelist entry was last updated, as a UTC timestamp.
Example
2025-01-01T00:00:00Z polychainChainId integer (int32)
External network identifier for this whitelist entry.
Example
1 internalWhitelistRequired boolean
Whether internal transfers are restricted to whitelisted destinations.
Example
false| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |