Crypto transaction

Request

Use this endpoint to screen a cryptocurrency transaction for AML risk. The system analyzes the transaction against blockchain analytics data and delivers the result asynchronously to your callback_url as a SERVICE_RESULT callback with service_request_type equal to CRYPTO_TRANSACTION_CHECK.

This endpoint is not available for form-token authentication or test mode requests.

Security

API-Key

Bodyapplication/jsonrequired

hashstring, [ 16 .. 128 ] charactersrequired

The cryptocurrency wallet address to be checked.

Example:"27c5caea93ee4656881ef9a30fadd21a3768"

addressstring, [ 16 .. 128 ] charactersrequired

The cryptocurrency wallet address related to the transaction. Whether this address is the sender or the recipient depends on direction.

Example:"GQzMeEMwAR44ugoNCifTb5NdRKos0GduDUPeNh6AgV46"

assetstringrequired

The asset ticker of the checked address.

Enum:"BTC""BCH""LTC""XRP""ETC""ADA""ETH""TRX""ALGO""XLM"

Example:"BTC"

directionstringrequired

The direction of the transaction relative to address:

deposit — funds are being received at address (the counterparty is the sender being screened).
withdrawal — funds are being sent from address (the counterparty is the recipient being screened).

Enum:"deposit""withdrawal"

Example:"withdrawal"

callback_urlstring, (uri), <= 2048 charactersrequired

The endpoint URL where our system will send real-time webhook notifications via POST request. Your server should respond with a 200 OK status to acknowledge receipt

Example:"https://webhook.site/34374c1f-3b2b-4060-ad26-8a556478df03"

{
  "hash": "27c5caea93ee4656881ef9a30fadd21a3768",
  "address": "GQzMeEMwAR44ugoNCifTb5NdRKos0GduDUPeNh6AgV46",
  "asset": "BTC",
  "direction": "withdrawal",
  "callback_url": "https://webhook.site/34374c1f-3b2b-4060-ad26-8a556478df03"
}

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json

dataobject

Response

{
  "data": {
    "service_request_id": "6bff21e17da144418b7643267ba4502930a9"
  }
}