Skip to main content

How to register a full transfer

To register a full transfer using POST /v1/transfers/register/, you must provide the following fields:

  • client_id (optional) — external client ID the transfer will be associated with.
  • direction — transfer direction.
  • network — network code where the transfer occurred.
  • tx_hash — transaction hash the transfer belongs to.
  • token_id — token identifier within the network.
  • output_address — recipient address.

Request​

curl -X POST "https://kyt-api.bitok.org/v1/transfers/register/"   --header "Content-Type: application/json"   --header "Accept: application/json"   --header "API-KEY-ID:{KEY_ID}"   --header "API-TIMESTAMP:{TIMESTAMP}"   --header "API-SIGNATURE:{SIGNATURE}"   --data '{
    "client_id": "id0001",
    "direction": "incoming",
    "network": "ETH",
    "tx_hash": "0x46bf4313a1f7f22cf97859d119c609fedad81541330de661f967795cc4f46e89",
    "token_id": "0xdac17f958d2ee523a2206206994597c13d831ec7",
    "output_address": "0x98Cb5718876AaB18e3A8429a18Ad543f6369A6f3"
  }'

Response​

{
  "id": "cdc3fd93-c975-4b79-beb7-4ad058078b48",
  "client_id": "id0001",
  "registered_at": "2023-12-18T13:47:25.197606+03:00",
  "occurred_at": null,
  "direction": "incoming",
  "risk_level": "undefined",
  "network": "ETH",
  "token_id": "0xdac17f958d2ee523a2206206994597c13d831ec7",
  "token_symbol": "USDT",
  "tx_hash": "0x46bf4313a1f7f22cf97859d119c609fedad81541330de661f967795cc4f46e89",
  "tx_status": "binding",
  "input_address": null,
  "output_address": "0x98cb5718876aab18e3a8429a18ad543f6369a6f3",
  "amount": null,
  "fiat_currency": "USD",
  "value_in_fiat": null,
  "check_state": {
    "exposure": "queued",
    "exposure_checked_at": null,
    "counterparty": "none",
    "counterparty_checked_at": null,
    "sanctions": "none",
    "sanctions_checked_at": null
  }
}

After binding​

When the transaction is bound, the transfer is enriched with all necessary properties (e.g. occurred_at, addresses, amount, value_in_fiat, and updated check_state).

Request​

curl -X GET "https://kyt-api.bitok.org/v1/transfers/cdc3fd93-c975-4b79-beb7-4ad058078b48/"   --header "Accept: application/json"   --header "API-KEY-ID:{KEY_ID}"   --header "API-TIMESTAMP:{TIMESTAMP}"   --header "API-SIGNATURE:{SIGNATURE}"

Response​

{
  "id": "cdc3fd93-c975-4b79-beb7-4ad058078b48",
  "client_id": "id0001",
  "registered_at": "2023-12-18T13:47:25.197606+03:00",
  "occurred_at": "2023-12-18T13:46:23+03:00",
  "direction": "incoming",
  "risk_level": "medium",
  "network": "ETH",
  "token_id": "0xdac17f958d2ee523a2206206994597c13d831ec7",
  "token_symbol": "USDT",
  "tx_hash": "0x46bf4313a1f7f22cf97859d119c609fedad81541330de661f967795cc4f46e89",
  "tx_status": "bound",
  "input_address": "0x56eddb7aa87536c09ccc2793473599fd21a8b17f",
  "output_address": "0x98cb5718876aab18e3a8429a18ad543f6369a6f3",
  "amount": 1206,
  "fiat_currency": "USD",
  "value_in_fiat": 1205.2,
  "check_state": {
    "exposure": "checked",
    "exposure_checked_at": "2023-12-18T10:47:27.045732Z",
    "counterparty": "none",
    "counterparty_checked_at": null,
    "sanctions": "checked",
    "sanctions_checked_at": "2023-12-18T10:47:27.045732Z"
  }
}