Screen a crypto transaction

Submits a cryptocurrency transaction for KYT screening via configured provider (e.g. XZiel). Returns a screening record; risk data is present only when status is final (SUCCEEDED/FAILED/COMPLETED/CLOSED).

POST/v1/kyt/crypto/screen

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

transaction_id*string

Client transaction identifier

external_ref_id?string

Optional external reference

customer_id*string

currency*string

Asset symbol, e.g. ETH

amount*string

Decimal amount as string

direction*string

wallet_address*string

network*string

Blockchain network, e.g. ethereum

tx_hash?string

tx_timestamp?string

idempotency_key?string

metadata?

Response Body

`application/json`

curl -X POST "https://example.com/v1/kyt/crypto/screen" \  -H "Content-Type: application/json" \  -d '{    "transaction_id": "string",    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",    "currency": "string",    "amount": "string",    "direction": "INBOUND",    "wallet_address": "string",    "network": "string"  }'

{
  "screening_id": "c21341e0-a82a-41e6-9578-cd022db5aa1a",
  "provider": "string",
  "provider_ref_id": "string",
  "status": "string",
  "action": "string",
  "kyt_flag": "string",
  "risk_score_level": 0,
  "risk_score_label": "string",
  "alert_count": 0,
  "alerts": [
    {
      "alert_id": "string",
      "rule_id": "string",
      "status": "string",
      "risk_score_level": 0,
      "risk_score_label": "string",
      "category": "string",
      "message": "string",
      "issued_at": "2019-08-24T14:15:22Z"
    }
  ],
  "screened_at": "2019-08-24T14:15:22Z"
}

{
  "error": "string",
  "code": "string",
  "status": 0
}

{
  "error": "string",
  "code": "string",
  "status": 0
}

Request Body

Response Body

201application/json

400application/json

500application/json

`application/json`

`application/json`

`application/json`