Get Correspondent’s Options

GET/open-api/v1/wallet/whitelist/options

This method allows you to get all configuration options of the whitelisted address.

API Key permission group : Enable Enquiry

Request

Query Params

timestamp

integer

required

Current Timestamp in millisecond

Example:

1640995200000

Header Params

open-apikey

string

required

OpenAPI key string

signature

string

required

Signature of the request

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

optional

response data, maybe null

Any of

WhitelistCorrespondentOptions

null

options

object

required

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.

{
  "options": {
    "toFromType": {
      "0": "Virtual Assets Services Providers",
      "1": "Unhosted Wallet",
      "2": "Others (not specified above)"
    },
    "addressType": {
      "1": "Standard Address",
      "2": "Universal Address"
    },
    "correspondentType": {
      "0": "Entity",
      "1": "Individual"
    },
    "listOfVASP": [
      {
        "name": "..."
      }
    ]
  }
}

Last modified: 6 days ago