Obtener historial AML

Recupere una lista paginada de las verificaciones AML creadas por el usuario autenticado. Use filtros para limitar por estado.

POST /v1/aml-checks/history

Solicitud

Parámetros

Campo	Tipo	Requerido	Descripción
page	integer	No	Número de página (predeterminado: 1, mínimo: 1)
per_page	integer	No	Elementos por página (predeterminado: 10, rango: 1-50)
status	string	No	Filtrar por estado AML (ver tabla)

Valores de estado

Valor	Descripción
pending	Verificación creada y a la espera de procesarse
processing	Verificación en curso
completed	Verificación finalizada con éxito
failed	Verificación fallida por errores
expired	Verificación caducada antes de recibir un resultado
skipped	Verificación no ejecutada y sin cargo (por ejemplo, una dirección sin actividad en la cadena); no contiene un veredicto de riesgo

El filtro acepta processing y expired, pero actualmente las verificaciones solo se registran como pending, completed, skipped o failed.

Bash

#!/bin/bash
API_TOKEN="your_api_token"
API_SECRET="your_api_secret"
REQUEST_BODY='{
  "page": 1,
  "per_page": 10,
  "status": "completed"
}'

# 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/history" \
  -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({
  page: 1,
  per_page: 10,
  status: 'completed'
});

// 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/history',
  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([
  'page' => 1,
  'per_page' => 10,
  'status' => 'completed'
]);

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

// Realizar solicitud a la API
$ch = curl_init('https://api.trxup.com/v1/aml-checks/history');
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({
  'page': 1,
  'per_page': 10,
  'status': 'completed'
})

# 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/history',
  headers=headers,
  data=request_body
)

print(response.json())

Respuesta

La respuesta incluye los datos de paginación junto con las verificaciones AML en el mismo formato que los endpoints individuales.

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	Resultado paginado
result.page	integer	Número de página
result.per_page	integer	Número de elementos devueltos
result.total	integer	Total de verificaciones para el filtro
result.items	array	Conjunto de objetos de verificación AML
result.items[].id	string	Identificador de la verificación AML
result.items[].type	string	Tipo de servicio AML (address o hash)
result.items[].address	string	Dirección analizada
result.items[].network	string	Código de red blockchain tal como figura en la lista de redes compatibles (p. ej. TRX, TetherOMNI)
result.items[].status	string	Estado actual (pending, processing, completed, failed, expired, skipped)
result.items[].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.items[].risk_level	string|null	Nivel de riesgo textual (low, medium, high)
result.items[].blacklist	boolean	Indica si hay coincidencia con listas negras
result.items[].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.items[].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.items[].risk_factors[].label	string	Nombre de la categoría en inglés (no se traduce)
result.items[].risk_factors[].group	string	Grupo de riesgo de la categoría: low, medium o high
result.items[].risk_factors[].score	number	Proporción de los fondos vinculada a esta categoría, de 0 a 1, redondeada a 3 decimales
result.items[].checked_at	string	Marca temporal de creación de la verificación (ISO 8601)
result.items[].hash	string	Hash de transacción analizado (solo verificaciones de hash)
result.items[].direction	string	Lado de la transacción analizado, deposit o withdrawal (solo verificaciones de hash)

La lista completa de claves de categoría, con sus nombres y grupos, está en Categorías de factores de riesgo.

Ejemplo de respuesta

{
  "code": 0,
  "request_id": "bbf74bcd-fb36-4df8-adc8-25f2bacd087b",
  "result": {
    "page": 1,
    "per_page": 2,
    "total": 5,
    "items": [
      {
        "id": "1042",
        "type": "hash",
        "address": "TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D",
        "network": "TRX",
        "status": "completed",
        "risk_score": "64.30",
        "risk_level": "high",
        "blacklist": true,
        "risk_factors": [],
        "checked_at": "2024-03-25T11:14:48+00:00",
        "hash": "E3F2A1B66DBB9F0B24C4125229163944A7D91EB3F1AC5E409FFCEE0C81A913F2",
        "direction": "withdrawal"
      },
      {
        "id": "1041",
        "type": "address",
        "address": "TPY1Kb8cKAZQfm95gXQQs2Mh8Uygtos21D",
        "network": "TRX",
        "status": "pending",
        "risk_score": null,
        "risk_level": null,
        "blacklist": false,
        "risk_factors": [],
        "checked_at": "2024-03-25T11:12:03+00:00"
      }
    ]
  }
}

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 de paginación o estado inválidos
500	internal_server_error	Error interno del servidor