kya/labels

Summary

The kya/labels endpoint provides detailed insights into blockchain address labeling. It returns both entity and behavior labels for a given address on a specified chain.

This allows users to:

Identify the type of entity associated with an address.
Understand behavioral patterns linked to the address.
Evaluate the address’s risk level based on its assigned labels.

Request

HTTP Method: GET
Endpoint Path: /kya/labels
Query Parameters:

Parameter	Type	Required	Description	Example
`chain`	String	No	Name of the target blockchain (must be a supported chain; see Supported Chains)	`eth`, `btc`, `bsc`
`address`	String	Yes	Valid blockchain address to retrieve labels for	`0x1234567890abcdef1234567890abcdef12345678`

Response

Field	Type	Presence	Description
`chain`	String	Always	The blockchain network identifier (e.g., `btc`, `eth`).
`address`	String	Always	The blockchain wallet address being queried.
`entities`	Array[Object]	Conditional (Present if entities exist)	Profile details of organizations/entities associated with the address.
`-entity_id`	String	Always (within `entities`)	Unique identifier for the identified entity (e.g., `kucoin`).
`-entity_name`	Object	Always (within `entities`)	Multilingual names of the entity (includes `en` and `zh` keys).
`-country`	Object	Always (within `entities`)	The country/region where the entity is registered or primarily operates.
`-description`	Object	Always (within `entities`)	Detailed background of the entity, including financial metrics and reserves.
`-link`	String	Always (within `entities`)	Primary official website URL of the entity.
`-other_link`	String	Always (within `entities`)	Comma-separated external links (social media, community, etc.).
`labels`	Array[Object]	Always (Returns `[]` if none)	A collection of behavior-based tags and classifications for the address.
`-chain`	String	Always (within `labels`)	Chain identifier for the label (e.g., `evm`, `tron`).
`-address`	String	Always (within `labels`)	Address associated with the label.
`-category`	String	Always (within `labels`)	High-level grouping (e.g., `Cefi`, `Dapp`, `Infra`).
`-sub_category`	String	Always (within `labels`)	Granular classification providing context (e.g., `CEX`, `DEX`).
`-label`	String	Always (within `labels`)	The specific descriptive name of the tag (e.g., `Binance Deposit Wallet`).

Example Code

Request

curl -X GET "https://api.compliance.certik.com/v4/kya/labels?chain=eth&address=0x1b2C49CB920325F86f4C656ea9f0D6990f71867a" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Response

{
  "code": 200,
  "message": "success",
  "data": {
    "chain": "eth",
    "address": "0x1b2C49CB920325F86f4C656ea9f0D6990f71867a",
    "entities": [
      {
        "entity_id": "binance",
        "entity_name": {
          "en": "Binance",
          "zh": "币安"
        },
        "country": {
          "en": "Malta",
          "zh": "马耳他"
        },
        "description": {
          "en": "Binance is a centralized cryptocurrency exchange established in 2017 and is registered in Cayman Islands. Currently, there are 423 coins and 1548 trading pairs available on the exchange. Binance 24h volume is reported to be at $35,580,972,537.16, a change of 52.91% in the last 24 hours. Binance has $188,623,113,224.82 in Exchange Reserves. The most active trading pair is BTC/FDUSD with a 24h volume of $3,888,712,592.86. One of the world's largest cryptocurrency exchanges by trading volume, offering a wide range of services including spot, futures, and staking options.",
          "zh": ""
        },
        "link": "https://www.binance.com/",
        "other_link": ""
      }
    ],
    "labels": [
      {
        "chain": "evm",
        "address": "0x1b2C49CB920325F86f4C656ea9f0D6990f71867a",
        "category": "Cefi",
        "sub_category": "CEX",
        "label": "Binance Deposit Wallet"
      }
    ]
  }
}