auth.v1.AddressBookService
GetWithdrawWhitelistView
Method
POST
Path
auth.v1.AddressBookService/GetWithdrawWhitelistView
Service
auth.v1.AddressBookService
Visibility
Authentication
Session token or API key
MFA Requirement
Not required
POST
auth.v1.AddressBookService/GetWithdrawWhitelistView Request
Testnet
curl --request POST \ \
--url 'https://api.testnet.polyester.com/auth.v1.AddressBookService/GetWithdrawWhitelistView' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"subaccountId": "6789012345678"
}'Responses
{
"view": {
"activeEntries": [
{
"canonicalAddress": "0x3333333333333333333333333333333333333333",
"polychainChainId": 1,
"rawAddressHex": "3333333333333333333333333333333333333333",
"updatedAt": "2025-01-01T00:00:00Z"
}
],
"externalWhitelistRequired": false,
"internalWhitelistRequired": false,
"scope": {
"rootAccountId": "7563897446546",
"scopeType": "SCOPE_ROOT",
"subaccountId": "6789012345678"
}
}
}Request
auth.v1.GetWithdrawWhitelistViewRequestResponse
auth.v1.GetWithdrawWhitelistViewResponse subaccountId string (fixed64)
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
rootAccountId string (fixed64)
Root account that owns this address book.
subaccountId string (fixed64)
Subaccount for subaccount-scoped books. Empty for root account books.
externalWhitelistRequired boolean
Whether external withdrawals are restricted to whitelisted destinations.
4 fields
canonicalAddress string
Destination address on the selected external network.
rawAddressHex string
Encoded destination payload as lowercase hex, when available.
updatedAt string (date-time)
Time this whitelist entry was last updated, as a UTC timestamp.
polychainChainId integer (int32)
External network identifier for this whitelist entry.
internalWhitelistRequired boolean
Whether internal transfers are restricted to whitelisted destinations.
| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |