Ottenere lo storico AML

Recupera un elenco paginato dei controlli AML creati dall’utente autenticato. Utilizza i filtri per restringere i risultati in base allo stato.

POST /v1/aml-checks/history

Richiesta

Parametri

Campo	Tipo	Obbligatorio	Descrizione
page	integer	No	Numero di pagina (predefinito: 1, minimo: 1)
per_page	integer	No	Elementi per pagina (predefinito: 10, intervallo: 1-50)
status	string	No	Filtra per stato del controllo AML (vedi tabella)

Valori di stato

Valore	Descrizione
pending	Controllo creato e in attesa di elaborazione
processing	Controllo attualmente in elaborazione
completed	Controllo completato con successo
failed	Controllo non riuscito a causa di errori
expired	Controllo scaduto prima di ricevere un risultato
skipped	Controllo non eseguito e senza addebito (ad esempio un indirizzo senza attività on-chain); non contiene alcun verdetto di rischio

Il filtro accetta processing ed expired, ma attualmente i controlli vengono registrati solo come 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"
}'

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

# Esegui la richiesta 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'
});

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

// Esegui la richiesta 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'
]);

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

// Esegui la richiesta 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'
})

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

# Esegui la richiesta 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())

Risposta

La risposta fornisce i metadati di paginazione insieme a un elenco di controlli AML nello stesso formato degli altri endpoint.

Campi della risposta

Campo	Tipo	Descrizione
code	integer	Codice di risposta (0 = successo)
request_id	string	Identificatore univoco della richiesta
result	object	Risultato paginato
result.page	integer	Numero di pagina corrente
result.per_page	integer	Numero di elementi restituiti
result.total	integer	Conteggio totale dei controlli per il filtro
result.items	array	Elenco di controlli AML
result.items[].id	string	Identificativo del controllo AML
result.items[].type	string	Tipo di servizio AML (address oppure hash)
result.items[].address	string	Indirizzo analizzato
result.items[].network	string	Codice della rete blockchain come scritto nell’elenco delle reti supportate (ad es. TRX, TetherOMNI)
result.items[].status	string	Stato attuale (pending, processing, completed, failed, expired, skipped)
result.items[].risk_score	string|null	Punteggio di rischio come stringa con due decimali (ad es. "12.50"), oppure null finché non è disponibile un punteggio
result.items[].risk_level	string|null	Livello di rischio testuale (low, medium, high)
result.items[].blacklist	boolean	Indica se è stata rilevata una corrispondenza in blacklist
result.items[].risk_factors	array	Categorie di rischio a cui sono collegati i fondi, ordinate per score decrescente, una voce per categoria; [] vuoto se non è stata segnalata alcuna categoria (ad esempio finché il controllo non è completato)
result.items[].risk_factors[].name	string	Chiave della categoria, una di quelle elencate in Categorie dei fattori di rischio; una categoria fuori da questo elenco viene segnalata come other
result.items[].risk_factors[].label	string	Etichetta inglese della categoria (non tradotta)
result.items[].risk_factors[].group	string	Gruppo di rischio della categoria: low, medium o high
result.items[].risk_factors[].score	number	Quota dei fondi collegata a questa categoria, da 0 a 1, arrotondata a 3 decimali
result.items[].checked_at	string	Timestamp di creazione del controllo (ISO 8601)
result.items[].hash	string	Hash analizzato (solo per controlli hash)
result.items[].direction	string	Lato della transazione analizzato, deposit o withdrawal (solo per i controlli hash)

L’elenco completo delle chiavi di categoria, con etichette e gruppi, si trova in Categorie dei fattori di rischio.

Esempio di risposta

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

Possibili errori

Codice errore	Key	Descrizione
1	auth	Errore di autenticazione (token o firma non validi)
2	invalid_service_or_params	Parametri di paginazione o stato non validi
500	internal_server_error	Errore interno del server