Skip to content

Screen an address for AML

POST
/aml

Submits an address for AML screening and returns the risk score, risk level and exposure analysis.

It works in two modes. With wait: true the response waits for the result for up to 15 seconds. Without it the response returns immediately with status pending and a client_order_id, and the result is fetched through GET /aml/{order_id}. A typical check takes 2–10 seconds, and polling is not charged extra.

The Elliptic score runs from 0 to 10, where 0 means no risk. A null value means no triggers were detected.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Request Body

application/json
JSON
{
  
"address": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE",
  
"network": "trx",
  
"provider": "elliptic"
}

Responses

The check was accepted (pending) or completed (completed) — read data.status. application/json: schema: { $ref: '#/components/schemas/AmlCheckResponse' } examples: pending: summary: 'Accepted, fetch the result by polling' value: success: true data: client_order_id: A4C666ABE24BD4A status: pending address: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE provider: elliptic price_usdt: 0.98 price_trx: 4.136286 currency: TRX message: AML check order accepted. Use GET /apiv2/aml/A4C666ABE24BD4A to check status. timestamp: '2026-03-10 09:56:31' completed: summary: 'Completed' value: success: true data: client_order_id: A019540900E55CA status: completed address: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE provider: elliptic report_language: en risk_score: 0.802904 risk_level: low is_sanctioned: true created_at: '2026-03-10 15:56:28' completed_at: '2026-03-10 15:56:28' timestamp: '2026-03-10 15:56:31'

application/json
JSON
{
  
"success": true,
  
"data": {
  
  
"client_order_id": "A4C666ABE24BD4A",
  
  
"status": "pending",
  
  
"address": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE",
  
  
"provider": "elliptic",
  
  
"price_usdt": 0.98,
  
  
"price_trx": 4.136286,
  
  
"currency": "TRX",
  
  
"message": "AML check order accepted. Use GET /apiv2/aml/A4C666ABE24BD4A to check status."
  
},
  
"timestamp": "2026-03-10 09:56:31"
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI