Consultar estado AML

Recupera el estado más reciente y la evaluación de riesgo de una verificación AML existente. Los datos se actualizan cuando hay nueva información disponible.

POST /v1/aml-checks/check

Solicitud

Parámetros

Campo	Tipo	Requerido	Descripción
id	string	Sí	Identificador de la verificación AML

Bash

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

# Calcular firma
SIGNATURE=$(echo -n "${REQUEST_BODY}${API_SECRET}" | sha256sum | cut -d' ' -f1)

# Realizar solicitud a la API
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'
});

// Calcular firma
const signature = crypto
  .createHash('sha256')
  .update(requestBody + apiSecret)
  .digest('hex');

// Realizar solicitud a la API
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'
]);

// Calcular firma
$signature = hash('sha256', $requestBody . $apiSecret);

// Realizar solicitud a la API
$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'
})

# Calcular firma
signature = hashlib.sha256((request_body + api_secret).encode()).hexdigest()

# Realizar solicitud a la API
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())

Respuesta

Devuelve los datos de la verificación AML con la información de riesgo más reciente. Si la verificación sigue en pending, el servidor vuelve a solicitar el resultado antes de responder, por lo que cada llamada devuelve el estado más reciente; siga consultando hasta que el estado cambie.

Campos de la respuesta

Campo	Tipo	Descripción
code	integer	Código de respuesta (0 = éxito)
request_id	string	Identificador único de la solicitud
result	object	Datos de la verificación AML
result.id	string	Identificador de la verificación AML
result.type	string	Tipo de servicio AML (address o hash)
result.address	string	Dirección analizada
result.network	string	Código de red blockchain tal como figura en la lista de redes compatibles (p. ej. TRX, TetherOMNI)
result.status	string	Estado actual (pending, processing, completed, failed, expired, skipped)
result.risk_score	string|null	Puntaje de riesgo como cadena con dos decimales (p. ej. "12.50"), o null si aún no hay puntaje
result.risk_level	string|null	Nivel de riesgo textual (low, medium, high)
result.blacklist	boolean	Indica si hay coincidencia con listas negras
result.risk_factors	array	Categorías de riesgo con las que están vinculados los fondos, ordenadas de mayor a menor score, una entrada por categoría; [] vacío si no se informó ninguna categoría (por ejemplo, mientras la verificación no se ha completado)
result.risk_factors[].name	string	Clave de la categoría, una de las indicadas en Categorías de factores de riesgo; una categoría fuera de esa lista se informa como other
result.risk_factors[].label	string	Nombre de la categoría en inglés (no se traduce)
result.risk_factors[].group	string	Grupo de riesgo de la categoría: low, medium o high
result.risk_factors[].score	number	Proporción de los fondos vinculada a esta categoría, de 0 a 1, redondeada a 3 decimales
result.checked_at	string	Marca temporal de creación de la verificación (ISO 8601)
result.hash	string	Hash de transacción analizado (solo verificaciones de hash)
result.direction	string	Lado de la transacción analizado, deposit o withdrawal (solo verificaciones de hash)

Categorías de factores de riesgo

risk_factors[].name siempre es una de estas claves. Una categoría fuera de esta lista se informa como other. label siempre está en inglés: forma parte de la respuesta, no es una traducción.

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

Ejemplo de respuesta

{
  "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"
  }
}

Para una verificación de hash, hash y direction siguen a 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"
  }
}

Posibles errores

Código de error	Key	Descripción
1	auth	Error de autenticación (token o firma incorrectos)
2	invalid_service_or_params	Parámetros inválidos (id falta o está vacío)
30	aml_check_not_found	Verificación AML no encontrada, o pertenece a otra cuenta
500	internal_server_error	Error interno del servidor