Check AML Status

Fetch the latest status and risk assessment for an existing AML check. Data is refreshed when new information becomes available.

POST /v1/aml-checks/check

Request

Request Parameters

Field	Type	Required	Description
id	string	Yes	AML check identifier

Bash

#!/bin/bash
API_TOKEN="your_api_token"
API_SECRET="your_api_secret"
REQUEST_BODY='{
  "id": "01jq7h6bvf6p5t1amnz6y3n8c4"
}'

# 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/check" \
  -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({
  id: '01jq7h6bvf6p5t1amnz6y3n8c4'
});

// 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/check',
  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([
  'id' => '01jq7h6bvf6p5t1amnz6y3n8c4'
]);

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

// Make API request
$ch = curl_init('https://api.tronzap.com/v1/aml-checks/check');
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({
  'id': '01jq7h6bvf6p5t1amnz6y3n8c4'
})

# 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/check',
  headers=headers,
  data=request_body
)

print(response.json())

Response

Returns the AML check details with the most recent risk data. If the check is still in progress, the status remains pending or processing.

Response Fields

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

Example Response

{
  "code": 0,
  "result": {
    "id": "01jq7h6bvf6p5t1amnz6y3n8c4",
    "type": "hash",
    "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
    "hash": "E3F2A1B66DBB9F0B24C4125229163944A7D91EB3F1AC5E409FFCEE0C81A913F2",
    "direction": "withdrawal",
    "network": "BTC",
    "status": "processing",
    "risk_score": null,
    "risk_level": null,
    "blacklist": false,
    "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-25T10:42:12Z"
  }
}

Possible Errors

Error Code	Description
1	Authentication error (incorrect token or signature)
2	Invalid request parameters
30	AML check not found
500	Internal server error