GET /apiv2/screening/

किसी भी स्थिति में स्क्रीनिंग ऑर्डर पढ़ें। पढ़ना निःशुल्क है और इसे जितनी बार चाहें उतनी बार दोहराया जा सकता है।

यह संस्करण 2 अनुबंध है। यह GET /apiv2/aml/{order_id} को प्रतिस्थापित करता है, जो काम करना जारी रखता है।

एंडपॉइंट URL

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

अनुरोध हेडर

Header	Required	Description
X-API-KEY	Yes	Netts डैशबोर्ड से आपकी API कुंजी

पाथ पैरामीटर

Parameter	Type	Description
client_order_id	string	ऑर्डर बनाए जाने पर लौटाया गया पहचानकर्ता: A के बाद 14 हेक्साडेसिमल वर्ण

क्वेरी पैरामीटर

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"])

प्रतिक्रिया

ऑर्डर की प्रत्येक स्थिति में POST /apiv2/screening के समान बॉडी के साथ 200 OK। फ़ील्ड सेट स्थिति पर निर्भर नहीं करता है: जिन ब्लॉकों में अभी तक कोई डेटा नहीं है, उन्हें बाहर छोड़ने के बजाय नल (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 }
}

यहाँ केवल वही ब्लॉक दिखाए गए हैं जो बदलते हैं; बाकी हमेशा की तरह नल और खाली सूचियों के साथ मौजूद हैं।

त्रुटि प्रतिक्रियाएं

प्रारूप RFC 9457, Content-Type: application/problem+json है। पूरी कोड सूची POST पृष्ठ पर है।

Code	HTTP	When
4003	400	पहचानकर्ता A और उसके बाद 14 हेक्साडेसिमल वर्ण नहीं है
4040	404	ऐसा कोई ऑर्डर नहीं है
4010 / 4011	401	कोई API कुंजी नहीं है, या कोई ऐसी कुंजी या IP है जो स्वीकृत नहीं है

किसी अन्य खाते से संबंधित ऑर्डर 404 का उत्तर देता है, 403 का नहीं। अन्यथा केवल रिस्पॉन्स कोड ही इस बात की पुष्टि कर देगा कि किसी अन्य का पहचानकर्ता मौजूद है।

{
  "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
}

दर सीमाएं

हर दूसरे AML पथ के साथ साझा किया गया: प्रति सेकंड 5 अनुरोध, प्रति मिनट 150। पोलिंग में कुछ भी खर्च नहीं होता है लेकिन यह सीमा में गिना जाता है — पोल के बीच दो सेकंड का समय पर्याप्त है।

यह भी देखें

• POST /apiv2/screening — एक जांच का ऑर्डर दें
• GET /apiv2/screening/history — संक्षिप्त रूप में, एक साथ कई जांचें