POST /apiv2/aml

AML (اینٹی منی لانڈرنگ) اسکریننگ کے لیے پتہ جمع کروائیں۔ رسک اسکور، رسک لیول، اور تفصیلی ایکسپوژر تجزیہ واپس کرتا ہے۔

اینڈپوائنٹ URL

POST https://netts.io/apiv2/aml

درخواست کے ہیڈرز

ہیڈر	لازمی	تفصیل
Content-Type	ہاں	application/json
X-API-KEY	ہاں	Netts ڈیش بورڈ سے آپ کی API کی

درخواست کا باڈی

json

{
    "address": "YOUR_ADDRESS_HERE",
    "network": "trx",
    "provider": "elliptic",
    "wait": true
}

پیرامیٹرز

پیرامیٹر	قسم	لازمی	تفصیل
address	سٹرنگ	ہاں	جانچ کے لیے بلاک چین ایڈریس (10-100 حروف)
network	سٹرنگ	ہاں	بلاک چین نیٹ ورک شناخت کنندہ (نیچے معاونت یافتہ نیٹ ورکس دیکھیں)
provider	سٹرنگ	نہیں	AML فراہم کنندہ: `elliptic` (ڈیفالٹ)
wait	بولین	نہیں	اگر `true` ہو، تو نتیجہ کے لیے ہم وقت سازی (synchronously) کے ساتھ انتظار کریں (15 سیکنڈ تک)۔ اگر `false` ہو یا چھوڑ دیا جائے، تو فوری طور پر `pending` اسٹیٹس اور `client_order_id` کے ساتھ واپس آتا ہے — GET /apiv2/aml/{order_id} کے ذریعے نتیجہ معلوم کرنے کے لیے اسے استعمال کریں
response_format	سٹرنگ	نہیں	جوابی تفصیل کی سطح: `rate` (صرف اسکور)، `full` (ڈیفالٹ، مکمل ڈیٹا)
report_language	سٹرنگ	نہیں	رپورٹ کی زبان: `en` (ڈیفالٹ)

فراہم کنندگان

فراہم کنندہ	اسکور کی حد	تفصیل
`elliptic`	0 — 10	Elliptic رسک اسکور۔ 0 = کوئی خطرہ نہیں، 10 = زیادہ سے زیادہ خطرہ۔ `null` = کوئی ٹریگرز نہیں ملے

مثالی درخواستیں

cURL (ہم وقت ساز / synchronous)

bash

curl -X POST https://netts.io/apiv2/aml \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your_api_key" \
  -d '{
    "address": "YOUR_ADDRESS_HERE",
    "network": "trx",
    "provider": "elliptic",
    "wait": true
  }'

cURL (غیر ہم وقت ساز / asynchronous)

bash

curl -X POST https://netts.io/apiv2/aml \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your_api_key" \
  -d '{
    "address": "YOUR_ADDRESS_HERE",
    "network": "trx",
    "provider": "elliptic"
  }'

Python

python

import requests

url = "https://netts.io/apiv2/aml"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "your_api_key",
}

payload = {
    "address": "YOUR_ADDRESS_HERE",
    "network": "trx",
    "provider": "elliptic",
    "wait": True
}

response = requests.post(url, headers=headers, json=payload)
data = response.json()

if response.status_code == 200:
    result = data.get("data", {})
    print(f"Order ID: {result.get('client_order_id')}")
    print(f"Status: {result.get('status')}")
    print(f"Risk Score: {result.get('risk_score')}")
    print(f"Risk Level: {result.get('risk_level')}")
    print(f"Sanctioned: {result.get('is_sanctioned')}")
else:
    print(f"Error: {data}")

جواب

کامیابی — زیر التواء (200 OK)

جب wait سیٹ نہ ہو یا جانچ کا عمل ابھی جاری ہو:

json

