Создать проверку AML

Создает новую AML-проверку для адреса кошелька или конкретного хеша транзакции. Стоимость проверки резервируется на вашем балансе в момент её запуска, а ответ содержит саму проверку.

POST /v1/aml-checks/new

Запрос

Параметры

Поле	Тип	Обязательное	Описание
type	string	Да	Тип AML-сервиса: address или hash
network	string	Да	Код сети блокчейн (см. таблицу)
address	string	Да	Валидный адрес выбранной сети. Для type = hash — адрес-участник транзакции, сторона которого проверяется (см. direction).
hash	string	Условное*	Хеш транзакции в формате выбранной сети (TRX: 64 шестнадцатеричных символа, без префикса 0x; Ethereum и другие EVM-сети: 0x и 64 шестнадцатеричных символа; формат каждой сети — в примере из таблицы ниже). Обязателен, если type = hash
direction	string	Условное**	Какая сторона транзакции проверяется для address: deposit — средства поступают на этот адрес, withdrawal — средства уходят с него. Обязательно, если type = hash

* Только для проверок по хешу.
** Только для проверок по хешу. Значения по умолчанию нет: проверка по хешу без корректного direction отклоняется.

Типы сервисов

Тип	Описание
address	Проверка адреса кошелька и расчет его риск-профиля
hash	Проверка отдельной транзакции со стороны одного из её адресов (deposit или withdrawal)

Поддерживаемые сети

Код	Сеть	Пример адреса	Пример хеша
TRX	TRON	TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t	fd4f300e12040089f624353cdfe7c2ae7ed2378fa65c7e5cce60f69cb1d43bab
BTC	Bitcoin	bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq	4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b
ETH	Ethereum	0x742d35Cc6634C0532925a3b844Bc454e4438f44e	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
BSC	BNB Chain	0x742d35Cc6634C0532925a3b844Bc454e4438f44e	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
SOL	Solana	TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA	5VERv8NMvzbJMEkV8xnrLkEaWRtSz9CosKDYjCJjBRnbJLgp8uirBgmQpjKhoR4tjF3ZpRzrFmBV6UjKdiSZkQUW
TON	TON	EQCD39VS5jcptHL8vMjEXrzGaRcCVYto7HUn4bpAOg8xqB2N	fd4f300e12040089f624353cdfe7c2ae7ed2378fa65c7e5cce60f69cb1d43bab
MATIC	Polygon	0x742d35Cc6634C0532925a3b844Bc454e4438f44e	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
ARB	Arbitrum	0x742d35Cc6634C0532925a3b844Bc454e4438f44e	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
BASE	Base	0x742d35Cc6634C0532925a3b844Bc454e4438f44e	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
OP	Optimism	0x742d35Cc6634C0532925a3b844Bc454e4438f44e	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
AVAX	Avalanche C-Chain	0x742d35Cc6634C0532925a3b844Bc454e4438f44e	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
LTC	Litecoin	LQTpS3VaYTjCr4s9Y1t5zbeY26zevf7Fb3	4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b
XRP	Ripple	rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh	E3FE6EA3D48F0C2B639448020EA4F03D4F4F8FFDB243A852A0F59177921B4879
ALGO	Algorand	VCMJKWOY5P5P7SKMZFFOCEROPJCZOTIJMNIYNUCKH7LRO45JMJP6UYBIJA	UITN53MFMO6QHK6GCAUMF5MXBJG4OB6S3VCHTGFY5PQGHNWJ5NWQ
APT	Aptos	0x0000000000000000000000000000000000000000000000000000000000000001	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
BCH	Bitcoin Cash	bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a	4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b
BSV	Bitcoin SV	1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa	4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b
ADA	Cardano	addr1qx2fxv2umyhttkxyxp8x0dlpdt3k6cwng5pxj3jhsydzer3n0d3vllmyqwsx5wktcd8cc3sq835lu7drv2xwl2wywfgse35a3x	8a5a6f0e9c5d7c4e1b62ef2b36d03b34f2b0b6f9f6c7e7a3d55b0f5c8a3b2c1d
CELO	Celo	0x742d35Cc6634C0532925a3b844Bc454e4438f44e	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
DOGE	Dogecoin	DH5yaieqoZN36fDVciNyRueRGvGLR3mr7L	4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b
ETC	Ethereum Classic	0x742d35Cc6634C0532925a3b844Bc454e4438f44e	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
NEAR	NEAR	alice.near	6zgh2u9DqHHiXzdy9ouTP7oGky2T4nugqzqt9wJZwNFm
DOT	Polkadot	15oF4uVJwmo4TdGW7VfQxNLavjCXviqxT9S1MgbjMNHr6Sp5	0x0f61ba2c923f4113a91eec9a9ce6145866e18b91dab5d2899dbe586a1847652b
XLM	Stellar	GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7	3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889
TetherOMNI	Tether (Omni)	1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa	4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b
XTZ	Tezos	tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb	onvsLP3JFZia2mzZKWaFuFkWg2L5p3BDUhzh5Kr6CiDDN3rtQ1D
ZEC	Zcash	t1Rv4exT7bqhZqi2j7xz8bUHDMxwosrjADU	4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b

TIP

Проверяются все сети из этого списка, по одной цене за проверку в любой сети. Регистр network не важен (btc — это BTC); address и hash проверяются по формату выбранной сети. Запрос на тип проверки, который недоступен для вашего проекта (см. Получить AML-сервисы), или на сеть, которую сервис проверки сейчас не может принять, получает код 35, и ничего не списывается.

Bash

#!/bin/bash
API_TOKEN="your_api_token"
API_SECRET="your_api_secret"
REQUEST_BODY='{
  "type": "address",
  "network": "TRX",
  "address": "TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D"
}'

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

