kya/screening

[Deprecated] Recommended migration to screening_v2.

Summary

The /kya/screening endpoint lets you retrieve all transactions involving risky counterparties for a given chain and address, including both token transfers and native-coin transfers.

Request

• HTTP Method: GET
• Endpoint Path: /kya/screening
• Query Parameters:

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

Response

Field	Type	Presence	Description
chain	String	Always	The blockchain network identifier (e.g., eth).
address	String	Always	The primary wallet address being screened.
risk_level	String	Always	The overall risk level of the primary address.
risk_score	Integer	Always	The numerical risk score of the primary address.
risk_reasons	Array[String]	Always (Returns [] if none)	Explanations for the risk of the primary address.
counterparties	Array[Object]	Always (Returns [] if none)	A list of addresses that have interacted with the primary address.
-counterparty	String	Always (within Counterparties)	The wallet address of the counterparty.
-risk	Object	Always (within Counterparties)	Risk profile of the specific counterparty.
--risk_level	String	Always (within Risk)	Risk level of the counterparty (e.g., Low, Medium, High).
--risk_score	Integer	Always (within Risk)	Numerical risk score of the counterparty.
--risk_reasons	Array[String]	Always (within Risk)	Explanations for the risk of the counterparty.
-transactions	Array[Object]	Always (within Counterparties)	List of specific transactions between the primary address and this counterparty.
--tx_hash	String	Always (within Transactions)	The unique transaction hash on the blockchain.
--block_number	Integer	Always (within Transactions)	The block height where the transaction was recorded.
--timestamp	Integer	Always (within Transactions)	Unix timestamp of the transaction.
--from	String	Always (within Transactions)	The sending address of the transaction.
--to	String	Always (within Transactions)	The receiving address of the transaction.
--amount	Number	Always (within Transactions)	The quantity of the asset transferred.
--usd_value	Number	Always (within Transactions)	The estimated value in USD at the time of the transaction.
--symbol	String	Always (within Transactions)	The ticker symbol of the asset (e.g., ETH).
--type	String	Always (within Transactions)	The token standard or type (e.g., native, erc20).
--fund_direction	String	Always (within Transactions)	Direction of funds relative to the primary address (incoming/outgoing).
--exposure_type	String	Always (within Transactions)	Relationship type (e.g., direct for immediate counterparties).
--contract_address	String	Conditional (Present for non-native)	The smart contract address of the token (e.g., ERC-20).

Example Code

Request

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

Response

{
  "code": 200,
  "message": "success",
  "data": {
    "chain": "eth",
    "address": "0x0fa09c3a328792253f8dee7116848723b72a6d2e",
    "risk_level": "High",
    "risk_score": 5,
    "risk_reasons": [
      "label: Hack/Contract Exploit",
      "label: Scam/Phishing"
    ],
    "counterparties": [
      {
        "counterparty": "0xbdd077f651ebe7f7b3ce16fe5f2b025be2969516",
        "risk": {
          "risk_level": "High",
          "risk_score": 5,
          "risk_reasons": [
            "label: Hack/Contract Exploit",
            "label: Scam/Phishing"
          ]
        },
        "transactions": [
          {
            "tx_hash": "0xa1bf5d6aaf1faaa94e2a844fdb3c0686821af6075571a73c7ba9cf66925eb35a",
            "block_number": 21878856,
            "timestamp": 1739949323,
            "from": "0x0fa09c3a328792253f8dee7116848723b72a6d2e",
            "to": "0xbdd077f651ebe7f7b3ce16fe5f2b025be2969516",
            "amount": 0.01,
            "symbol": "ETH",
            "type": "native",
            "fund_direction": "outgoing",
            "exposure_type": "direct"
          }
        ]
      },
      {
        "...": "omitted additional items"
      }
    ]
  }
}

Note: The response above is abbreviated and only shows representative items.

Try It