{
    "success": true,
    "data": {
        "client_order_id": "A4C666ABE24BD4A",
        "status": "pending",
        "address": "T...example...",
        "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"
}

کامیابی — Elliptic مکمل ہو گیا (200 OK)

تمام ڈیٹا سٹرکچرز کے ساتھ مکمل Elliptic جواب:

json

{
    "success": true,
    "data": {
        "client_order_id": "A019540900E55CA",
        "status": "completed",
        "address": "T...example...",
        "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",
        "result": {
            "risk_score": 0.802904473154148,
            "risk_score_detail": {
                "source": 0.233206,
                "destination": 0.802904
            },
            "contributions": {
                "source": [
                    {
                        "entities": [
                            {
                                "name": "Capitalist",
                                "is_vasp": true,
                                "actor_id": 53979,
                                "category": "Payment Services Provider",
                                "entity_id": "b73a9c87-...",
                                "category_id": "54f55bfe-...",
                                "is_primary_entity": true
                            }
                        ],
                        "indirect_value": { "usd": 40194.03 },
                        "contribution_value": { "usd": 40194.03 },
                        "counterparty_value": { "usd": 0 },
                        "min_number_of_hops": 2,
                        "indirect_percentage": 31.57,
                        "is_screened_address": false,
                        "contribution_percentage": 31.57,
                        "counterparty_percentage": 0
                    },
                    {
                        "entities": [
                            {
                                "name": "KuCoin",
                                "is_vasp": true,
                                "actor_id": 11620,
                                "category": "Exchange",
                                "entity_id": "e54292da-...",
                                "category_id": "0a52f7a2-...",
                                "is_primary_entity": true
                            }
                        ],
                        "indirect_value": { "usd": 28436.45 },
                        "contribution_value": { "usd": 29434.17 },
                        "counterparty_value": { "usd": 997.72 },
                        "min_number_of_hops": 1,
                        "indirect_percentage": 22.34,
                        "is_screened_address": false,
                        "contribution_percentage": 23.12,
                        "counterparty_percentage": 0.78
                    }
                ],
                "destination": [
                    {
                        "entities": [
                            {
                                "name": "Bybit",
                                "is_vasp": true,
                                "actor_id": 23354,
                                "category": "Exchange",
                                "entity_id": "bddde8b7-...",
                                "category_id": "0a52f7a2-...",
                                "is_primary_entity": true
                            }
                        ],
                        "indirect_value": { "usd": 26333.43 },
                        "contribution_value": { "usd": 27458.30 },
                        "counterparty_value": { "usd": 1124.86 },
                        "min_number_of_hops": 1,
                        "indirect_percentage": 20.69,
                        "is_screened_address": false,
                        "contribution_percentage": 21.57,
                        "counterparty_percentage": 0.88
                    }
                ]
            },
            "cluster_entities": [
                {
                    "name": "Unknown",
                    "is_vasp": null,
                    "actor_id": -4,
                    "category": "Unknown",
                    "entity_id": "00000000-...",
                    "category_id": "00000000-...",
                    "is_primary_entity": true,
                    "is_after_sanction_date": false
                }
            ],
            "evaluation_detail": {
                "source": [
                    {
                        "rule_id": "6c2dcb03-...",
                        "rule_name": "Obfuscating & Misc.",
                        "rule_type": "exposure",
                        "risk_score": 0.2332,
                        "matched_elements": [
                            {
                                "category": "Coin Swap Service",
                                "category_id": "ff85b715-...",
                                "contributions": [
                                    {
                                        "entity": "FixedFloat",
                                        "risk_triggers": {
                                            "category": "Coin Swap Service",
                                            "category_id": "ff85b715-..."
                                        },
                                        "indirect_value": { "usd": 2891.09, "native": 0, "native_major": 0 },
                                        "contribution_value": { "usd": 2968.66, "native": 0, "native_major": 0 },
                                        "counterparty_value": { "usd": 77.58, "native": 0, "native_major": 0 },
                                        "min_number_of_hops": 1,
                                        "indirect_percentage": 2.27,
                                        "is_screened_address": false,
                                        "contribution_percentage": 2.33,
                                        "counterparty_percentage": 0.06
                                    }
                                ],
                                "indirect_value": { "usd": 2891.09, "native": 0, "native_major": 0 },
                                "contribution_value": { "usd": 2968.66, "native": 0, "native_major": 0 },
                                "counterparty_value": { "usd": 0, "native": 0, "native_major": 0 },
                                "indirect_percentage": 100,
                                "contribution_percentage": 2.33,
                                "counterparty_percentage": 0
                            }
                        ],
                        "matched_behaviors": []
                    },
                    {
                        "rule_id": "0a2b68fd-...",
                        "rule_name": "Illicit Activity",
                        "rule_type": "exposure",
                        "risk_score": 0.0026,
                        "matched_elements": [
                            {
                                "category": "Token Blacklisting",
                                "category_id": "94b50de8-...",
                                "contributions": [
                                    {
                                        "entity": "Tether USD",
                                        "risk_triggers": {
                                            "category": "Token Blacklisting",
                                            "category_id": "94b50de8-..."
                                        },
                                        "contribution_value": { "usd": 1022.45, "native": 0, "native_major": 0 },
                                        "min_number_of_hops": 3,
                                        "contribution_percentage": 0.08
                                    }
                                ]
                            }
                        ],
                        "matched_behaviors": []
                    },
                    {
                        "rule_id": "df59fab5-...",
                        "rule_name": "Sanctions",
                        "rule_type": "exposure",
                        "risk_score": 0.0024,
                        "matched_elements": [
                            {
                                "category": "Sanctioned Entity",
                                "category_id": "c1648b7a-...",
                                "contributions": [
                                    {
                                        "entity": "Garantex",
                                        "risk_triggers": {
                                            "category": "Sanctioned Entity",
                                            "category_id": "c1648b7a-..."
                                        },
                                        "contribution_value": { "usd": 863.21, "native": 0, "native_major": 0 },
                                        "min_number_of_hops": 3,
                                        "contribution_percentage": 0.07
                                    }
                                ]
                            }
                        ],
                        "matched_behaviors": []
                    }
                ],
                "destination": []
            },
            "detected_behaviors": []
        },
        "address_users": [
            {
                "sources": ["api_1h_response"],
                "user_id": 3162
            }
        ]
    },
    "timestamp": "2026-03-10 15:56:28"
}

جواب کے فیلڈز

فیلڈ	قسم	تفصیل
data.client_order_id	سٹرنگ	اسٹیٹس پولنگ کے لیے منفرد آرڈر ID
data.status	سٹرنگ	`pending`, `processing`, `completed`, `failed`, `skipped`
data.risk_score	نمبر \| null	رسک اسکور۔ Elliptic: 0-10۔ `null` = کوئی ٹریگرز نہیں
data.risk_level	سٹرنگ	`low`، `medium`، یا `high`
data.is_sanctioned	بولین	اگر پابندی عائد اداروں سے نمائش پائی جائے تو `true`
data.result	آبجیکٹ	فراہم کنندہ کا مکمل جواب (جب `response_format=full` ہو)
data.address_users	اری	Netts ڈیٹا بیس سے اس ایڈریس کے معلوم صارفین

Elliptic `result` آبجیکٹ

فیلڈ	قسم	تفصیل
risk_score	نمبر	درست رسک اسکور (0-10)
risk_score_detail	آبجیکٹ	تقسیم: `source` اور `destination` اسکورز
contributions	آبجیکٹ	فنڈ کے بہاؤ میں حصہ ڈالنے والوں کے `source` اور `destination` ارے
contributions[].entities	اری	شراکت سے وابستہ معلوم ادارے
contributions[].entities[].name	سٹرنگ	ادارے کا نام (مثلاً "Binance", "KuCoin")
contributions[].entities[].category	سٹرنگ	ادارے کی قسم (مثلاً "Exchange", "Payment Services Provider")
contributions[].entities[].is_vasp	بولین \| null	آیا ادارہ ورچوئل اثاثہ سروس فراہم کنندہ ہے
contributions[].contribution_value.usd	نمبر	شراکت کا کل USD والیوم
contributions[].contribution_percentage	نمبر	اس ادارے کی طرف سے کل فنڈز کا فیصد
contributions[].indirect_value.usd	نمبر	بالواسطہ وصول شدہ USD والیوم (ثالثوں کے ذریعے)
contributions[].indirect_percentage	نمبر	بالواسطہ موصول ہونے والے فنڈز کا فیصد
contributions[].counterparty_value.usd	نمبر	براہ راست کاؤنٹر پارٹی کے طور پر USD والیوم
contributions[].counterparty_percentage	نمبر	براہ راست کاؤنٹر پارٹی کے طور پر فیصد
contributions[].min_number_of_hops	نمبر	ادارے سے لین دین کے کم از کم ہاپس (0 = براہ راست)
contributions[].is_screened_address	بولین	اگر یہ خود اسکرین شدہ پتہ ہے تو `true`
cluster_entities	اری	ایڈریس کلسٹر سے براہ راست وابستہ معلوم ادارے
cluster_entities[].name	سٹرنگ	ادارے کا نام
cluster_entities[].category	سٹرنگ	ادارے کا زمرہ
cluster_entities[].is_vasp	بولین \| null	VASP کی حیثیت
cluster_entities[].is_after_sanction_date	بولین	اگر سرگرمی ادارے پر پابندی کے بعد ہوئی ہے تو `true`
evaluation_detail	آبجیکٹ	متحرک ہونے والے رسک رولز کے `source` اور `destination` ارے
evaluation_detail[].rule_name	سٹرنگ	اصول کا نام (مثلاً "Sanctions", "Illicit Activity", "Obfuscating & Misc.")
evaluation_detail[].rule_type	سٹرنگ	اصول کی قسم (مثلاً "exposure")
evaluation_detail[].risk_score	نمبر	اس اصول سے رسک اسکور کی شراکت
evaluation_detail[].matched_elements	اری	زمرہ جات اور ادارے جنہوں نے اصول کو متحرک کیا
evaluation_detail[].matched_elements[].category	سٹرنگ	رسک کا زمرہ (مثلاً "Sanctioned Entity", "Gambling", "Token Blacklisting")
evaluation_detail[].matched_elements[].contributions	اری	مماثل زمرے کے اندر ادارے
evaluation_detail[].matched_elements[].contributions[].entity	سٹرنگ	ادارے کا نام
evaluation_detail[].matched_elements[].contributions[].contribution_percentage	نمبر	ایکسپوژر کا فیصد
evaluation_detail[].matched_elements[].contributions[].min_number_of_hops	نمبر	ٹرانزیکشن ہاپس
evaluation_detail[].matched_behaviors	اری	پائی جانے والی رویے کی خصوصیات
detected_behaviors	اری	پتے پر پائے جانے والے مجموعی رویے کے پیٹرنز

رسک لیولز

Elliptic (0-10 پیمانہ):

حد	لیول	تفصیل
0 — 3	low	کم سے کم خطرہ۔ کوئی اہم ایکسپوژر نہیں
3 — 7	medium	معتدل خطرہ۔ کچھ پرخطر زمرے پائے گئے
7 — 10	high	زیادہ خطرہ۔ پابندی عائد، غیر قانونی، یا اعلی خطرے والے ادارے
null	-	کوئی خطرے کے ٹریگرز نہیں ملے

خرابی کے جوابات

تصدیقی خرابی (401)

json

{
    "detail": {
        "code": -1,
        "msg": "API key not provided"
    }
}

توثیقی خرابی (400)

json

{
    "success": false,
    "error": {
        "code": 4001,
        "msg": "Invalid or missing address"
    }
}

json

{
    "success": false,
    "error": {
        "code": 4002,
        "msg": "Invalid provider. Use: elliptic"
    }
}

ناکافی بیلنس (402)

json

{
    "success": false,
    "error": {
        "code": 4020,
        "message": "Insufficient balance"
    },
    "timestamp": "2026-03-10 10:00:00"
}

فراہم کنندہ دستیاب نہیں ہے (503)

json

{
    "success": false,
    "error": {
        "code": 5030,
        "message": "Provider elliptic not available"
    },
    "timestamp": "2026-03-10 10:00:00"
}

ایرر کوڈ کا حوالہ

کوڈ	تفصیل	HTTP اسٹیٹس
`-1`	تصدیق ناکام ہو گئی	401
`4001`	غلط یا غائب ایڈریس	400
`4002`	غلط فراہم کنندہ	400
`4020`	ناکافی بیلنس	402
`5030`	فراہم کنندہ دستیاب نہیں ہے	503

ریٹ لمٹس

درج ذیل ریٹ لمٹس تمام AML اینڈپوائنٹس پر لاگو ہوتی ہیں (فی IP ایڈریس):

مدت	حد	تفصیل
1 سیکنڈ	2 درخواستیں	زیادہ سے زیادہ 2 درخواستیں فی سیکنڈ
1 منٹ	30 درخواستیں	زیادہ سے زیادہ 30 درخواستیں فی منٹ

ریٹ لمٹ سے تجاوز ہو گیا (429)

json

{
    "message": "API rate limit exceeded"
}

نتائج کا کیشنگ (Caching)

اگر ایک ہی ایڈریس + فراہم کنندہ کا امتزاج پچھلے 60 سیکنڈ کے اندر چیک کیا گیا تھا، تو کیش شدہ نتیجہ بغیر کسی فیس کے واپس کیا جاتا ہے۔

معاونت یافتہ نیٹ ورکس

پیرامیٹر network لازمی ہے۔ نیچے دی گئی جدول سے ٹکر استعمال کریں۔

Elliptic — جامع اسکریننگ (Holistic Screening)

اسکریننگ ایک مخصوص نیٹ ورک پر ایک مخصوص ایڈریس کے لیے کی جاتی ہے۔ البتہ، Elliptic اس پتے سے وابستہ تمام اثاثوں کو ٹریس کرتا ہے — بشمول ٹوکنز، کراس چین ٹرانسفرز، اور دیگر نیٹ ورکس پر معلوم اداروں کے ساتھ تعاملات۔

نیٹ ورک	ٹکر	مقامی اثاثہ
Algorand	`algo`	ALGO
Aptos	`apt`	APT
Arbitrum	`arb`	ETH
Avalanche (C-Chain)	`avax`	AVAX
Base	`base`	ETH
Binance Chain	`bnb`	BNB
Binance Smart Chain	`bsc`	BNB
Bitcoin	`btc`	BTC
Bittensor	`tao`	TAO
Cardano	`ada`	ADA
Celo	`celo`	CELO
Cosmos	`atom`	ATOM
Crypto.com	`cro`	CRO
Dogecoin	`doge`	DOGE
dYdX	`dydx`	DYDX
Ethereum	`eth`	ETH
Ethereum Classic	`etc`	ETC
Fantom	`ftm`	FTM
Filecoin	`fil`	FIL
Flare	`flr`	FLR
Gnosis	`gnosis`	xDai
Hedera	`hbar`	HBAR
HyperEVM	`hype`	HYPE
Injective	`inj`	INJ
Internet Computer	`icp`	ICP
Linea	`linea`	LINEA
Litecoin	`ltc`	LTC
MobileCoin	`mob`	MOB
Near	`near`	NEAR
Optimism	`op`	ETH
Polkadot	`dot`	DOT
Polygon	`matic`	MATIC
Ripple	`xrp`	XRP
Sei	`sei`	SEI
Solana	`sol`	SOL
Starknet	`strk`	STRK
Stellar	`xlm`	XLM
Sui	`sui`	SUI
Tezos	`xtz`	XTZ
TON	`ton`	TON
Tron	`trx`	TRX
XDC	`xdc`	XDC
XLayer	`okb`	OKB
Zilliqa	`zil`	ZIL
zkSync	`zksync`	ETH

سنگل اثاثہ اسکریننگ (Single Asset Screening)

یہ نیٹ ورکس انفرادی ایڈریس/ٹرانزیکشن اسکریننگ کی معاونت کرتے ہیں:

نیٹ ورک	ٹکر	مقامی اثاثہ
Bitcoin Cash	`bch`	BCH
Horizen	`zen`	ZEN
ZCash	`zec`	ZEC

فراہم کنندہ اور نیٹ ورک کی مطابقت

جب provider: "elliptic" استعمال کیا جائے — تو Holistic اور Single Asset جدولوں کے تمام نیٹ ورکس دستیاب ہیں (47 نیٹ ورکس)۔ اگر کوئی غیر معاون نیٹ ورک پاس کیا جائے تو API ایرر کوڈ 4001 واپس کرتا ہے۔

نوٹس

قیمت کا تعین: Elliptic — $0.98 فی چیک۔ قیمتیں موجودہ ریٹ پر TRX میں دکھائی گئی ہیں
Sync ٹائم آؤٹ: wait: true 15 سیکنڈ تک انتظار کرتا ہے۔ اگر چیک میں زیادہ وقت لگے تو pending اسٹیٹس واپس کرتا ہے
پروسیسنگ کا وقت: زیادہ تر چیکس چند سیکنڈ میں مکمل ہو جاتے ہیں۔ البتہ، کچھ درخواستیں (خاص طور پر پیچیدہ ٹرانزیکشن ہسٹری والے ایڈریسز کے لیے) پروسیس ہونے میں 3 منٹ تک لے سکتی ہیں۔ ایسے معاملات کے لیے غیر ہم وقت ساز طریقہ (asynchronous mode) استعمال کریں (wait کو چھوڑ دیں یا wait: false سیٹ کریں) اور GET /apiv2/aml/{order_id} کے ذریعے پول کریں
غیر فعال پتے: بغیر کسی بلاک چین سرگرمی کے پتے بلا معاوضہ skipped اسٹیٹس واپس کرتے ہیں

POST /apiv2/aml ​

اینڈپوائنٹ URL ​

درخواست کے ہیڈرز ​

درخواست کا باڈی ​

پیرامیٹرز ​

فراہم کنندگان ​

مثالی درخواستیں ​

cURL (ہم وقت ساز / synchronous) ​

cURL (غیر ہم وقت ساز / asynchronous) ​

Python ​

جواب ​

کامیابی — زیر التواء (200 OK) ​

کامیابی — Elliptic مکمل ہو گیا (200 OK) ​

جواب کے فیلڈز ​

Elliptic result آبجیکٹ ​

رسک لیولز ​

خرابی کے جوابات ​

تصدیقی خرابی (401) ​

توثیقی خرابی (400) ​

ناکافی بیلنس (402) ​

فراہم کنندہ دستیاب نہیں ہے (503) ​

ایرر کوڈ کا حوالہ ​

ریٹ لمٹس ​

ریٹ لمٹ سے تجاوز ہو گیا (429) ​

نتائج کا کیشنگ (Caching) ​

معاونت یافتہ نیٹ ورکس ​

Elliptic — جامع اسکریننگ (Holistic Screening) ​

سنگل اثاثہ اسکریننگ (Single Asset Screening) ​

نوٹس ​

POST /apiv2/aml

اینڈپوائنٹ URL

درخواست کے ہیڈرز

درخواست کا باڈی

پیرامیٹرز

فراہم کنندگان

مثالی درخواستیں

cURL (ہم وقت ساز / synchronous)

cURL (غیر ہم وقت ساز / asynchronous)

Python

جواب

کامیابی — زیر التواء (200 OK)

کامیابی — Elliptic مکمل ہو گیا (200 OK)

جواب کے فیلڈز

Elliptic `result` آبجیکٹ

رسک لیولز

خرابی کے جوابات

تصدیقی خرابی (401)

توثیقی خرابی (400)

ناکافی بیلنس (402)

فراہم کنندہ دستیاب نہیں ہے (503)

ایرر کوڈ کا حوالہ

ریٹ لمٹس

ریٹ لمٹ سے تجاوز ہو گیا (429)

نتائج کا کیشنگ (Caching)

معاونت یافتہ نیٹ ورکس

Elliptic — جامع اسکریننگ (Holistic Screening)

سنگل اثاثہ اسکریننگ (Single Asset Screening)

نوٹس