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

सत्र प्रकार फ़िल्टर

session_kind क्वेरी पैरामीटर का उपयोग करके चुनें कि किस प्रकार के सत्र लौटाए जाएँ: रिस्पॉन्स की हर पंक्ति में session_kind: "user" | "business" शामिल होता है, ताकि आपका क्लाइंट हर पंक्ति की संरचना के आधार पर व्यवहार बदल सके।

सामान्य फ़िल्टर

ये फ़िल्टर दोनों प्रकारों पर लागू होते हैं (उपयोगकर्ता-केवल फ़िल्टर session_kind=business होने पर अनदेखे किए जाते हैं, और इसका उल्टा भी):

उदाहरण

रिस्पॉन्स (संक्षिप्त):

सत्र के प्रकार के अनुसार पंक्तियों की संरचना अलग होती है

उपयोगकर्ता सत्यापन (KYC) की पंक्तियों में शामिल हैं: portrait_image, document_type, full_name, country (जारी करने वाला राज्य), phone_number, email_address, और कुछ समीक्षा फ़ील्ड: assignee (वह Console समीक्षक जिसके पास सत्र है, या null), waiting_since और sla_due_at (केवल तभी सेट होते हैं जब सत्र In Review हो), top_warnings (सबसे महत्वपूर्ण चेतावनियाँ, हर एक के साथ risk, feature, log_type और short_description) और warnings_count। व्यवसाय सत्यापन (KYB) की पंक्तियों में शामिल हैं: workflow_type, workflow_label, company_name, registration_number, country (निगमन का देश)। दोनों में ये शामिल हैं: session_id, session_kind, session_number, status, vendor_data, created_at। पूरी सुविधा मैट्रिक्स के लिए देखें सत्र अवलोकन।

पेजिनेशन

पेजिनेशन limit (डिफ़ॉल्ट 50) और offset (डिफ़ॉल्ट 0) का उपयोग करता है, और रिस्पॉन्स में पूर्ण next और previous URL लौटाता है। दोनों पैरामीटर अधिकतम 1000000 तक के मान स्वीकार करते हैं; इससे बड़ा मान 400 लौटाता है। count 100 तक सटीक होता है और उससे आगे 100 पर ही रुक जाता है, इसलिए इसे कुल संख्या के रूप में उपयोग न करें। तब तक next URL माँगते रहें जब तक वह null न हो जाए। session_kind=all के साथ, count दोनों प्रकारों का योग होता है, जिनमें से हर एक 100 पर सीमित होता है।

संबंधित

प्राधिकरण

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।

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

session_kind
enum<string>
डिफ़ॉल्ट:user

किस प्रकार के सत्रों को सूचीबद्ध करना है: user (केवल KYC, डिफ़ॉल्ट), business (केवल KYB), या all (दोनों, संयोजित - मर्ज किए गए पेजिनेशन सिमेंटिक्स के लिए विवरण देखें)। मिलान केस-इनसेंसिटिव है (BUSINESS काम करता है); user/business/all के केस वेरिएंट के अलावा कोई भी मान 400 लौटाता है।

उपलब्ध विकल्प:
user,
business,
all
limit
integer
डिफ़ॉल्ट:50

प्रति पेज पंक्तियों की अधिकतम संख्या (session_kind=all होने पर प्रति प्रकार)। डिफ़ॉल्ट 50 है।

आवश्यक सीमा: 1 <= x <= 1000000
offset
integer
डिफ़ॉल्ट:0

पहली लौटाई गई पंक्ति से पहले छोड़ी जाने वाली पंक्तियों की संख्या। डिफ़ॉल्ट रूप से 0 है। रिस्पॉन्स से next/previous URL का अनुसरण करना बेहतर है।

आवश्यक सीमा: 0 <= x <= 1000000
status
string

शामिल करने के लिए सत्र स्थितियों की अल्पविराम से अलग की गई सूची, उदाहरण के लिए Approved,In Review। मान केस-संवेदनशील हैं; सत्यापन स्थितियाँ देखें। अज्ञात मान किसी से मेल नहीं खाते हैं।

vendor_data
string

सत्र निर्माण के समय आपके द्वारा भेजे गए vendor_data (आपका अपना उपयोगकर्ता/व्यवसाय पहचानकर्ता) पर सटीक-मिलान फ़िल्टर। आंशिक मिलानों के लिए इसके बजाय search का उपयोग करें।

प्रदर्शित किया गया पूरा संदर्भ जैसे S-0001 (उपयोगकर्ता) या B-0001 (व्यवसाय) केवल उसी सत्र संख्या और प्रकार से मेल खाता है; शुरुआती शून्य और अक्षरों का केस मिलान को प्रभावित नहीं करते हैं। स्मार्ट फ़्री-टेक्स्ट खोज। एक पूर्ण UUID session_id से मेल खाता है; संख्यात्मक इनपुट सत्र-संख्या उपसर्ग, दस्तावेज़/व्यक्तिगत संख्या, फ़ोन उपसर्ग, या vendor_data से मेल खाता है; @ वाला इनपुट ईमेल उपसर्गों से मेल खाता है; अन्य टेक्स्ट नामों (एक्सेंट-असंवेदनशील) और vendor_data से मेल खाता है। अंकों वाला फ़्री टेक्स्ट दस्तावेज़/व्यक्तिगत-संख्या खोज फ़ील्ड और सत्र-संख्या उपसर्गों से भी मेल खाता है।

