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

Request

Header Params

open-apikey

string

required

OpenAPI key string

signature

string

required

Signature of the request

whitelistId

string

required

Whitelist address ID, required when edit

addressType

integer

required

Address type, 1 (standard) or 2 (universal)

address

string

required

Blockchain address

label

string

required

Custom label of address on system

symbol

string

required

Coin symbol

network

string

required

Network symbol

memo

string

optional

Address memo

correspondentDetail

object (CorrespondentDetail)

optional

firstName

string

optional

Required to be non-null if correspondentType is 1 (Individual)

lastName

string

optional

Required to be non-null if correspondentType is 1 (Individual)

fullName

string

optional

Required to be non-null if correspondentType is 0 (Entity)

birthday

string

optional

YYYY-MM-DD format. Required to be non-null if correspondentType is 1 (Individual)

provider

string

optional

Required to be non-null if toFromType is 0 (Virtual Assets Services Providers)
Refer to api "Get Correspondent’s Options" for acceptable VASP value

countryInfo

string

required

Refer to api "Get Correspondent’s Options" for for acceptable country name

toFromType

enum<integer>

required

Allowed values:

012

correspondentType

enum<integer>

required

Allowed values:

othersPleaseSpecify

string

optional

Required to be non-null if toFromType is 2 (Others)

confirmation

string

required

Confirm that the corresponding party is not a sanction individual/party, value: "confirmed" / "unconfirmed"

timestamp

string

required

Current timestamp in millisecond

{
  "whitelistId": "string",
  "addressType": 0,
  "address": "string",
  "label": "string",
  "symbol": "string",
  "network": "string",
  "memo": "string",
  "correspondentDetail": {
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "birthday": "string",
    "provider": "string",
    "countryInfo": "string",
    "toFromType": 0,
    "correspondentType": 0,
    "othersPleaseSpecify": "string"
  },
  "confirmation": "string",
  "timestamp": "string"
}

Request samples

Responses

OK(200)

Bad Request(400)

Unauthorized(401)

Forbidden(403)

Record Not Found(404)

429(429)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

data

object | null

optional

response data, maybe null

whitelistId

string

required

Whitelist address ID

approveId

string | null

required

Approval ID

code

string

required

'000000' indicates success, while any others indicate failure.

message

string

required

When the code is '000000' (success), it represents the details of the response. Otherwise, it represents the details of the error.

{
  "data": {
    "whitelistId": "123456789",
    "approveId": null
  }
}

Last modified: a month ago