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
  • Tips
  • Basic Info
  • Header Request Parameter
  • Query Parameter
  • Return Parameter
  • Example of Request Data
  • Example of Response Data
  • Error Code
  1. API Endpoints
  2. Security

1. Black address screening

Applicable Scenarios

  1. When your user transfers funds to you, you can get confirmed whether it is a known risky address.

  2. When your user transfers funds out, you can get confirmed whether it is a known risky address.

Description

Beosin-KYT can match the queried address in our address label database. If it hits a specific risk type, it will return "true"; otherwise, it will return "false".

Tips

  1. Check if the address matches the malicious label. If it matches "Sanction, Scam, Gambling, Darknet, Theft, Mixing, Hacker, Ransomware, Trojan, Child Abuse Material, Terrorist, Drug, lawsuit, Business Black List, Piracy", then return corresponding (yes/no).

Basic Info

  • Request method: GET

  • Interface URL: https://api.beosin.com/api/v1/tag/black/screening

  • 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

address

Y

String

Check if the address is a black address

Return Parameter

Parameter
Parameter Type
Description

code

Number

Status code

msg

String

Result Message

data

Object

Result set

data.lawsuit

Boolean

Is the address covered in the global judicial network

data.piracy

Boolean

Is the address profiting from pirated software

data.mixing

Boolean

Whether the address provides mixing service for users

data.gambling

Boolean

Is the address involved in offline gambling

data.scam

Boolean

Is the address involved in illegal access to virtual currencies by means of financial fraud, phishing, Ponzi schemes, etc.

data.darknet

Boolean

Whether the Address involved in illegal transactions on dark web platforms and addresses of dark web users

data.trojan

Boolean

Is the address receiving money by means of Trojan

data.theft

Boolean

Whether addresses involved in theft by illegally obtaining control permissions

data.terrorist

Boolean

Is the address related to terrorist organisations identified by various countries

data.drug

Boolean

Is the address a drug trafficking organisation

data.hacker

Boolean

Is the address involved in illegal profit by exploiting smart contract vulnerabilities

data.businessBlackList

Boolean

Is the address a commercial company sanctioned address

data.sanction

Boolean

Is the address directly related to sanctions in global countries

data.childAbuseMaterial

Boolean

Is the address associated with child sexual abuse

data.ransomware

Boolean

Is the address receiving money by means of ransomware

data.fraudShop

Boolean

Fraud shops are shops that are motivated by financial gain and sell different types of data, including personally identifiable information (PII), credit card data, and stolen accounts.

data.undergroundBank

Boolean

Illegal bank refers to a special illegal financial organization, which is engaged in illegal financial business such as illegal trading of foreign exchange, cross-border fund transfer or fund deposit and loan.

data.moneyMule

Boolean

Money mule vests are people who facilitate the illegal transfer or money laundering of others, usually through their own bank accounts. Usually a person or entity.

data.protocolPiracy

Boolean

Protocol Privacy generally mean that transactions in, out and between pools are transparent, but counterparty addresses within the pool remain encrypted, and exposure of receiving shielded pools does not necessarily mean that funds are mixed or intentionally obfuscated.

data.illicitActorOrganization

Boolean

Illegal actor organizations refer to individuals or organizations that directly or indirectly engage in various forms of illegal activities。

data.highRiskExchange

Boolean

High Risk Exchanges generally refer to exchanges that are considered high-risk due to their involvement in other risky services, no KYC, or lack of regulatory actions.

data.highRiskJurisdictionFATF

Boolean

High Risk Jurisdiction - FATF usually refer to regions or countries that have higher risks and are blacklisted by FATF.

data.greyListFATF

Boolean

Grey List - FATF usually refers to countries or regions that should be monitored more strictly and are blacklisted by the FATF.

data.officialFreeze

Boolean

Official Freeze usually refers to the address of the blockchain-related business that is identified as having bad behaviors, illegal operations or high-risk enterprises, organizations, and individuals, and the address that is frozen by the relevant commercial company

Example of Request Data

https://api.beosin.com/api/v1/tag/black/screening?platform=bsc&address=0x3cffd56b47b7b41c56258d9c7731abadc360e073

Example of Response Data

```json
{
    "code": 200,
    "msg": "success",
    "data": {
        "sanction": true,
        "scam": false,
        "gambling": false,
        "darknet": false,
        "theft": false,
        "mixing": false,
        "hacker": false,
        "ransomware": false,
        "trojan": false,
        "childAbuseMaterial": false,
        "terrorist": false,
        "drug": false,
        "lawsuit": false,
        "businessBlackList": false,
        "piracy": false,
        "fraudShop": false,
        "undergroundBank": false,
        "moneyMule": false,
        "protocolPiracy": false,
        "illicitActorOrganization": false,
        "highRiskExchange": false,
        "highRiskJurisdictionFATF": false,
        "greyListFATF": false,
        "officialFreeze": true
    }
}
```

Error Code

Error Code
Description
Solution

40021

Platform not supported

Check the passing parameters

40022

Address error

Check the passing parameters

PreviousSecurityNextSupport

Last updated 4 months ago

Blockchain platform. See more at

🎯
APPID
APP-SECRET
platform
Supported Blockchain Platforms and Token Info