workflow_id
string

अल्पविराम से अलग किए गए वर्कफ़्लो UUID (उन्हें Console में Workflows पेज पर खोजें)। सूची में अमान्य प्रारूप वाले UUID को अनदेखा कर दिया जाता है; यदि कोई भी मान्य नहीं है तो परिणाम रिक्त होता है।

date_from
string<date>

केवल इस तारीख (UTC) को या उसके बाद बनाए गए सत्र, प्रारूप YYYY-MM-DD। अमान्य तारीखें 400 लौटाती हैं।

date_to
string<date>

केवल इस तारीख (UTC) तक बनाए गए सत्र, प्रारूप YYYY-MM-DD। KYC पंक्तियों के लिए पूरा दिन शामिल है; KYB पंक्तियों के लिए तुलना created_at <= date_to (आधी रात) है, इसलिए KYB सत्रों का पूरा दिन शामिल करने के लिए अगले दिन की तारीख का उपयोग करें।

tags
string

अल्पविराम से अलग किए गए टैग id (आपके एप्लिकेशन के tags)। उन सत्रों को लौटाता है जिनमें इनमें से कोई भी शामिल है। वे id जो मान्य UUID नहीं हैं, अनदेखे कर दिए जाते हैं, और जब कोई भी मान्य नहीं होता है तो सूची खाली होती है।

decided_from
string<date-time>

ISO 8601 दिनांक-समय। उन सत्रों को लौटाता है जिनकी स्थिति पिछली बार इस समय पर या इसके बाद बदली थी। यह निर्माण समय पर नहीं, बल्कि अंतिम स्थिति परिवर्तन के समय पर फ़िल्टर करता है।

decided_to
string<date-time>

ISO 8601 दिनांक-समय (datetime)। उन सत्रों को लौटाता है जिनकी स्थिति पिछली बार इससे पहले बदली थी। हाफ़-ओपन विंडो के लिए decided_from के साथ संयोजित करें।

country
string

कॉमा से अलग किया गया देश फ़िल्टर। KYC पंक्तियों के लिए: पहचान दस्तावेज़ जारीकर्ता राज्य के ISO 3166-1 alpha-3 कोड (उदा. ESP,USA), जो राष्ट्रीयता से भिन्न हो सकते हैं। KYB पंक्तियों के लिए: रजिस्ट्री कंपनी का देश कोड।

document_type
string

सत्र में सत्यापित कॉमा से अलग किए गए पहचान दस्तावेज़ प्रकार कोड (केवल KYC पंक्तियाँ): P (पासपोर्ट), ID (पहचान पत्र), DL (ड्राइविंग लाइसेंस), RP (निवास परमिट), SSC (सोशल सिक्योरिटी कार्ड), HIC (स्वास्थ्य बीमा कार्ड), WP (वर्क परमिट), TC (टैक्स कार्ड), VISA, PSC (पब्लिक सर्विस कार्ड), BC (जन्म प्रमाण पत्र), OTHER। ध्यान दें कि रिस्पॉन्स फ़ील्ड document_type में कोड नहीं, बल्कि प्रदर्शित नाम होता है।

document_name
string

सटीक दस्तावेज़ नाम; कई नाम अल्पविराम से अलग करके भेजे जा सकते हैं, लेकिन मान को अल्पविराम पर केवल तभी विभाजित किया जाता है जब इसमें एक से अधिक - विभाजक हों (एम्बेडेड अल्पविराम वाले एकल नाम का मिलान पूरा किया जाता है)। नाम वे हैं जिन्हें दस्तावेज़ सत्यापन (आगे या पीछे के भाग) द्वारा पहचाना जाता है, उदाहरण के लिए Spain - Id Card (2021)। केवल KYC पंक्तियाँ।

region
string

कॉमा से अलग किए गए दस्तावेज़ क्षेत्र/राज्य मान (प्रति क्षेत्र जारी किए गए दस्तावेज़ों के लिए, जैसे कि US ड्राइविंग लाइसेंस)। केवल KYC पंक्तियाँ।

didit_internal_id
string<uuid>

एक सत्यापित उपयोगकर्ता के सभी सत्रों को सूचीबद्ध करने के लिए Didit के आंतरिक उपयोगकर्ता पहचानकर्ता (didit_internal_id रिस्पॉन्स फ़ील्ड) द्वारा फ़िल्टर करें। एक मान्य UUID होना चाहिए; विकृत मान 400 लौटाते हैं। केवल KYC पंक्तियाँ।

session_type
string

अल्पविराम से अलग किए गए सत्र निर्माण चैनल: API, HOSTED, MIGRATED। विशेष मान ALL (या पैरामीटर छोड़ना) फ़िल्टर को अक्षम कर देता है। केवल KYC पंक्तियाँ।

