GET /apiv2/screening/

کسی بھی حالت میں اسکریننگ آرڈر کو پڑھیں۔ پڑھنا مفت ہے اور جتنی بار چاہیں دہرایا جا سکتا ہے۔

یہ ورژن 2 کا معاہدہ ہے۔ یہ GET /apiv2/aml/{order_id} کی جگہ لیتا ہے، جو بدستور کام کر رہا ہے۔

Endpoint کا URL

GET https://netts.io/apiv2/screening/{client_order_id}

درخواست کے Headers

Header	Required	Description
X-API-KEY	ہاں	آپ کی API کلید Netts ڈیش بورڈ سے

Path Parameters

Parameter	Type	Description
client_order_id	string	آرڈر بننے پر واپس ملنے والا شناختی کوڈ: A کے بعد 14 ہیکساڈیسیمل حروف

Query Parameters

Parameter	Type	Default	Description
format	string	json	نتیجے کی نمائندگی۔ json واحد قابل قبول قدر ہے

نمائندگی درخواست کی خصوصیت ہے، آرڈر کی نہیں۔ ورژن 1 میں یہ آرڈر بننے کے وقت طے ہو جاتی تھی، اس لیے JSON کے طور پر آرڈر کی گئی جانچ کو کسی دوسرے طریقے سے نہیں پڑھا جا سکتا تھا۔

صرف ایک ہی نمائندگی ہے، اور وہ JSON ہے۔ اس پیرامیٹر کو اس لیے رکھا گیا ہے تاکہ بعد میں دوسرا شامل کرنا کوئی بریکنگ تبدیلی نہ بنے؛ فی الوقت کوئی بھی دوسری قدر 4001 لوٹاتی ہے۔ رپورٹ اس ڈیٹا کی رینڈرنگ ہے جو آپ کے پاس پہلے سے مکمل موجود ہے، اور اسے خود رینڈر کرنے سے آپ کو اپنی برانڈنگ، اپنی زبان اور اپنا لے آؤٹ ملتا ہے۔ دیکھیں رپورٹس۔

مثالیں

cURL

curl https://netts.io/apiv2/screening/A90D21F68C9AEA2 \
  -H "X-API-KEY: your_api_key"

Python — جانچ مکمل ہونے تک پول کریں

import time
import requests

headers = {"X-API-KEY": "your_api_key"}
url = "https://netts.io/apiv2/screening/A90D21F68C9AEA2"

while True:
    body = requests.get(url, headers=headers).json()
    status = body["order"]["status"]
    if status in ("completed", "failed", "skipped"):
        break
    time.sleep(2)

print(status, body["risk"]["level"], body["risk"]["score"])

جواب

آرڈر کی ہر حالت میں، اسی باڈی کے ساتھ 200 OK جو POST /apiv2/screening میں ہے۔ فیلڈز کا سیٹ حالت پر منحصر نہیں ہوتا: وہ بلاکس جن میں ابھی کوئی ڈیٹا نہیں ہے، انہیں چھوڑنے کے بجائے nulls اور خالی فہرستوں سے پُر کیا جاتا ہے۔

اسکریننگ کے نتائج لے جانے والے رسپانسز Cache-Control: private, no-store کے ساتھ بھیجے جاتے ہیں۔

ایک جانچ جو مکمل نہیں ہوئی ہے

{
  "schema_version": 2,
  "order": {
    "client_order_id": "A90D21F68C9AEA2",
    "status": "pending",
    "api_version": "v2",
    "cache_hit": false,
    "created_at": "2026-09-13T08:14:29.614988Z",
    "started_at": null,
    "completed_at": null
  },
  "request": { "address": "YOUR_ADDRESS_HERE", "network": "trx", "provider": "elliptic" },
  "billing": {
    "charged": true, "price_usdt": "0.98", "base_amount": "2.882421",
    "markup_amount": "0", "charged_amount": "2.882421", "charged_currency": "TRX",
    "exchange_rate": "0.33999200", "payment_status": "pending"
  },
  "precheck": { "activity_checked": true, "activity_status": "active", "source": "tron-address-checker" },
  "check": {
    "provider": "elliptic", "provider_check_id": null, "checked_at": null,
    "status": "pending", "provider_status": null
  },
  "risk": {
    "score": null, "scale": { "min": 0, "max": 10 }, "level": "none",
    "level_source": "computed", "provider_level": null, "policy": "netts-risk-v1",
    "by_direction": { "source": null, "destination": null }
  },
  "sanctions": null,
  "exposure": [],
  "rules": [],
  "entities": [],
  "primary_entity": null,
  "sanctioned_entities": [],
  "wallet": { "inflow_usd": null, "outflow_usd": null },
  "provider_data": { }
}

بغیر کسی سرگرمی والا پتہ

ایک ایسا پتہ جو بلاک چین پر کبھی استعمال نہیں ہوا، فراہم کنندہ کو نہیں بھیجا جاتا اور اس کا کوئی معاوضہ نہیں لیا جاتا۔ آرڈر موجود ہے، اس لیے نتیجہ پڑھا جا سکتا ہے:

{
  "order": {
    "client_order_id": "AC4F9BC45A79323",
    "status": "skipped",
    "started_at": null,
    "completed_at": null,
    "reason": "address_inactive"
  },
  "billing": { "charged": false, "charged_amount": "0", "payment_status": "not_charged" },
  "precheck": { "activity_checked": true, "activity_status": "inactive", "source": "tron-address-checker" },
  "check": { "status": "not_performed", "provider_check_id": null, "checked_at": null }
}

یہاں صرف وہی بلاکس دکھائے گئے ہیں جو تبدیل ہوتے ہیں؛ باقی حسب معمول nulls اور خالی فہرستوں کے ساتھ موجود ہوتے ہیں۔

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

فارمیٹ RFC 9457 ہے، Content-Type: application/problem+json۔ مکمل کوڈ کی فہرست POST صفحے پر موجود ہے۔

Code	HTTP	When
4003	400	شناختی کوڈ A اور اس کے بعد 14 ہیکساڈیسیمل حروف پر مشتمل نہیں ہے
4040	404	ایسا کوئی آرڈر موجود نہیں ہے
4010 / 4011	401	کوئی API کلید موجود نہیں، یا ایسی کلید یا IP جو قابل قبول نہیں

کسی دوسرے اکاؤنٹ کا آرڈر 403 کے بجائے 404 لوٹاتا ہے۔ ورنہ صرف رسپانس کوڈ سے ہی اس بات کی تصدیق ہو جائے گی کہ کسی دوسرے کا شناختی کوڈ موجود ہے۔

{
  "type": "https://doc.netts.io/api/v2/errors/order-not-found",
  "title": "Order not found",
  "status": 404,
  "detail": "Order not found",
  "instance": "/apiv2/screening/AFFFFFFFFFFFFFF",
  "code": 4040
}

Rate Limits

دیگر تمام AML پاتھس کے ساتھ مشترک: 5 درخواستیں فی سیکنڈ، 150 فی منٹ۔ پولنگ پر کوئی لاگت نہیں آتی لیکن یہ حد میں شمار ہوتی ہے — پولز کے درمیان دو سیکنڈ کا وقفہ کافی ہے۔

یہ بھی دیکھیں

• POST /apiv2/screening — جانچ کا آرڈر دیں
• GET /apiv2/screening/history — بیک وقت کئی جانچیں، مختصر فارم میں