VerifyVASP
Search
K
Comment on page

Pre Screening

post
http://<enclave-endpoint>
/v1/pre-screening
Request Pre-Screening with wallet address information
This API is for inquiring about the risk level of a wallet address by providing wallet address information.
It is recommended to perform a preliminary verification of the wallet address using the Pre Screening API before making a User Verification (POST /verifications) request.
The pre-screening API is used to verify the risk rating of a wallet address through the Enclave server before the transfer of virtual assets. It internally utilizes Chainalysis services.

Request Body

Request Body Examples
{
"asset": "BTC",
"address": "3BXMsqefKjHmBX8BWXUtY2DneRYCR5gMgG"
}
Field Name
Data Type
Required
Description
asset
string
true
Virtual Asset.
It is the symbol name of a virtual asset. (ex: ETH instead of Ethereum or Ether)
address
string
true
Wallet Address of Virtual Asset

Response Body

Response Body Examples
  • 200 OK
{
"preScreening": {
"asset": "BTC",
"address": "3BXMsqefKjHmBX8BWXUtY2DneRYCR5gMgG",
"preScreeningId": "27515463504232501",
"clusterName": "UPbit.com",
"clusterCategory": "exchange",
"rating": "LOW",
"createdAt": "2022-01-19T09:11:26.640Z"
}
}

Payload

Field Name
Data Type
Required
Description
preScreening
object
true
-
preScreening.asset
string
true
Virtual assets which are related to the originating wallet address or the symbol of tokens.
e.g. BTC, ETH, UNI, etc.
preScreening.address
string
true
the originating wallet address
preScreening.preScreeningId
string
true
Requested ID for Pre Screening
preScreening.clusterName
string
false
Name of the cluster
preScreening.clusterCategory
boolean
false
Category of the cluster
preScreening.rating
string
true
risk
preScreening.createdAt
string
true
The time at which the request was created using Pre Screening API. UTC ISO 8601 format.
  • Use <mark style-"color:blue;">preScreening.rating field as follows.
    • Set as one of "UNKNOWN", "HIGH", "MEDIUM", "LOW".
    • The risk rating of the known recipient address.

Error Codes

Mandatory parameter missing case.

Response Body Examples
  • 400 Bad Request
{
"code": "MISSING-ASSET",
"message": "`asset` is required."
}

Not supported symbol case.

Response Body Examples
  • 400 Bad Request
{
"code": "UNKNOWN-SYMBOL",
"message": "The asset 'XXXX' is not supported"
}

Malformed address inputs.

Response Body Examples
  • 400 Bad Request
{
"code": "INVALID-ADDRESS",
"message": "The 'BTC' address 'bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wl' at position 1 in the input list is not syntactically valid"
}

Other exceptional cases.

Response Body Examples
  • 400 Bad Request
{
"code": "BAD-REQUEST",
"message": "......"
}