मुख्य सामग्री पर जाएं
POST
cURL

प्राधिकरण

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।

बॉडी

multipart/form-data
user_image
file
आवश्यक

सामने की ओर चेहरे की इमेज (उदा. सेल्फ़ी)। स्वीकृत एक्सटेंशन: tiff, jpg, jpeg, png, webp। अधिकतम अपलोड आकार: 5 MB (फ़ाइलें इससे बड़ी होने पर 400 के साथ अस्वीकृत कर दी जाती हैं)। प्रोसेसिंग से पहले इमेज स्वचालित रूप से ~0.5 MB तक कंप्रेस की जाती हैं, इसलिए बहुत उच्च रिज़ॉल्यूशन सटीकता में सुधार नहीं करते हैं। इमेज में एक ही व्यक्ति होना चाहिए — जब कई चेहरे मौजूद होते हैं, तो सबसे बड़े चेहरे का मूल्यांकन किया जाता है और MULTIPLE_FACES_DETECTED चेतावनी जोड़ी जाती है।

face_liveness_score_decline_threshold
number<float>
डिफ़ॉल्ट:30

लाइवनेस स्कोर थ्रेशोल्ड (0–100)। इस मान पर या उससे नीचे का परिकलित स्कोर LOW_LIVENESS_SCORE चेतावनी जारी करता है और status को Declined पर सेट करता है। डिफ़ॉल्ट 30; अधिक सख्त एंटी-स्पूफिंग स्थिति के लिए इसे बढ़ाएं। 0–100 से बाहर के मान 400 लौटाते हैं।

आवश्यक सीमा: 0 <= x <= 100
उदाहरण:

30

rotate_image
boolean
डिफ़ॉल्ट:false

जब true होता है, तो सेवा इनपुट के 90-डिग्री घुमावों का प्रयास करती है और उस ओरिएंटेशन का उपयोग करती है जिससे सबसे अच्छा फ़ेस डिटेक्शन प्राप्त होता है। तब उपयोगी होता है जब EXIF ओरिएंटेशन गायब हो। विलंबता जोड़ता है।

उदाहरण:

false

save_api_request
boolean
डिफ़ॉल्ट:true

जब true (डिफ़ॉल्ट) होता है, तो कॉल को API-प्रकार के सत्र के रूप में सुरक्षित रखा जाता है, फ़ेस छवियों को संग्रहीत किया जाता है, status.updated webhook उत्सर्जित किया जाता है, और पहचानी गई फ़ेस को आपके चेहरा खोज इंडेक्स में नामांकित किया जाता है। जब false होता है, तो कॉल वन-शॉट होती है — कुछ भी संग्रहीत नहीं किया जाता है और चेहरा नामांकित नहीं होता है। ब्लॉकलिस्ट और डुप्लिकेट स्क्रीनिंग दोनों ही मामलों में चलती हैं।

उदाहरण:

true

vendor_data
string

वैकल्पिक अपारदर्शी पहचानकर्ता (आपकी उपयोगकर्ता ID, ईमेल, UUID…) जो स्थायी सत्र पर संग्रहीत होता है और वापस भेजा जाता है। इसका उपयोग डुप्लिकेट-चेहरा जांच से उसी vendor_data वाले पूर्व सत्रों को बाहर करने के लिए भी किया जाता है, ताकि उसी उपयोगकर्ता को पुनः सत्यापित करने पर DUPLICATED_FACE न उठे।

उदाहरण:

"user-123"

metadata
object

सत्र के साथ संग्रहीत (जब save_api_request=true) और वापस लौटाया जाने वाला वैकल्पिक JSON ऑब्जेक्ट। मल्टीपार्ट अनुरोधों में, इसे JSON-एन्कोडेड स्ट्रिंग फ़ील्ड के रूप में भेजें — इसे एक ऑब्जेक्ट में पार्स किया जाता है।

उदाहरण:

प्रतिक्रिया

निष्क्रिय लाइवनेस पूर्ण हुई। liveness.score मॉडल का 0–100 विश्वास स्कोर है कि छवि एक जीवित व्यक्ति को दर्शाती है; status Approved है जब तक कि error-गंभीरता वाली चेतावनी ट्रिगर न हुई हो। एक स्पूफ़ किया गया या ब्लॉकलिस्ट किया गया चेहरा अभी भी 200 लौटाता है — केवल HTTP कोड ही नहीं, बल्कि liveness.status और liveness.warnings की भी जांच करें। जब save_api_request=true होता है, तो request_id संरक्षित सत्र आईडी होती है।

request_id
string<uuid>

save_api_request=true होने पर सहेजी गई सत्र ID (GET /v3/session/{sessionId}/decision/ के साथ उपयोग योग्य); अन्यथा एक क्षणिक सहसंबंध UUID।

liveness
object
vendor_data
string | null

आपके द्वारा भेजे गए vendor_data का इको, या null।

metadata
object | null

आपके द्वारा भेजे गए metadata ऑब्जेक्ट का इको, या null।

created_at
string<date-time>

रिस्पॉन्स जनरेट होने का ISO 8601 टाइमस्टैम्प (UTC), उदा. 2026-06-12T01:04:42.763237+00:00।

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