Whitelist address

curl --request POST \
  --url https://api.blockradar.co/v1/wallets/{walletId}/addresses/whitelist \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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"
}
'

{
  "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",
      "tokenStandard": null,
      "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",
    "derivationPath": null,
    "id": "b87901a2-45c1-4d2d-8ee7-205ef0c4ddf1",
    "isActive": true,
    "metadata": null,
    "name": "External address",
    "network": "testnet",
    "type": "EXTERNAL",
    "updatedAt": "2024-11-11T16:57:19.160Z"
  },
  "message": "Address whitelisted successfully",
  "statusCode": 200
}

Address

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

wallets

{walletId}

addresses

whitelist

Whitelist address

curl --request POST \
  --url https://api.blockradar.co/v1/wallets/{walletId}/addresses/whitelist \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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"
}
'

{
  "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",
      "tokenStandard": null,
      "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",
    "derivationPath": null,
    "id": "b87901a2-45c1-4d2d-8ee7-205ef0c4ddf1",
    "isActive": true,
    "metadata": null,
    "name": "External address",
    "network": "testnet",
    "type": "EXTERNAL",
    "updatedAt": "2024-11-11T16:57:19.160Z"
  },
  "message": "Address whitelisted successfully",
  "statusCode": 200
}

Authorizations

x-api-key

string

header

required

Path Parameters

walletId

string

required

Example:

""

Body

application/json

address

string

Example:

"ADDRESS_TO_WHITELIST"

disableAutoSweep

string

Example:

"OPTIONAL_BOOLEAN"

enableGaslessWithdraw

string

Example:

"OPTIONAL_BOOLEAN"

metadata

string

Example:

"OPTIONAL_METADATA"

name

string

Example:

"OPTIONAL_ADDRESS_NAME"

privateKey

string

Example:

"OPTIONAL_ADDRESS_TO_WHITELIST_PRIVATE_KEY"

showPrivateKey

string

Example:

"OPTIONAL_BOOLEAN"

Response

200 - application/json

200

data

object

Show child attributes

data.address

string

Example:

"0x3375154fa32Cb434B044E73a2582C4D2E6518AE4"

data.blockchain

object

Show child attributes

data.blockchain.createdAt

string

Example:

"2024-05-27T08:31:14.966Z"

data.blockchain.derivationPath

string

Example:

"m/44'/60'/0'/0"

data.blockchain.id

string

Example:

"74733889-4ecd-403e-9840-94e87c043f24"

data.blockchain.isActive

boolean

Example:

true

data.blockchain.isEvmCompatible

boolean

Example:

true

data.blockchain.logoUrl

string

Example:

"https://res.cloudinary.com/blockradar/image/upload/v1716800080/crypto-assets/Base_Network_Logo_vqyh7r.png"

data.blockchain.name

string

Example:

"base"

data.blockchain.slug

string

Example:

"base"

data.blockchain.symbol

string

Example:

"eth"

data.blockchain.tokenStandard

unknown

data.blockchain.updatedAt

string

Example:

"2024-10-27T07:52:16.115Z"

data.configurations

object

Show child attributes

data.configurations.aml

object

Show child attributes

data.configurations.aml.message

string

Example:

"Address is not sanctioned"

data.configurations.aml.provider

string

Example:

"ofac"

data.configurations.aml.status

string

Example:

"success"

data.createdAt

string

Example:

"2024-11-11T16:57:19.160Z"

data.derivationPath

unknown

data.id

string

Example:

"b87901a2-45c1-4d2d-8ee7-205ef0c4ddf1"

data.isActive

boolean

Example:

true

data.metadata

unknown

data.name

string

Example:

"External address"

data.network

string

Example:

"testnet"

data.type

string

Example:

"EXTERNAL"

data.updatedAt

string

Example:

"2024-11-11T16:57:19.160Z"

message

string

Example:

"Address whitelisted successfully"

statusCode

number

Example:

200

Update Address Unwhitelist address

⌘I

API Documentation

Master Wallet

Address

Withdraw

Swap

Virtual Accounts

Custom Smart Contracts

Signing

Asset Management

Transactions

AML(Anti Money Laundering)

Auto Settlements

Gateway

Beneficiaries

Payment Links

Asset Recovery

Miscellaneous

Whitelist address

Body Parameters

Authorizations

Path Parameters

Body

Response