Skip to main content
POST
/
v1
/
addresses
/
whitelist
Whitelist an existing deposit address
curl --request POST \
  --url https://api.xentfi.com/v1/addresses/whitelist \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'orgId: <api-key>' \
  --data '
{
  "masterId": "550e8400-e29b-41d4-a716-446655440000",
  "walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0b5b5"
}
'
const options = {
method: 'POST',
headers: {apiKey: '<api-key>', orgId: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
masterId: '550e8400-e29b-41d4-a716-446655440000',
walletAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0b5b5'
})
};

fetch('https://api.xentfi.com/v1/addresses/whitelist', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "https://api.xentfi.com/v1/addresses/whitelist"

payload = {
"masterId": "550e8400-e29b-41d4-a716-446655440000",
"walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0b5b5"
}
headers = {
"apiKey": "<api-key>",
"orgId": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.xentfi.com/v1/addresses/whitelist"

payload := strings.NewReader("{\n \"masterId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"walletAddress\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f0b5b5\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("apiKey", "<api-key>")
req.Header.Add("orgId", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
const options = {
method: 'POST',
headers: {apiKey: '<api-key>', orgId: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
masterId: '550e8400-e29b-41d4-a716-446655440000',
walletAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0b5b5'
})
};

fetch('https://api.xentfi.com/v1/addresses/whitelist', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "walletAddress": "<string>",
    "network": "<string>",
    "blockchain": {
      "id": "8a864e95-4b86-423d-9ba4-f4e692ec121e",
      "name": "Base",
      "slug": "base-mainnet",
      "symbol": "ETH",
      "isActive": true,
      "isEvmCompatible": true,
      "configurations": null,
      "chainId": 8453,
      "logoUrl": "https://example.com/base-logo.png",
      "tokenStandard": "ERC20",
      "createdAt": "2023-04-28T14:44:06.397Z",
      "updatedAt": "2024-11-26T15:26:18.785Z"
    },
    "masterWalletId": "<string>",
    "metadata": {},
    "isActive": true,
    "configurations": {
      "aml": {
        "message": "<string>",
        "provider": "<string>",
        "status": "<string>"
      },
      "disableAutoSweep": true,
      "enableGaslessWithdraw": true,
      "enableMultiChain": true,
      "settlement": {
        "autoSettlementEnabled": true,
        "settlementDelay": 123,
        "minBalanceForSettlement": "<string>"
      },
      "security": {
        "requireSignatureForWithdrawals": true,
        "maxWithdrawalAmount": "<string>",
        "allowedDestinations": [
          "<string>"
        ]
      },
      "notifications": {
        "onDeposit": true,
        "onWithdrawal": true,
        "onThresholdReached": "<string>"
      }
    },
    "enabledBlockchains": [
      {
        "id": "8a864e95-4b86-423d-9ba4-f4e692ec121e",
        "name": "Base",
        "slug": "base-mainnet",
        "symbol": "ETH",
        "isActive": true,
        "isEvmCompatible": true,
        "configurations": null,
        "chainId": 8453,
        "logoUrl": "https://example.com/base-logo.png",
        "tokenStandard": "ERC20",
        "createdAt": "2023-04-28T14:44:06.397Z",
        "updatedAt": "2024-11-26T15:26:18.785Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Wallet not found",
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Wallet not found",
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Wallet not found",
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Wallet not found",
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Wallet not found",
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}

Authorizations

apiKey
string
header
required
orgId
string
header
required

Body

application/json
masterId
string
required

ID of the master wallet to associate the address with

Example:

"550e8400-e29b-41d4-a716-446655440000"

walletAddress
string
required

Existing blockchain wallet address to whitelist (EVM format or Solana)

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0b5b5"

privatekey
string

Optional private key for the wallet (EVM or Solana format)

Example:

"0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"

name
string

Optional custom name for the deposit address

Example:

"My Whitelisted Wallet"

disableAutoSweep
boolean
default:false

Disable automatic sweeping of funds to master wallet

Example:

false

enableGaslessWithdraw
boolean
default:false

Enable gasless withdrawals for this address

Example:

false

enableMonitoring
boolean
default:false

Enable blockchain monitoring for this address

Example:

true

metadata
object

Additional metadata for the address

Example:
{
"source": "external_wallet",
"tags": ["customer", "whitelisted"]
}

Response

Deposit address whitelisted successfully

success
boolean
Example:

true

data
object