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

अवलोकन

यह एक बल्क सत्र हटाने का जॉब लौटाता है, जिसे Batch Delete Sessions से शुरू किया गया था: इसकी स्थिति, कितने सत्र संसाधित हुए, और प्रत्येक परिणाम में कितने सत्र आए। जब session_numbers से चुने गए या delete_all के साथ बैच हटाने में 20 से अधिक KYC सत्र मेल खाते हैं, तो अनुरोध PENDING जॉब के साथ 202 लौटाता है और सत्र पृष्ठभूमि में हटाए जाते हैं। जब तक status COMPLETED या FAILED न हो जाए, इस endpoint को हर कुछ सेकंड में पोल करें। जॉब द्वारा हटाया जाने वाला प्रत्येक सत्र उसी तरह हटाया जाता है जैसे Delete Session से हटाया जाता है: सत्र, उसके पास मौजूद हर सत्यापन प्रयास और उसकी संग्रहीत सभी फ़ाइलें हटा दी जाती हैं, और उसके मीडिया URL काम करना बंद कर देते हैं। हटाना स्थायी है और इसे पलटा नहीं जा सकता। जॉब केवल गिनती की रिपोर्ट देता है। यह कभी नहीं बताता कि उसने कौन से सत्र हटाए।

जॉब की स्थिति

delete_all जॉब केवल वे सत्र हटाता है जो अनुरोध से पहले बनाए गए थे। जॉब चलने के दौरान शुरू हुए सत्र नहीं हटाए जाते।

परिणामों की गिनती

deleted_child_verifications उन सत्यापनों को गिनता है जो व्यवसाय सत्यापन ने बनाए थे और जिन्हें उनके साथ हटाया गया। यह Batch Delete Sessions से शुरू किए गए जॉब के लिए हमेशा 0 रहता है, क्योंकि वह केवल KYC सत्र हटाता है।

अनुमतियाँ

एप्लिकेशन की कोई भी सक्रिय 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>
आवश्यक

POST /v3/sessions/delete/ से 202 के साथ लौटाया गया job_id।

प्रतिक्रिया

जॉब।

बैकग्राउंड में चल रहा बल्क सत्र विलोपन: प्रगति और प्रत्येक परिणाम की गणनाएँ, यह कभी नहीं कि इसने किन सत्रों को हटाया।

job_id
string<uuid>

इस id के साथ GET /v3/sessions/delete/{job_id}/ को पोल करें।

status
enum<string>

PENDING: स्वीकार कर लिया गया, अभी शुरू नहीं हुआ। PROCESSING: हटाया जा रहा है; processed और outcomes अपडेट हो रहे हैं। COMPLETED: प्रत्येक चयनित सत्र का हिसाब हो गया है। FAILED: कार्य समय से पहले रुक गया; error देखें।

उपलब्ध विकल्प:
PENDING,
PROCESSING,
COMPLETED,
FAILED
total
integer

डिलीशन का अनुरोध किए जाने पर चुने गए सत्र।

processed
integer

वे सत्र जिन्हें जॉब ने अब तक पूरा कर लिया है।

outcomes
object

प्रत्येक परिणाम में कितने सत्र समाप्त हुए। प्रत्येक कुंजी हमेशा मौजूद रहती है।

deleted_child_verifications
integer

हटाए गए व्यवसाय सत्यापनों द्वारा बनाए गए वे सत्यापन, जिन्हें उनके साथ ही हटा दिया गया है। POST /v3/sessions/delete/ द्वारा शुरू किए गए जॉब के लिए हमेशा 0, जो केवल KYC सत्रों को हटाता है।

error
string | null

जब तक status, FAILED न हो, तब तक null; यदि ऐसा है, तो विलोपन रुकने का कारण। जिन सत्रों तक कार्य नहीं पहुँचा था, वे अभी भी मौजूद हैं: उन्हें हटाने के लिए अनुरोध पुनः दोहराएँ।

created_at
string<date-time>

जब हटाए जाने का अनुरोध किया गया था।

completed_at
string<date-time> | null

जॉब कब समाप्त हुआ; इसके चलने के दौरान null।

अंतिम संशोधन 7 नवंबर 2026