Obter histórico AML

Recupere uma lista paginada das verificações AML criadas pelo usuário autenticado. Utilize filtros para refinar por status.

POST /v1/aml-checks/history

Requisição

Parâmetros

Campo	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página (padrão: 1, mínimo: 1)
per_page	integer	Não	Itens por página (padrão: 10, intervalo: 1-50)
status	string	Não	Filtrar por status da verificação AML (veja tabela)

Valores de status

Valor	Descrição
pending	Verificação criada aguardando processamento
processing	Verificação em andamento
completed	Verificação concluída com sucesso
failed	Verificação falhou devido a erros
expired	Verificação expirou antes de receber um resultado
skipped	Verificação não executada e sem cobrança (por exemplo, um endereço sem atividade on-chain); não contém veredito de risco

O filtro aceita processing e expired, mas atualmente as verificações são registradas apenas como 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"
}'

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

# Chamada à 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 assinatura
const signature = crypto
  .createHash('sha256')
  .update(requestBody + apiSecret)
  .digest('hex');

// Chamada à 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 assinatura
$signature = hash('sha256', $requestBody . $apiSecret);

// Chamada à 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 assinatura
signature = hashlib.sha256((request_body + api_secret).encode()).hexdigest()

# Chamada à 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())

Resposta

Retorna os metadados de paginação juntamente com a lista de verificações AML no mesmo formato dos demais endpoints.

Campos da resposta

Campo	Tipo	Descrição
code	integer	Código de resposta (0 = sucesso)
request_id	string	Identificador único da requisição
result	object	Resultado paginado
result.page	integer	Número da página atual
result.per_page	integer	Quantidade de itens retornados por página
result.total	integer	Total de verificações para o filtro
result.items	array	Lista de verificações AML
result.items[].id	string	Identificador da verificação AML
result.items[].type	string	Tipo de serviço AML (address ou hash)
result.items[].address	string	Endereço analisado
result.items[].network	string	Código da rede blockchain como escrito na lista de redes suportadas (ex.: TRX, TetherOMNI)
result.items[].status	string	Status atual (pending, processing, completed, failed, expired, skipped)
result.items[].risk_score	string|null	Pontuação de risco como string com duas casas decimais (ex.: "12.50"), ou null quando ainda não há pontuação
result.items[].risk_level	string|null	Nível de risco textual (low, medium, high)
result.items[].blacklist	boolean	Indica se há correspondência em listas de bloqueio
result.items[].risk_factors	array	Categorias de risco às quais os fundos estão vinculados, ordenadas do maior para o menor score, uma entrada por categoria; [] vazio quando nenhuma categoria foi informada (por exemplo, enquanto a verificação não foi concluída)
result.items[].risk_factors[].name	string	Chave da categoria, uma das listadas em Categorias de fatores de risco; uma categoria fora dessa lista é informada como other
result.items[].risk_factors[].label	string	Rótulo da categoria em inglês (não traduzido)
result.items[].risk_factors[].group	string	Grupo de risco da categoria: low, medium ou high
result.items[].risk_factors[].score	number	Parcela dos fundos vinculada a esta categoria, de 0 a 1, arredondada a 3 casas decimais
result.items[].checked_at	string	Timestamp de criação da verificação (ISO 8601)
result.items[].hash	string	Hash da transação analisado (apenas verificações de hash)
result.items[].direction	string	Lado da transação analisado, deposit ou withdrawal (apenas verificações de hash)

A lista completa de chaves de categoria, com rótulos e grupos, está em Categorias de fatores de risco.

Exemplo de resposta

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

Possíveis erros

Código de erro	Key	Descrição
1	auth	Erro de autenticação (token ou assinatura incorretos)
2	invalid_service_or_params	Parâmetros de paginação ou status inválidos
500	internal_server_error	Erro interno do servidor