Skip to content

AML check result

GET
/aml/{order_id}

Status and result of a previously submitted check. The main way to collect the result of an asynchronous check. Polling is not charged.

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)

Parameters

Path Parameters

order_id*

The client_order_id from the response that created the check.

Type
string
Required
Example"A4C666ABE24BD4A"

Responses

The state and, if the check is finished, the full result.

application/json
JSON
{
  
"success": true,
  
"data": {
  
  
"client_order_id": "A4C666ABE24BD4A",
  
  
"status": "string",
  
  
"address": "string",
  
  
"provider": "string",
  
  
"report_language": "string",
  
  
"price_usdt": 0,
  
  
"price_trx": 0,
  
  
"currency": "TRX",
  
  
"message": "string",
  
  
"risk_score": 0,
  
  
"risk_level": "string",
  
  
"is_sanctioned": true,
  
  
"created_at": "string",
  
  
"completed_at": "string",
  
  
"result": {
  
  
  
"additionalProperties": "string"
  
  
}
  
},
  
"timestamp": "string"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI