मुख्य सामग्री पर जाएं
GET
curl

अवलोकन

यह उपयोगकर्ताओं के लिए AML निगरानी टॉगल करें या व्यवसायों के लिए AML निगरानी टॉगल करें से शुरू किए गए सतत AML निगरानी जॉब की जानकारी लौटाता है: इसकी स्थिति, हर परिणाम के लिए काउंटर और हर संसाधित उपयोगकर्ता या व्यवसाय के लिए results की एक प्रविष्टि। 20 से अधिक प्रोफ़ाइल वाले चयन पृष्ठभूमि में प्रोसेस होते हैं, और टॉगल कॉल PENDING जॉब के साथ 202 लौटाता है। status COMPLETED या FAILED होने तक हर कुछ सेकंड में इस endpoint को पोल करें। प्रोफ़ाइल संसाधित होने के साथ results भरते जाते हैं, प्रसंस्करण के क्रम में, और जॉब COMPLETED होने पर पूरा हो जाता है। प्रति-रिकॉर्ड परिणाम उन जॉब के लिए दर्ज होते हैं जो API के माध्यम से शुरू किए गए हों; Business Console से शुरू किया गया जॉब केवल काउंटर रिपोर्ट करता है।

जॉब स्थिति

प्रति-रिकॉर्ड outcome मान टॉगल पेजों पर दस्तावेज़ित हैं।

अनुमतियाँ

एप्लिकेशन की कोई भी सक्रिय API कुंजी इस endpoint को कॉल कर सकती है। जॉब केवल उसी एप्लिकेशन को दिखता है जिसने उसे बनाया है; कोई भी अन्य job_id 404 लौटाता है।

संबंधित

प्राधिकरण

x-api-key
string
header
आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

पथ पैरामीटर

job_id
string<uuid>
आवश्यक

टॉगल endpoint द्वारा लौटाया गया job_id।

प्रतिक्रिया

जॉब।

job_id
string<uuid>
status
enum<string>
उपलब्ध विकल्प:
PENDING,
PROCESSING,
COMPLETED,
FAILED
is_enabled
boolean

जब जॉब निगरानी सक्षम करता है तो true, जब यह इसे अक्षम करता है तो false।

target_type
enum<string>

जॉब किस प्रोफ़ाइल फ़ैमिली को टॉगल करता है।

उपलब्ध विकल्प:
user,
business
total
integer

वे प्रोफ़ाइल जिन्हें जॉब संसाधित करता है।

processed
integer

अब तक संसाधित की गई प्रोफ़ाइल।

outcomes
object

प्रति-रिकॉर्ड परिणाम काउंटर। प्रत्येक चयनित प्रोफ़ाइल का परिणाम ठीक एक काउंटर में दर्ज होता है; कुछ भी चुपचाप छोड़ा नहीं जाता है।

results
object[]

प्रसंस्करण क्रम में, संसाधित की गई प्रति प्रोफ़ाइल एक प्रविष्टि। जॉब चलने के दौरान बढ़ती है; स्थिति COMPLETED होने पर पूर्ण होती है। API के माध्यम से शुरू की गई जॉब्स के लिए रिकॉर्ड किया गया; Business Console से शुरू की गई जॉब केवल काउंटर्स रिपोर्ट करती है।

error
string | null

स्थिति FAILED होने पर सामान्य विफलता संदेश; विस्तृत कारण प्लेटफ़ॉर्म-साइड पर रखा जाता है।

created_at
string<date-time>
completed_at
string<date-time> | null
अंतिम संशोधन 7 नवंबर 2026