Obtenir l’historique AML

Récupérez une liste paginée des contrôles AML créés par l’utilisateur authentifié. Utilisez les filtres pour limiter par statut.

POST /v1/aml-checks/history

Requête

Paramètres

Champ	Type	Obligatoire	Description
page	integer	Non	Numéro de page (par défaut : 1, minimum : 1)
per_page	integer	Non	Éléments par page (par défaut : 10, plage : 1-50)
status	string	Non	Filtrer par statut AML (voir tableau)

Valeurs de statut

Valeur	Description
pending	Contrôle créé et en attente de traitement
processing	Contrôle en cours de traitement
completed	Contrôle terminé avec succès
failed	Contrôle échoué en raison d’erreurs
expired	Contrôle expiré avant l’obtention d’un résultat
skipped	Contrôle non exécuté et non facturé (par exemple, une adresse sans activité on-chain) ; il ne comporte aucun verdict de risque

Le filtre accepte processing et expired, mais les contrôles ne sont actuellement enregistrés qu’avec les statuts pending, completed, skipped ou failed.

Bash

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

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

# Envoyer la requête 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'
});

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

// Envoyer la requête 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'
]);

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

// Envoyer la requête 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'
})

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

# Envoyer la requête 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())

Réponse

La réponse fournit les métadonnées de pagination ainsi qu’un tableau de contrôles AML au même format que les autres endpoints.

Champs de la réponse

Champ	Type	Description
code	integer	Code de réponse (0 = succès)
request_id	string	Identifiant unique de la requête
result	object	Résultat paginé
result.page	integer	Numéro de page
result.per_page	integer	Nombre d’éléments retournés
result.total	integer	Nombre total de contrôles correspondant au filtre
result.items	array	Liste des contrôles AML
result.items[].id	string	Identifiant du contrôle AML
result.items[].type	string	Type de service AML (address ou hash)
result.items[].address	string	Adresse analysée
result.items[].network	string	Code du réseau blockchain, tel qu’écrit dans la liste des réseaux pris en charge (par ex. TRX, TetherOMNI)
result.items[].status	string	Statut actuel (pending, processing, completed, failed, expired, skipped)
result.items[].risk_score	string|null	Score de risque sous forme de chaîne à deux décimales (par ex. "12.50"), ou null tant qu’aucun score n’est disponible
result.items[].risk_level	string|null	Niveau de risque textuel (low, medium, high)
result.items[].blacklist	boolean	Indique si une correspondance sur liste noire est détectée
result.items[].risk_factors	array	Catégories de risque auxquelles les fonds sont liés, triées par score décroissant, une entrée par catégorie ; [] vide si aucune catégorie n’a été signalée (par exemple tant que le contrôle n’est pas terminé)
result.items[].risk_factors[].name	string	Clé de la catégorie, l’une de celles listées dans Catégories de facteurs de risque ; une catégorie hors de cette liste est signalée comme other
result.items[].risk_factors[].label	string	Libellé anglais de la catégorie (non traduit)
result.items[].risk_factors[].group	string	Groupe de risque de la catégorie : low, medium ou high
result.items[].risk_factors[].score	number	Part des fonds liée à cette catégorie, de 0 à 1, arrondie à 3 décimales
result.items[].checked_at	string	Horodatage de création du contrôle (ISO 8601)
result.items[].hash	string	Hash analysé (uniquement pour hash)
result.items[].direction	string	Côté de la transaction analysé, deposit ou withdrawal (uniquement pour hash)

La liste complète des clés de catégorie, avec leurs libellés et leurs groupes, figure dans Catégories de facteurs de risque.

Exemple de réponse

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

Erreurs possibles

Code d’erreur	Key	Description
1	auth	Erreur d’authentification (token ou signature incorrects)
2	invalid_service_or_params	Paramètres de pagination ou de statut invalides
500	internal_server_error	Erreur interne du serveur