v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Addresses

Whitelist address

This endpoint allows you to whitelist an external address to be monitored based on the wallet policies

Body Parameters

Key	Required	Type	Description
name	false	string	The name of the address.
address	true	string	The wallet address.
metadata	false	object	Additional metadata for the address. This will be part of any transaction tied to this.
showPrivateKey	false	boolean	If you want the address private key to be part of the response.
disableAutoSweep	false	boolean	Disable automatic sweeping of assets sent to the address into your master wallet.
enableGaslessWithdraw	false	boolean	Enable gasless transactions from this address.
privateKey	false	string	The private key associated with the address. Required for executing actions securely.

post/v1/wallets/{walletId}/addresses/whitelist

Request body

addressstring

disableAutoSweepstring

enableGaslessWithdrawstring

metadatastring

namestring

privateKeystring

showPrivateKeystring

Example request

{
  "address": "ADDRESS_TO_WHITELIST",
  "disableAutoSweep": "OPTIONAL_BOOLEAN",
  "enableGaslessWithdraw": "OPTIONAL_BOOLEAN",
  "metadata": "OPTIONAL_METADATA",
  "name": "OPTIONAL_ADDRESS_NAME",
  "privateKey": "OPTIONAL_ADDRESS_TO_WHITELIST_PRIVATE_KEY",
  "showPrivateKey": "OPTIONAL_BOOLEAN"
}

Response

200

messagestring

statusCodenumber

Example response

{
  "data": {
    "address": "0x3375154fa32Cb434B044E73a2582C4D2E6518AE4",
    "blockchain": {
      "createdAt": "2024-05-27T08:31:14.966Z",
      "derivationPath": "m/44'/60'/0'/0",
      "id": "74733889-4ecd-403e-9840-94e87c043f24",
      "isActive": true,
      "isEvmCompatible": true,
      "logoUrl": "https://res.cloudinary.com/blockradar/image/upload/v1716800080/crypto-assets/Base_Network_Logo_vqyh7r.png",
      "name": "base",
      "slug": "base",
      "symbol": "eth",
      "updatedAt": "2024-10-27T07:52:16.115Z"
    },
    "configurations": {
      "aml": {
        "message": "Address is not sanctioned",
        "provider": "ofac",
        "status": "success"
      }
    },
    "createdAt": "2024-11-11T16:57:19.160Z",
    "id": "b87901a2-45c1-4d2d-8ee7-205ef0c4ddf1",
    "isActive": true,
    "name": "External address",
    "network": "testnet",
    "type": "EXTERNAL",
    "updatedAt": "2024-11-11T16:57:19.160Z"
  },
  "message": "Address whitelisted successfully",
  "statusCode": 200
}