Ceffu OpenAPI Documentation Platform
  1. Whitelisted Addresses
Ceffu OpenAPI Documentation Platform
  • Changes
    • Upcoming Changes
    • Change log
  • Development Tools and Resource
    • Overview
      • Welcome to Ceffu OpenAPI
    • Quickstart
      • Initial Setup
      • Using the Ceffu SDK
    • Authentication
    • Rate limit
    • Error Codes
    • Webhook Introduction
  • Concepts
    • Ceffu Custody
  • System Endpoints
    • Get System status
  • Wallet Management
    • Ceffu Supported Asset Endpoint
      • Get Prime Wallet supported coins list
      • Get Qualified Wallet supported coins list
      • Get Cosign Wallet supported coins list
    • Qualified Wallets and Prime Wallets Endpoint
      • Create Wallet
      • Update Wallet Details
      • Get Wallet List
      • Get Asset Details
      • Get Wallet Asset Summary
    • Deposits
      • Get Deposit Address
      • Get Deposit History
      • Get Deposit Detail
    • Withdrawals
      • Withdrawal
      • Get Withdrawal Fee (estimated)
      • Get Withdrawal History
      • Get Withdrawal Details
    • Whitelisted Addresses
      • Get Whitelisted Address List
        GET
      • Get Correspondent’s Options
        GET
      • Add/Edit Whitelisted Address
        POST
    • Transactions
      • Transaction History List
  • PW Sub Wallets
    • Sub-Wallet Management
      • Create Sub-Wallet
      • Update Sub-Wallet Details
      • Get Sub-Wallet List
      • Get Sub-Wallet Asset Details
      • Get Sub-Wallet Asset Summary
    • Sub-Wallet Deposits
      • Get Sub-Wallet Deposit Address
      • Get Deposit Address List under Prime Wallet
      • Get Deposit History under Sub-Wallet
      • Get Sub-Wallet Deposit History By Prime Wallet
    • Internal Transfers
      • Transfer between Sub Wallet and Prime Wallet
      • Get Transfer History between Sub-Wallet and Prime Wallet
    • Transactions
      • Get Transaction Details of Prime Wallet Internal Transfer
  • MirrorX
    • Link & Account
      • Get MirrorX LinkId List
    • Balances & Positions
      • Check MirrorX Available amount
      • Get MirrorX Asset Positions
    • Orders
      • Get MirrorX Orders
      • Place MirrorX Orders
  • Webhooks & Notifications
    • Resend webhook notifications
  • Archive
    • Mirror Endpoints
      • Get Mirror Linked Binance UID List
      • MIrror Assets Application
      • MIrror Assets Settlement
      • Get Mirror Operation Records
      • Get Mirrored Asset Positions
      • Get Mirrored Asset Summary
    • Wallet Endpoints
      • Get Transfer Detail with Exchange
      • Get Transfer History with Exchange
      • Transfer with Exchange
      • Get Withdrawal History
      • Get Withdrawal Details
      • Withdrawal
      • Get Sub-Wallet List (V1)
  1. Whitelisted Addresses

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 Impacted

Request

Header Params

Body Params application/json

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,
        "jurisdictionVaspCode": "string",
        "selfHostedWalletProvider": "string",
        "othersPleaseSpecify": "string"
    },
    "confirmation": "string",
    "timestamp": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/open-api/v1/wallet/addWhitelist' \
--header 'open-apikey;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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,
        "jurisdictionVaspCode": "string",
        "selfHostedWalletProvider": "string",
        "othersPleaseSpecify": "string"
    },
    "confirmation": "string",
    "timestamp": "string"
}'

Responses

🟢200OK
application/json
Body

Example
{
    "data": {
        "whitelistId": "123456789",
        "approveId": null
    }
}
🟢200OK
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠429429
🔴500Server Error
Previous
Get Correspondent’s Options
Next
Transaction History List