Check transaction risks

The method allows you to check the risks of a completed transaction.

This request can be executed for several seconds. It is not recommended to set timeout less than 15 seconds.

Request:

Parameter	Required	Type	Description
tx	Yes	String	Transaction hash
currency	Yes	String	Currency
network	Yes	String	Network
outputAddress	Yes	String	Recipient address of coins
direction	Yes	String	The side to check the risks. Takes the value sent or received. The sent value should be passed if a withdrawal transaction was made from your address. Then the risks of the completed transaction from the side of the sender will be checked The received value should be passed if a deposit was made to your address. Then the risks of receiving coins to your address will be checked

Response:

Parameter	Type	Description
level	String	Risk level
categories	String	Array with risk categorization
categories.level	String	Risk level in this category
categories.usdAmount	Number	The amount in USD that is associated with this risk category
categories.category	String or null	Category name
categories.service	String or null	A service that is associated with this risk category
categories.exposure	String	DIRECT - direct connection ("dirty" coins were sent from the attacker's address to the recipient's address directly) INDIRECT - indirect connection (the coins were marked risky, but passed through a chain of addresses)

The level parameter can take the following values:

• white - no risk

• green - low risk

• yellow - medium risk

• red - high risk

• black - severe risk

Check transaction risks

post

Header parameters

x-api-public-keystringoptional

Public API-key

x-api-signaturestringoptional

Signing the request body with a private API-key

Content-typestringoptional

Request content type

Example: application/json

Body

The request body for checking the transaction for risks

txstringrequired

Transaction hash

Example: 0x00E2453...

currencystringrequired

Coin

Example: USDT

networksstringoptional

Network

Example: ethereum

outputAddressstringrequired

Address-recipient of coins

Example: 0x023434a...

directionstring · enumrequired

The party to check the risks. Takes the value sent or received.

The sent value should be passed if a withdrawal transaction was made from your address: then the risks of the completed transaction on the part of the sender will be checked

The received value should be transmitted if a deposit was made to your address: then the risks of receiving coins to your address will be checked

Example: sentAvailable options:

Responses

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/kyt/check-transfer' \
  --header 'Content-Type: application/json' \
  --data '{
    "tx": "0x00E2453...",
    "currency": "USDT",
    "networks": "ethereum",
    "outputAddress": "0x023434a...",
    "direction": "sent"
  }'

200

200

{
  "success": true,
  "response": {
    "level": "yellow",
    "categories": [
      {
        "level": "yellow",
        "usdAmount": 1,
        "category": "stolen funds",
        "service": "Reported as stolen funds bc1qlf4vel",
        "exposure": "DIRECT"
      }
    ]
  }
}