# Запрос
curl -X POST "https://api.trxup.com/v1/aml-checks/new" \
  -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({
  type: 'address',
  network: 'TRX',
  address: 'TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D'
});

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

// Запрос
axios({
  method: 'post',
  url: 'https://api.trxup.com/v1/aml-checks/new',
  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([
  'type' => 'address',
  'network' => 'TRX',
  'address' => 'TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D',
], JSON_UNESCAPED_SLASHES);

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

// Запрос
$ch = curl_init('https://api.trxup.com/v1/aml-checks/new');
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({
  'type': 'address',
  'network': 'TRX',
  'address': 'TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D'
})

# Подпись
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/new',
  headers=headers,
  data=request_body
)

print(response.json())

Пример запроса для хеша

Bash

#!/bin/bash
API_TOKEN="your_api_token"
API_SECRET="your_api_secret"
REQUEST_BODY='{
  "type": "hash",
  "network": "TRX",
  "address": "TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D",
  "hash": "E3F2A1B66DBB9F0B24C4125229163944A7D91EB3F1AC5E409FFCEE0C81A913F2",
  "direction": "withdrawal"
}'

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

# Запрос
curl -X POST "https://api.trxup.com/v1/aml-checks/new" \
  -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({
  type: 'hash',
  network: 'TRX',
  address: 'TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D',
  hash: 'E3F2A1B66DBB9F0B24C4125229163944A7D91EB3F1AC5E409FFCEE0C81A913F2',
  direction: 'withdrawal'
});

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

// Запрос
axios({
  method: 'post',
  url: 'https://api.trxup.com/v1/aml-checks/new',
  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([
  'type' => 'hash',
  'network' => 'TRX',
  'address' => 'TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D',
  'hash' => 'E3F2A1B66DBB9F0B24C4125229163944A7D91EB3F1AC5E409FFCEE0C81A913F2',
  'direction' => 'withdrawal'
], JSON_UNESCAPED_SLASHES);

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

// Запрос
$ch = curl_init('https://api.trxup.com/v1/aml-checks/new');
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({
  'type': 'hash',
  'network': 'TRX',
  'address': 'TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D',
  'hash': 'E3F2A1B66DBB9F0B24C4125229163944A7D91EB3F1AC5E409FFCEE0C81A913F2',
  'direction': 'withdrawal'
})

# Подпись
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/new',
  headers=headers,
  data=request_body
)

print(response.json())

Ответ

Ответ содержит AML-проверку. Если результат ещё формируется, статус — pending: запрашивайте Проверить статус AML с полученным id, пока статус не изменится.

Поля ответа

Поле	Тип	Описание
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	true, если обнаружено совпадение с черными списками
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)

Полный список ключей категорий с названиями и группами — в разделе Категории факторов риска.

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

{
  "code": 0,
  "request_id": "bbf74bcd-fb36-4df8-adc8-25f2bacd087b",
  "result": {
    "id": "1041",
    "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:40:05+00:00"
  }
}

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

{
  "code": 0,
  "request_id": "bbf74bcd-fb36-4df8-adc8-25f2bacd087b",
  "result": {
    "id": "1042",
    "type": "hash",
    "address": "TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D",
    "network": "TRX",
    "status": "pending",
    "risk_score": null,
    "risk_level": null,
    "blacklist": false,
    "risk_factors": [],
    "checked_at": "2024-03-25T10:42:12+00:00",
    "hash": "E3F2A1B66DBB9F0B24C4125229163944A7D91EB3F1AC5E409FFCEE0C81A913F2",
    "direction": "withdrawal"
  }
}

Списание средств и повторные запросы

• Стоимость проверки резервируется в момент её запуска. Если проверку не удаётся выполнить — входные данные отклонены или ошибка на нашей стороне, — резерв возвращается полностью.
• Для проверки по хешу: если address не участвует в транзакции, проверка отклоняется с кодом 2 (The address was not found in this transaction) и ничего не списывается.
• Для проверки адреса: если сервис проверки отказался проверять адрес, проверка отклоняется с кодом 2 (The screening service could not check this address; nothing was charged, ключ invalid_service_or_params, без detail) и ничего не списывается. Проверьте адрес и повторите попытку позже.
• Повтор того же запроса в течение часа — те же type, network и address, а для проверок по хешу также те же hash и direction — возвращает прежнюю проверку без списания.
• Второй идентичный запрос, отправленный, пока первый ещё выполняется, отклоняется с HTTP 503 (temporarily_unavailable), и ничего не списывается. Повторите попытку чуть позже.

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

Код ошибки	Key	Описание
1	auth	Ошибка аутентификации (неверный токен или подпись)
2	invalid_service_or_params	Некорректные параметры; проверяются по порядку: type; network (Unsupported network); address (Invalid address provided); для проверок по хешу — hash (Hash is required for hash checks) и direction (Invalid direction value); для проверки по хешу, если address не участвует в транзакции, — The address was not found in this transaction (ключ invalid_service_or_params.hash), ничего не списывается; для проверки адреса, от которой отказался сервис проверки, — The screening service could not check this address; nothing was charged (ключ invalid_service_or_params), ничего не списывается
5	wallet_not_found	Кошелек не найден
6	insufficient_funds	Недостаточно средств для проверки
35	service_unavailable	Этот тип проверки или сеть недоступны для проекта (например, тип проверки, который не продаётся вашему проекту); ничего не списывается
500	internal_server_error	Внутренняя ошибка сервера
503	temporarily_unavailable	Идентичная проверка ещё выполняется (HTTP 503); ничего не списано, повторите попытку чуть позже