2、Real-time transaction risk alert api
Description: Supports real-time transaction monitoring for the latest transactions (within the past 24 hours) by conducting risk assessments based on transaction hashes. This includes verifying whether involved addresses are on a blacklist, checking if any transaction addresses have directly or indirectly interacted with blacklisted entities, and determining whether the transaction amount received by certain addresses exceeds AML thresholds, among other checks.
1、URL
GET /openapi/v2/risk/tx/check
2、Header Parameters
| Parameter name | Data type | Required | Description |
| timestamp | int | true | Timestamp (in seconds) |
| sign | string | true | Signature sha256("timestamp=timestamp value&secret=secretkey value") |
3、Request Parameters
| Parameter name | Data type | Required | Description |
| api_key | string | true | apikey |
| tx | string | true | Transaction hash (support querying transaction hash in the last 72 hours) |
| network | string | true | Mainnet name (Bitcoin、Ethereum..... details for "Support mainnet tokens") |
| to_address | string | true | Transfer to address |
| coin | string | true | Token Name (btc、eth、trx、bnb、usdt、usdc......details for "Support mainnet tokens") |
| app_id | string | true | app id (obtained from the KYT configuration page on the WEB side) |
| query_indirect_risk | bool | false | Whether to query indirect risk transactions (default value is true) |
| business_tag | string | false | Business type( wallet: wallet exchange: exchange NFT: nft ... etc.) |
| kyc_status | int | false | KYC Status ( 1: KYC certified 2: Not KYC certified ) |
| kyc_level | int | false | KYC level ( 1: KYC Level 1 2: KYC Level 2 3: KYC Level 3 4: KYC Level 4 ) |
4、Response Parameters
API key expired or invalid, interface returned:
{
"code": -1,
"data": {},
"message": "api_key is invalid"
}
The apikey and secrectkey have been verified successfully and returned normally:
{
"code": 200,
"msg": "success",
"data": {
"unique_id": "0140......8be5", //Unique ID (used to query historical data)
"risk_level": "severe", //Risk level (severe, high, medium, low, none)
"risk_code": 4444 //Risk code
"risk_source": {
"is_private_whitelist": false, //Whether to hit private whitelist
"is_private_blacklist": false, //Whether to hit private blacklist
"risk_from_address_list":[ //Risk transfer address
{
"black_address": "3E5L......44Bc",//from address
"black_address_type": "Blackmail Scam", //Blacklist address type
"black_address_label": [ //Blacklist address label
"attacker",
"hacker"
],
},
......
],
"risk_to_address_list":[ //Risk transfer address
{
"black_address": "35AT......yzew",//to address
"black_address_type": "Blackmail Scam", //Blacklist address type
"black_address_label": [ //Blacklist address label
"attacker",
"hacker"
],
},
......
],
"direct_tx_from_risk_list":[ //List of direct risk transactions to the address of the transaction sender
{
"black_address": "1KHw......aGbX", //Blackmail
"tx_hash": "2bc3......b693",
"black_address_type": "Blackmail Scam", //Risk type
"black_address_label": [ //Blacklist address label
"attacker",
"hacker"
],
},
......
],
"direct_tx_to_risk_list":[ //List of direct risk transactions for transaction recipient addresses
{
"black_address": "1KHw......aGbX", //Blacklist
"tx_hash": "2bc3......b693",
"black_address_type": "Blackmail Scam", //Risk type
"black_address_label": [ //Blacklist address label
"attacker",
"hacker"
],
},
......
],
"from_indirect_risk_list":[ //Transaction Send Send Indirect Risk Transaction List
{
"indirect_level": 2, //Indirect level
"black_address":"0x99......4bE1", //Blacklist of indirect transactions
"black_address_type": "Blackmail Scam", //Risk type
"indirect_tx_list":[ //Indirect transaction hash
"0x74......2a90",
"0x56......9d4b"
],
"black_address_label": [ //Blacklist address label
"attacker",
"hacker"
],
},
......
],
"to_indirect_risk_list":[ //Transaction Recipient Indirect Risk Transaction List
{
"indirect_level": 2, //Indirect level
"black_address":"0x99......4bE1", //Blacklist of indirect transactions
"black_address_type": "Blackmail Scam", //Risk type
"indirect_tx_list":[ //Indirect transaction hash
"0x74......2a90",
"0x56......9d4b"
],
"black_address_label": [ //Blacklist address label
"attacker",
"hacker"
],
},
......
]
}
}
}
| Parameter name | Data type | Description |
| code | Int | 200: The request was successful -2: The mainnet is not supported |
| message | string | Interface Request Status Description |
| unique_id | string | Unique id (identifies the current request, used to query history) |
| risk_level | string | Risk level( severe high medium low none ) |
| risk_code | int | Risk code( 0: unknown -1: Not found 4444: hit blacklist details for "Risk_Code Instruction manual" ) |
| risk_source | jsonArray | Risk source |
| risk_source.risk_from_address_list | jsonArray | Blacklist list in transaction sender address |
| risk_source.risk_to_address_list | jsonArray | Blacklist list in transaction recipient addresses |
| risk_source.direct_tx_from_risk_list | jsonArray | List of direct risk transactions to the address of the transaction sender |
| risk_source.direct_tx_to_risk_list | jsonArray | List of direct risk transactions for transaction recipient addresses |
| risk_source.from_indirect_risk_list | jsonArray | List of indirect risk transactions to which the transaction is sent |
| risk_source.to_indirect_risk_list | jsonArray | List of indirect risk transactions for transaction receiving and sending addresses |