Pobierz historię AML

Pobiera stronicowaną listę weryfikacji AML utworzonych przez uwierzytelnionego użytkownika. Użyj filtrów, aby zawęzić wyniki według statusu.

POST /v1/aml-checks/history

Żądanie

Parametry

Pole	Typ	Wymagane	Opis
page	integer	Nie	Numer strony (domyślnie: 1, minimum: 1)
per_page	integer	Nie	Liczba elementów na stronie (domyślnie: 10, zakres: 1-50)
status	string	Nie	Filtr według statusu AML (patrz tabela)

Wartości statusu

Wartość	Opis
pending	Weryfikacja utworzona i oczekująca na przetworzenie
processing	Weryfikacja w trakcie przetwarzania
completed	Weryfikacja zakończona powodzeniem
failed	Weryfikacja zakończona błędem
expired	Weryfikacja wygasła przed otrzymaniem wyniku
skipped	Weryfikacja nie została przeprowadzona i nic nie pobrano (na przykład adres bez aktywności w łańcuchu); nie zawiera oceny ryzyka

Filtr akceptuje processing i expired, ale obecnie weryfikacje są zapisywane tylko jako pending, completed, skipped lub failed.

Bash

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

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

# Wyślij żądanie 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'
});

// Oblicz sygnaturę
const signature = crypto
  .createHash('sha256')
  .update(requestBody + apiSecret)
  .digest('hex');

// Wyślij żądanie 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'
]);

// Oblicz sygnaturę
$signature = hash('sha256', $requestBody . $apiSecret);

// Wyślij żądanie 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'
})

# Oblicz sygnaturę
signature = hashlib.sha256((request_body + api_secret).encode()).hexdigest()

# Wyślij żądanie 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())

Odpowiedź

Odpowiedź zawiera dane stronicowania oraz listę weryfikacji AML w tym samym formacie co w pozostałych endpointach.

Pola odpowiedzi

Pole	Typ	Opis
code	integer	Kod odpowiedzi (0 = sukces)
request_id	string	Unikalny identyfikator żądania
result	object	Dane wynikowe ze stronicowaniem
result.page	integer	Bieżący numer strony
result.per_page	integer	Liczba elementów zwróconych na stronie
result.total	integer	Łączna liczba weryfikacji dla filtra
result.items	array	Lista obiektów weryfikacji AML
result.items[].id	string	Identyfikator weryfikacji AML
result.items[].type	string	Typ usługi AML (address lub hash)
result.items[].address	string	Weryfikowany adres
result.items[].network	string	Kod sieci blockchain zapisany tak jak na liście obsługiwanych sieci (np. TRX, TetherOMNI)
result.items[].status	string	Aktualny status (pending, processing, completed, failed, expired, skipped)
result.items[].risk_score	string|null	Ocena ryzyka jako ciąg z dwoma miejscami po przecinku (np. "12.50") lub null, gdy ocena nie jest jeszcze dostępna
result.items[].risk_level	string|null	Poziom ryzyka (low, medium, high)
result.items[].blacklist	boolean	Informacja o wpisie na liście blokad
result.items[].risk_factors	array	Kategorie ryzyka, z którymi powiązane są środki, posortowane malejąco według score, jeden wpis na kategorię; pusta [], gdy nie zgłoszono żadnej kategorii (np. dopóki weryfikacja nie została zakończona)
result.items[].risk_factors[].name	string	Klucz kategorii, jeden z wymienionych w sekcji Kategorie czynników ryzyka; kategoria spoza tej listy jest zgłaszana jako other
result.items[].risk_factors[].label	string	Angielska nazwa kategorii (nietłumaczona)
result.items[].risk_factors[].group	string	Grupa ryzyka kategorii: low, medium lub high
result.items[].risk_factors[].score	number	Udział środków powiązanych z tą kategorią, od 0 do 1, zaokrąglony do 3 miejsc po przecinku
result.items[].checked_at	string	Znacznik czasu utworzenia weryfikacji (ISO 8601)
result.items[].hash	string	Weryfikowany hash transakcji (tylko dla weryfikacji hash)
result.items[].direction	string	Weryfikowana strona transakcji, deposit lub withdrawal (tylko dla weryfikacji hash)

Pełna lista kluczy kategorii wraz z nazwami i grupami znajduje się w sekcji Kategorie czynników ryzyka.

Przykładowa odpowiedź

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

Możliwe błędy

Kod błędu	Key	Opis
1	auth	Błąd uwierzytelniania (nieprawidłowy token lub sygnatura)
2	invalid_service_or_params	Nieprawidłowe parametry paginacji lub statusu
500	internal_server_error	Wewnętrzny błąd serwera