Ceffu OpenAPI Documentation Platform
  • ChangeLog
  • Getting Started
  • System Endpoints
  • Wallet Endpoints
    • Get Prime Wallet supported coins listGET
    • Get Qualified Wallet supported coins listGET
    • Get Cosign Wallet supported coins listGET
    • Get Wallet ListGET
    • Get Asset DetailsGET
    • Get Wallet Asset SummaryGET
    • Get Deposit AddressGET
    • Get Deposit HistoryGET
    • Get Deposit Detail (V2)GET
    • Get Withdrawal Fee (estimated)GET
    • Get Withdrawal History (V2)GET
    • Get Withdrawal Details (V2)GET
    • Get Whitelisted Address ListGET
    • Get Correspondent’s OptionsGET
    • Create WalletPOST
    • Update Wallet DetailsPOST
    • Withdrawal (V2)POST
    • Transaction History ListPOST
    • Add/Edit Whitelisted AddressPOST
  • Sub-Wallet Endpoints
  • MirrorX Endpoints
  • Webhook
  • Archive
logoPowered by Apifox
  1. Wallet Endpoints

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

Body Params application/json
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

1

firstName
string 
optional
lastName
string 
optional
fullName
string 
optional
birthday
string 
optional
provider
string 
optional
countryInfo
string 
optional
toFromType
enum<integer> 
optional
Allowed values:
012
correspondentType
enum<integer> 
optional
Allowed values:
01
othersPleaseSpecify
string 
optional
Example
{
  "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"
  }
}

Request samples

Responses

OK(200)
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 Schema
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.

Example
{
  "data": {
    "whitelistId": "123456789",
    "approveId": null
  }
}
Last modified: 6 days ago