Add/Edit Whitelisted Address

POST

/open-api/v1/wallet/addWhitelist

This method allows you to add/edit a whitelisted address.

API Key permission group : Enable Wallet Management

Designated Wallet : Not allowed to set a designated wallet. All wallets are allowed.

Request

Header Params

Body Params application/json

Example

{
    "symbol": "BTC",
    "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "network": "BTC",
    "addressType": 1,
    "label": "BTC address",
    "correspondentDetail": {
        "toFromType": 1,
        "provider": null,
        "othersPleaseSpecify": null,
        "correspondentType": 1,
        "firstName": "Satoshi",
        "lastName": "Nakamoto",
        "fullName": null,
        "birthday": "2009-01-03",
        "countryInfo": "United States"
    },
    "confirmation": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/open-api/v1/wallet/addWhitelist' \
--header 'open-apikey;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "symbol": "BTC",
    "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "network": "BTC",
    "addressType": 1,
    "label": "BTC address",
    "correspondentDetail": {
        "toFromType": 1,
        "provider": null,
        "othersPleaseSpecify": null,
        "correspondentType": 1,
        "firstName": "Satoshi",
        "lastName": "Nakamoto",
        "fullName": null,
        "birthday": "2009-01-03",
        "countryInfo": "United States"
    },
    "confirmation": "string"
}'

Responses

🟢200The operation succeeded

application/json

Body

Example

{
    "data": {
        "whitelistId": "123456789",
        "approveId": null
    },
    "code": "000000",
    "message": "Success"
}

🟢200Business error

🟠400The client request is invalid

🟠401Authentication failed (e.g., invalid token specified by the Authorization header)

🟠403Authentication failed, but the operation is not allowed

🟠404Requested resource does not exist

🟠429Client request rate exceeded the limit

🔴500System error

Get Correspondent's Options

Transaction History List