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

अवलोकन

vendor_data द्वारा कुंजीबद्ध एक उपयोगकर्ता इकाई लौटाता है। प्रतिक्रियाओं में didit_internal_id शामिल होता है, जो Didit का स्थिर आंतरिक पहचानकर्ता है।

इसे कब उपयोग करें

  • उपयोगकर्ता की वर्तमान सत्यापन स्थिति की जांच करें। features मैप एक ही ऑब्जेक्ट में हर सुविधा की नवीनतम स्थिति देता है।
  • अपने UI में विस्तृत दृश्य: रेंडर करने से पहले माँग पर प्रोफ़ाइल लाएँ।
  • जोखिम स्कोरिंग: अपनी ओर से हर उपयोगकर्ता का स्कोर निकालने के लिए सत्र काउंटर और features को मिलाएँ।

नोट्स

  • URL में vendor_data केस-संवेदी है।
  • यदि एप्लिकेशन में उस vendor_data वाला कोई उपयोगकर्ता मौजूद नहीं है, तो 404 लौटाता है।
  • कुल काउंटर (session_count, approved_count, declined_count, in_review_count) सत्र पूरे होने के साथ रीयल टाइम में अपडेट होते हैं।
  • हर फ़ील्ड के लिए उपयोगकर्ता डेटा मॉडल देखें।

अनुमतियाँ

एप्लिकेशन की कोई भी सक्रिय API कुंजी इस endpoint को कॉल कर सकती है। Didit API कुंजियाँ एप्लिकेशन-स्कोप्ड हैं, भूमिका-स्कोप्ड नहीं: कंसोल की भूमिकाएँ और अनुमतियाँ (read:users और बाकी) तय करती हैं कि कोई व्यक्ति कंसोल में क्या कर सकता है, और इनका मूल्यांकन Management API ट्रैफ़िक के लिए नहीं किया जाता। इस endpoint को कौन कॉल कर सकता है, यह नियंत्रित करने के लिए यह नियंत्रित करें कि एप्लिकेशन की API कुंजी कौन पढ़ सकता है।

संबंधित

प्राधिकरण

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।

पथ पैरामीटर

vendor_data
string
आवश्यक

उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता — एक मुक्त-रूप स्ट्रिंग (UUID नहीं)। यह वही मान है जिसे आपने इस उपयोगकर्ता को पहली बार पेश करने वाले सत्र को बनाते समय vendor_data के रूप में पास किया था, ठीक वैसे ही मिलान किया गया जैसा भेजा गया था।

प्रतिक्रिया

मेटाडेटा, टिप्पणियाँ/गतिविधि लॉग और संकलित सत्र डेटा सहित पूर्ण उपयोगकर्ता विवरण।

पूर्ण उपयोगकर्ता विवरण। मेटाडेटा, टिप्पणियों और updated_at के साथ UserListItem का विस्तार करता है।

didit_internal_id
string<uuid>

इस उपयोगकर्ता के लिए Didit का स्थायी आंतरिक UUID।

vendor_data
string | null

इस उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता (सत्र बनाते समय पास किया गया)। जब कोई वेंडर पहचानकर्ता प्रदान नहीं किया गया था, तो यह null हो सकता है।

display_name
string | null

आपके द्वारा सेट किया गया कस्टम प्रदर्शन नाम

full_name
string | null

सत्यापित दस्तावेज़ों से निकाला गया पूरा नाम

date_of_birth
string<date> | null
effective_name
string | null

सर्वोत्तम उपलब्ध नाम: यदि सेट है तो display_name, अन्यथा full_name

status
enum<string>

उपयोगकर्ता रिकॉर्ड की लाइफ़साइकिल स्थिति (सत्र स्थिति नहीं)। ACTIVE डिफ़ॉल्ट है, FLAGGED उपयोगकर्ता को मैन्युअल ध्यान के लिए चिह्नित करता है, BLOCKED इस vendor_data के लिए नए सत्रों को रोकता है।

उपलब्ध विकल्प:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

उपयोगकर्ता की पोर्ट्रेट फ़ोटो का प्री-साइन किया गया URL (कुछ घंटों के बाद समाप्त हो जाता है)

session_count
integer

इस उपयोगकर्ता के लिए सत्यापन सत्रों की कुल संख्या

approved_count
integer

स्वीकृत सत्रों की संख्या

declined_count
integer

अस्वीकृत सत्रों की संख्या

in_review_count
integer

समीक्षाधीन सत्रों की संख्या

issuing_states
string[]

इस उपयोगकर्ता के स्वीकृत ID दस्तावेज़ों पर देखे गए जारीकर्ता देशों के ISO 3166-1 alpha-3 कोड, उदा. ["USA", "ESP"]। कोई न होने पर खाली ऐरे।

approved_emails
string[]

इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित ईमेल पते, उदा. ["john@example.com"]।

approved_phones
string[]

इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित फ़ोन नंबर, उदा. ["+14155551234"]।

features
object

इस उपयोगकर्ता के सभी सत्रों में प्रति-सुविधा एकत्रित स्थिति। संभावित कुंजियाँ: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION। संभावित मान: Approved, Declined, In Review, Not Finished, Resub Requested।

features_list
object[]

features जैसा ही डेटा, {feature, status} ऑब्जेक्ट्स के एक क्रमबद्ध ऐरे के रूप में।

last_session_at
string<date-time> | null

सबसे हाल के सत्र का टाइमस्टैम्प

first_session_at
string<date-time> | null

पहले सत्र का टाइमस्टैम्प

last_activity_at
string<date-time> | null

इस उपयोगकर्ता की सबसे हाल की गतिविधि का टाइमस्टैम्प (सत्र, लेन-देन, स्थिति परिवर्तन, डेटा संपादन, आदि)।

tags
object[]

टैग असाइनमेंट। ध्यान दें: विवरण रिस्पॉन्स पर प्रत्येक प्रविष्टि एक टैग लिंक ऑब्जेक्ट ({uuid, tag: {...}, added_by_email, added_by_name, created_at}) होती है, जो सूची रिस्पॉन्स पर उपयोग किए जाने वाले फ़्लैट {uuid, name, color} आकार से भिन्न है।

created_at
string<date-time>
metadata
object

कस्टम मेटाडेटा JSON जिसे आपने इस उपयोगकर्ता से जोड़ा है। डिफ़ॉल्ट {} है।

comments
object[]

इस उपयोगकर्ता के लिए गतिविधि लॉग और टिप्पणियाँ (स्थिति परिवर्तन, प्रोफ़ाइल संपादन, मैन्युअल नोट्स)।

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