Skip to main content
POST
/
api
/
v1
/
tracker
/
kyt
/
transfers
/
risk-screening
Retrieve Transaction Risks
curl --request POST \
  --url https://api.bitrace.io/api/v1/tracker/kyt/transfers/risk-screening \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key: <api-key>' \
  --data '
{
  "network": "ethereum",
  "hash": "<string>",
  "outputAddress": "<string>",
  "direction": "sent",
  "tokenContractAddress": "<string>",
  "index": 123,
  "depth": 123
}
'
{
  "success": true,
  "code": 1,
  "status": "SUCCESS",
  "data": {
    "risks": [
      {
        "riskLevel": "high",
        "riskType": "launder-money"
      },
      {
        "riskLevel": "high",
        "riskType": "online-gambling"
      }
    ],
    "externalId": "53557224252615249342456087557349",
    "resultTime": 1771059455295,
    "analyseStatus": true,
    "hash": "0xddeb5d1e29a88ac9e0a304f415628ff45f53c7278127de7f47c75b43bebcce8f",
    "value": "1902.31608",
    "blockTime": 1718669807000,
    "address": "0x974caa59e49682cda0ad2bbe82983419a2ecc400"
  },
  "msg": "SUCCESS"
}

​
Request cases

Supports below transactions on risk screening
  • ETH USDT (ERC-20) transfer
  • TRON USDT (TRC-20) transfer
  • ETH transfer
  • TRX transfer
  • BTC transfer

Authorizations

​
X-Access-Key
string
header
required

API key authentication

Body

application/json
​
network
enum<string>
required

The supported chainns short name. Values can be, eth tron btc

Available options:
ethereum,
eth,
tron,
btc
​
hash
string
required

The transaction for detect the risks

​
outputAddress
string
required

The destination address in the transaction

​
direction
enum<string>
required

This value defines whether the transfer is sent or received.

  • sent: retrieve the risks for toAddress
  • received: retrieve the risks for fromAddress
This value is case insensitive

Available options:
sent,
received
​
tokenContractAddress
string

The token contract address, for USDT,

  • eth: 0xdac17f958d2ee523a2206206994597c13d831ec7
  • tron: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
Note: it should not be empty if inquiring token transaction

​
index
integer

The position of the output address in the transaction.
Note: it is only available in the UTXO model

​
depth
integer

default is 0, and also you can also set the depth between 1-5 to the risks of screening within the transaction propagation path

Response

Successful response

​
success
boolean

Request success or not

​
code
integer

Response code (1 for success, other numbers for errors)

​
msg
string

SUCCESS or error message

​
data
object