Проверить статус AML

Получает актуальный статус и оценку риска для существующей AML-проверки. Данные обновляются при появлении новой информации.

POST /v1/aml-checks/check

Запрос

Параметры

Поле	Тип	Обязательное	Описание
id	string	Да	Идентификатор AML-проверки

Bash

#!/bin/bash
API_TOKEN="your_api_token"
API_SECRET="your_api_secret"
REQUEST_BODY='{
  "id": "1042"
}'

# Подпись
SIGNATURE=$(echo -n "${REQUEST_BODY}${API_SECRET}" | sha256sum | cut -d' ' -f1)

# Запрос
curl -X POST "https://api.trxup.com/v1/aml-checks/check" \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "X-Signature: ${SIGNATURE}" \
  -H "Content-Type: application/json" \
  -d "${REQUEST_BODY}"

Node.js

const crypto = require('crypto');
const axios = require('axios');

const apiToken = 'your_api_token';
const apiSecret = 'your_api_secret';
const requestBody = JSON.stringify({
  id: '1042'
});

// Подпись
const signature = crypto
  .createHash('sha256')
  .update(requestBody + apiSecret)
  .digest('hex');

// Запрос
axios({
  method: 'post',
  url: 'https://api.trxup.com/v1/aml-checks/check',
  headers: {
    'Authorization': `Bearer ${apiToken}`,
    'X-Signature': signature,
    'Content-Type': 'application/json'
  },
  data: requestBody
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

PHP

<?php
$apiToken = 'your_api_token';
$apiSecret = 'your_api_secret';
$requestBody = json_encode([
  'id' => '1042'
]);

// Подпись
$signature = hash('sha256', $requestBody . $apiSecret);

// Запрос
$ch = curl_init('https://api.trxup.com/v1/aml-checks/check');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $requestBody);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'Authorization: Bearer ' . $apiToken,
  'X-Signature: ' . $signature,
  'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import hashlib
import json
import requests

api_token = 'your_api_token'
api_secret = 'your_api_secret'
request_body = json.dumps({
  'id': '1042'
})

# Подпись
signature = hashlib.sha256((request_body + api_secret).encode()).hexdigest()

# Запрос
headers = {
  'Authorization': f'Bearer {api_token}',
  'X-Signature': signature,
  'Content-Type': 'application/json'
}

response = requests.post(
  'https://api.trxup.com/v1/aml-checks/check',
  headers=headers,
  data=request_body
)

print(response.json())

Ответ

Возвращает данные AML-проверки с актуальной оценкой риска. Если проверка ещё в статусе pending, сервер перед ответом заново запрашивает результат, поэтому каждый вызов возвращает самое свежее состояние; повторяйте запрос, пока статус не изменится.

Поля ответа

Поле	Тип	Описание
code	integer	Код ответа (0 = успех)
request_id	string	Уникальный идентификатор запроса
result	object	Данные AML-проверки
result.id	string	Идентификатор AML-проверки
result.type	string	Тип AML-сервиса (address или hash)
result.address	string	Проверяемый адрес
result.network	string	Код сети блокчейн так, как он записан в списке поддерживаемых сетей (например, TRX, TetherOMNI)
result.status	string	Текущий статус (pending, processing, completed, failed, expired, skipped)
result.risk_score	string|null	Риск-балл — строка с двумя знаками после запятой (например, "12.50") или null, если оценки ещё нет
result.risk_level	string|null	Уровень риска (low, medium, high)
result.blacklist	boolean	Показывает, найдено ли совпадение с черными списками
result.risk_factors	array	Категории риска, с которыми связаны средства, по убыванию score, по одной записи на категорию; пустой [], если категории не переданы (например, пока проверка не завершена)
result.risk_factors[].name	string	Ключ категории — один из перечисленных в разделе Категории факторов риска; категория вне этого списка возвращается как other
result.risk_factors[].label	string	Английское название категории (не переводится)
result.risk_factors[].group	string	Группа риска категории: low, medium или high
result.risk_factors[].score	number	Доля средств, связанных с этой категорией, от 0 до 1, с округлением до 3 знаков после запятой
result.checked_at	string	Время создания проверки (ISO 8601)
result.hash	string	Проверяемый хеш (только для hash)
result.direction	string	Проверяемая сторона транзакции, deposit или withdrawal (только для hash)

Категории факторов риска

risk_factors[].name всегда принимает одно из этих значений. Категория вне этого списка возвращается как other. label всегда на английском: это часть ответа, а не перевод.

name	label	group
enforcement_action	Enforcement Action	high
ransom	Ransom	high
dark_market	Dark Market	high
dark_service	Dark Service	high
illegal_service	Illegal Service	high
mixer	Mixer	high
scam	Scam	high
gambling	Gambling	high
stolen_coins	Stolen Coins	high
exchange_fraudulent	Fraudulent Exchange	high
child_exploitation	Child Exploitation	high
sanctions	Sanctions	high
terrorism_financing	Terrorism Financing	high
malware	Malware	high
infrastructure_as_a_service	Infrastructure-as-a-Service	medium
decentralized_exchange_contract	Decentralized Exchange Contract	medium
unnamed_service	Unnamed Service	medium
atm	ATM	medium
risky_exchange	Risky Exchange	medium
p2p_exchange_mlrisk_high	P2P Exchange (High Risk)	medium
liquidity_pools	Liquidity Pools	medium
exchange	Exchange	low
merchant_services	Merchant Services	low
wallet	Wallet	low
miner	Miner	low
payment	Payment	low
marketplace	Marketplace	low
p2p_exchange	P2P Exchange	low
seized_assets	Seized Assets	low
other	Other	low

Пример ответа

{
  "code": 0,
  "request_id": "bbf74bcd-fb36-4df8-adc8-25f2bacd087b",
  "result": {
    "id": "1042",
    "type": "address",
    "address": "TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D",
    "network": "TRX",
    "status": "completed",
    "risk_score": "12.50",
    "risk_level": "medium",
    "blacklist": false,
    "risk_factors": [
      {
        "name": "exchange",
        "label": "Exchange",
        "group": "low",
        "score": 0.9
      },
      {
        "name": "p2p_exchange_mlrisk_high",
        "label": "P2P Exchange (High Risk)",
        "group": "medium",
        "score": 0.1
      }
    ],
    "checked_at": "2024-03-25T10:42:12+00:00"
  }
}

Для проверки по хешу поля hash и direction следуют за checked_at:

{
  "code": 0,
  "request_id": "bbf74bcd-fb36-4df8-adc8-25f2bacd087b",
  "result": {
    "id": "1043",
    "type": "hash",
    "address": "TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D",
    "network": "TRX",
    "status": "completed",
    "risk_score": "3.20",
    "risk_level": "low",
    "blacklist": false,
    "risk_factors": [],
    "checked_at": "2024-03-25T10:44:31+00:00",
    "hash": "E3F2A1B66DBB9F0B24C4125229163944A7D91EB3F1AC5E409FFCEE0C81A913F2",
    "direction": "deposit"
  }
}

Возможные ошибки

Код ошибки	Key	Описание
1	auth	Ошибка аутентификации (неверный токен или подпись)
2	invalid_service_or_params	Некорректные параметры (id отсутствует или пуст)
30	aml_check_not_found	AML-проверка не найдена или принадлежит другому аккаунту
500	internal_server_error	Внутренняя ошибка сервера