Beosin API Documentation
  • ⭐Getting Started
    • Get API Access key
    • Verification
    • Setting the risk strategy
    • Setting the risk score
  • 🎯API Endpoints
    • Basic
      • Account balance query
    • Compliance
      • Deposit Transaction Assessment
        • Change Logs
      • Withdrawal Transaction Assessment
        • Change Logs
      • EOA Address Risk Assessment
        • Change Logs
      • EOA Address Risk Assessment (Deprecated)
        • Change Logs
      • Token Risk Assessment (Deprecated)
      • Malicious Address Query
        • Change Logs
      • VASP Query
        • Change Logs
      • Entity Query (Deprecated)
        • Change Logs
    • Security
      • 1. Black address screening
  • 🤝Support
    • Common Result Messages
    • Rate Limits
    • Some Common Labels and Types
    • Supported Blockchain Platforms
    • Common Sanction Guidelines and Sanctioned Entities
    • Contact Us
Powered by GitBook
On this page
  • Applicable Scenarios
  • Description
  • Basic Info
  • Header Request Parameter
  • Query Parameter
  • Return Parameter
  • Example of Request Data
  • Example of Response Data
  • Error Code
  1. API Endpoints
  2. Compliance

Deposit Transaction Assessment

Applicable Scenarios

When a user transfers funds to a designated wallet address on your platform, this endpoint allows you to perform a risk assessment on the source of the funds. By using this API, you can evaluate the transaction's risk level and ensure compliance with your risk management policies.

Description

Beosin-KYT will traverse all addresses in the funding source direction of the token type used by the deposit transaction, without limiting the hops and scope. If any risky entities are found during the traversal that match the risk strategies set by you, the corresponding risks will be revealed.

Basic Info

  • Request method: GET

  • Interface URL: https://api.beosin.com/api/v2/kyt/tx/deposit

  • Content-Type: application/json

  • Verification method: SIGN

  • Response Time:<30s

Header Request Parameter

Parameter
Required Field (Y/N)
Parameter Type
Description

Y

String

Unique authentication APPID assigned by KYT system

Y

String

Unique authentication APP-SECRET assigned by KYT system

Query Parameter

Parameter
Required Field (Y/N)
Parameter Type
Description

Y

String

Chain ID

hash

Y

String

Transaction Hash

token

N

String

If it is a non-native token transaction(eg. USDT, Pepe, UNI, etc.), pls also add the token address in your request. While if it a native token transaciton (eg. ETH, BTC, Sol, etc.), you are supposed to add the token name in your request.

Return Parameter

Parameter
Parameter Type
Description

code

Integer

Status code

msg

String

Result Message

data

Object

Result set

data.score

Bigdecimal

Address Scoring

data.riskLevel

String

Address Risk Level

data.risks

Array

Address Hit the Risk

data.risks[0].riskStrategy

String

Risk Hitting Strategy

data.risks[0].riskDetails

Array

Details of the Risk

data.risks[0].riskDetails[0].riskName

String

Risk Name

data.risks[0].riskDetails[0].rate

Bigdecimal

Proportion of Funds (4 Valid Digits Reserved)

data.risks[0].riskDetails[0].amount

Bigdecimal

Amount

Example of Request Data

https://api.beosin.com/api/v2/kyt/tx/deposit?
chainId=1&hash=0x919aeb1d0ed579dbbe15a0a695b221c746c2b45d68553da0c203747c1255f739

Example of Response Data

{
  "code": 200,
  "msg": "success",
  "data": {
    "score": 59.56699999999999,
    "riskLevel": "High",
    "risks": [
      {
        "riskStrategy": "Systematic generic risk strategy",
        "riskDetails": [
          {
            "riskName": "Black List",
            "rate": 0.5311,
            "amount": 4923.976808
          },
          {
            "riskName": "Exchange",
            "rate": 0.4689,
            "amount": 4347.303192
          }
        ]
      }
    ]
  }
}

Error Code

Error Code
Description

41024

Assessments for non-ERC20 transactions are not supported.

40023

Transaction Hash error

40021

Platform not supported

40001

Parameter error

41023

Transaction Hash not exist.

41035

This transaction involves a token that is not in the token basket, please add that token.

41038

The task is being executed. Please try again later.

PreviousComplianceNextChange Logs

Last updated 4 months ago

🎯
APPID
APP-SECRET
chainId