Check withdrawal risks

The method allows you to check the risks of withdrawal before making it.

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

Request:

Parameter	Required	Type	Description
currency	Yes	String	Currency
network	Yes	String	Network
address	Yes	String	Recipient address of coins
amount	Yes	String	Withdrawal amount

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 withdrawal risks

POSThttps://ocp.onchainpay.io/api-gateway/kyt/check-withdrawal-address

Header parameters

Body

application/json

currencystring

Coin

networkstring

Network

addressstring

Address-recipient of coins

amountstring

Withdrawal amount

Response

200

Body

application/json

success*boolean

Request success indicator

response*CheckTransferResponse (object)

The body of the risk check response

Request

JavaScriptCurl

const response = await fetch('https://ocp.onchainpay.io/api-gateway/kyt/check-withdrawal-address', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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