Get AML History

Retrieve a paginated list of AML checks created by the authenticated user. Use filters to narrow down by status.

POST /v1/aml-checks/history

Request

Request Parameters

Field	Type	Required	Description
page	integer	No	Page number to load (default: 1, minimum: 1)
per_page	integer	No	Items per page (default: 10, range: 1-50)
status	string	No	Filter by AML check status (see table below)

Status Filter Values

Value	Description
pending	Check created and waiting to be processed
processing	Check is in progress
completed	Check finished successfully
failed	Check failed due to provider or validation errors

Bash

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

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

# Make API request
curl -X POST "https://api.tronzap.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'
});

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

// Make API request
axios({
  method: 'post',
  url: 'https://api.tronzap.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'
]);

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

// Make API request
$ch = curl_init('https://api.tronzap.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'
})

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

# Make API request
headers = {
  'Authorization': f'Bearer {api_token}',
  'X-Signature': signature,
  'Content-Type': 'application/json'
}

response = requests.post(
  'https://api.tronzap.com/v1/aml-checks/history',
  headers=headers,
  data=request_body
)

print(response.json())

Response

The response provides pagination metadata together with an array of AML checks formatted identically to the single-check endpoints.

Response Fields

Field	Type	Description
code	integer	Response code (0 = success)
result	object	Paginated result
result.page	integer	Current page number
result.per_page	integer	Number of items returned per page
result.total	integer	Total count of AML checks for the filter
result.items	array	Array of AML check objects
result.items[].id	string	AML check identifier
result.items[].type	string	AML service type (address or hash)
result.items[].address	string	Screened address
result.items[].hash	string	Screened transaction hash (hash checks only)
result.items[].direction	string	Transaction direction when applicable
result.items[].network	string	Blockchain network code
result.items[].status	string	Current status (pending, processing, completed, failed)
result.items[].risk_score	float	Risk score
result.items[].risk_level	string	Textual risk level (low, medium, high)
result.items[].blacklist	boolean	Indicates if a blacklist match was detected
result.items[].risk_factors	array	Array of risk factors
result.items[].checked_at	string	Timestamp when the check was created (ISO 8601)

Example Response

{
  "code": 0,
  "result": {
    "page": 1,
    "per_page": 2,
    "total": 5,
    "items": [
      {
        "id": "01jq7h6bvf6p5t1amnz6y3n8c4",
        "type": "hash",
        "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
        "hash": "E3F2A1B66DBB9F0B24C4125229163944A7D91EB3F1AC5E409FFCEE0C81A913F2",
        "direction": "withdrawal",
        "network": "BTC",
        "status": "completed",
        "risk_score": 64.3,
        "risk_level": "high",
        "blacklist": true,
        "risk_factors": [
          {
            "name": "p2p_exchange_mlrisk_high",
            "label": "P2P Exchange (High Risk)",
            "group": "medium",
            "score": 0.796
          },
          {
            "name": "exchange",
            "label": "Exchange",
            "group": "low",
            "score": 0.203
          }
        ],
        "checked_at": "2024-03-25T11:14:48Z"
      },
      {
        "id": "01jq7g0r7w1r6b2fayq5e4n9d7",
        "type": "address",
        "address": "0x6Dc1f03B1d2c27D6c741832F4AA83322D41De7Ea",
        "network": "ETH",
        "status": "pending",
        "risk_score": null,
        "risk_level": null,
        "blacklist": false,
        "risk_factors": [],
        "checked_at": "2024-03-25T11:12:03Z"
      }
    ]
  }
}

Possible Errors

Error Code	Description
1	Authentication error (incorrect token or signature)
2	Invalid pagination or status parameters
500	Internal server error