api_service
enum<string>

सेवा द्वारा स्टैंडअलोन API सत्रों को फ़िल्टर करें। अमान्य मान 400 लौटाते हैं। केवल KYC पंक्तियाँ।

उपलब्ध विकल्प:
ID_VERIFICATION,
FACE_MATCH,
AGE_ESTIMATION,
FACE_SEARCH,
POA,
AML,
KYB_REGISTRY,
PASSIVE_LIVENESS,
DATABASE_VALIDATION,
PHONE_VERIFICATION,
EMAIL_VERIFICATION
screened_full_name
string

AML और डेटाबेस सत्यापन से स्क्रीन किए गए डेटा के भीतर एक्सेंट-असंवेदनशील नाम खोज। जब api_service=AML या api_service=DATABASE_VALIDATION के साथ जोड़ा जाता है, तो खोज उस सुविधा के स्क्रीन किए गए डेटा तक ही सीमित होती है। केवल KYC पंक्तियाँ।

warning
string

अल्पविराम से अलग किए गए चेतावनी जोखिम कोड; उन सत्रों को लौटाता है जिन्होंने इनमें से किसी को भी ट्रिगर किया है (उदा. POSSIBLE_FRAUD)। जोखिम कोड चेतावनी दस्तावेज़ीकरण में प्रति सुविधा सूचीबद्ध हैं। KYC पंक्तियों पर और व्यावसायिक चेतावनी कोड के साथ KYB पंक्तियों पर लागू होता है।

status_initialized_as_in_review
boolean

जब true होता है, तो केवल वे सत्र जिनका निर्णय शुरुआत में In Review में आया था (मैन्युअल समीक्षा की मात्रा का ऑडिट करने के लिए उपयोगी)। केवल KYC पंक्तियाँ।

is_kyc_to_be_reviewed
boolean

true उन सत्रों को लौटाता है जिनके दस्तावेज़ सत्यापन को मैन्युअल समीक्षा के लिए फ़्लैग किया गया है; false उन सत्रों को लौटाता है जिनके दस्तावेज़ सत्यापन को स्पष्ट रूप से फ़्लैग नहीं किया गया है। अक्षम करने के लिए छोड़ दें। केवल KYC पंक्तियाँ।

euuid
string<uuid>

अंतिम उपयोगकर्ता के euuid (सत्यापित करने वाले उपयोगकर्ता को असाइन किया गया UUID, कंसोल डीप लिंक द्वारा उपयोग किया जाता है) द्वारा फ़िल्टर करें। एक मान्य UUID होना चाहिए; गलत प्रारूप वाले मान 400 फ़ील्ड त्रुटि लौटाते हैं। केवल KYC पंक्तियाँ।

organization_name
string

अल्पविराम से अलग किए गए संगठन के नाम। कंसोल-उन्मुख; एक API कुंजी के साथ (जो पहले से ही एक एप्लिकेशन तक सीमित है) यह केवल आपके अपने संगठन के नाम से मेल खाता है।

प्रतिक्रिया

पेजिनेटेड सत्र सूची। session_kind के आधार पर results आइटम KYC पंक्तियाँ, KYB पंक्तियाँ, या दोनों होते हैं; प्रत्येक पंक्ति के session_kind फ़ील्ड से भेद करें।

count
integer
आवश्यक

फ़िल्टर से मेल खाने वाले सत्रों की संख्या: 100 तक सटीक और उससे अधिक होने पर 100 पर सीमित, इसलिए इसे कुल संख्या के रूप में उपयोग न करें। यह जानने के लिए कि क्या और पेज मौजूद हैं, next का उपयोग करें। session_kind=all के लिए यह दोनों प्रकारों का योग है, प्रत्येक 100 पर सीमित है।

उदाहरण:

2

next
string<uri> | null
आवश्यक

अगले पेज का पूर्ण URL, या अंतिम पेज पर null।

उदाहरण:

"https://verification.didit.me/v3/sessions/?limit=20&offset=20"

previous
string<uri> | null
आवश्यक

पिछले पेज का पूर्ण URL, या पहले पेज पर null।

उदाहरण:

null

results
(KYC session row (session_kind: user) · object | KYB session row (session_kind: business) · object)[]
आवश्यक

सत्र पंक्तियाँ, नवीनतम पहले। session_kind=all के साथ, KYC पंक्तियाँ पहले आती हैं, फिर KYB पंक्तियाँ।

उपयोगकर्ता सत्यापन (KYC) सत्र के लिए सारांश पंक्ति। पहचान फ़ील्ड (full_name, country, document_type, portrait_image, संपर्क फ़ील्ड) उत्तरोत्तर पॉप्युलेट होते हैं जैसे ही उपयोगकर्ता सत्यापन चरणों को पूरा करता है, और प्रासंगिक चरण समाप्त होने तक null होते हैं। वर्कफ़्लो के रिस्पॉन्स-एट्रिब्यूट कॉन्फ़िगरेशन द्वारा प्रतिबंधित फ़ील्ड भी null के रूप में लौटाए जाते हैं।

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