मुख्य सामग्री पर जाएं
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 तक कंप्रेस किया जाता है, इसलिए बहुत उच्च रिज़ॉल्यूशन से सटीकता में सुधार नहीं होता है।

ref_image
file
आवश्यक

तुलना करने के लिए संदर्भ चेहरे की छवि (उदा., पहचान दस्तावेज़ का पोर्ट्रेट या पहले नामांकित फ़ोटो)। user_image के समान ही प्रारूप और आकार सीमाएँ।

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

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

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

50

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

जब true हो, तो सेवा 90-डिग्री अंतराल (0, 90, 180, 270) में इनपुट छवियों को आज़माती है और उस ओरिएंटेशन का उपयोग करती है जिससे सबसे अच्छा फ़ेस डिटेक्शन प्राप्त होता है — अनुपलब्ध EXIF ओरिएंटेशन वाले मोबाइल कैप्चर के लिए उपयोगी। इससे विलंबता बढ़ती है, इसलिए इसे केवल तभी सक्षम करें यदि आप सीधी छवियों की गारंटी नहीं दे सकते।

उदाहरण:

false

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

true (डिफ़ॉल्ट) होने पर, कॉल को API-प्रकार के सत्र के रूप में बनाए रखता है — Business Console में दृश्यमान, लौटाए गए request_id का उपयोग करके GET /v3/session/{sessionId}/decision/ के माध्यम से प्राप्त करने योग्य, और status.updated webhook के माध्यम से घोषित किया जाता है। false होने पर, कुछ भी संग्रहीत नहीं किया जाता है और request_id केवल रिस्पॉन्स सहसंबंध के लिए एक अस्थायी UUID होता है।

उदाहरण:

true

vendor_data
string

वैकल्पिक अपारदर्शी स्ट्रिंग (आपकी आंतरिक उपयोगकर्ता ID, ईमेल, UUID…) जो स्थायी सत्र पर संग्रहीत होती है और रिस्पॉन्स में वापस भेजी जाती है। इसका उपयोग अपने स्वयं के रिकॉर्ड के साथ API कॉल को सहसंबंधित करने और बाद में सत्रों को फ़िल्टर करने के लिए करें।

उदाहरण:

"user-123"

metadata
object

सत्र के साथ संग्रहीत वैकल्पिक JSON ऑब्जेक्ट (जब save_api_request=true) और रिस्पॉन्स में वापस प्रतिध्वनित होता है। मल्टीपार्ट अनुरोधों में, इसे JSON-एन्कोडेड स्ट्रिंग फ़ील्ड (उदा. metadata={"flow":"login"}) के रूप में भेजें — इसे एक ऑब्जेक्ट में पार्स किया जाता है।

उदाहरण:

प्रतिक्रिया

चेहरा मिलान परिकलित किया गया है। face_match.score एक 0–100 फ़्लोट (दो दशमलव) है; जब स्कोर सख्ती से face_match_score_decline_threshold से ऊपर होता है तो status, Approved होता है, अन्यथा एक व्याख्यात्मक चेतावनी के साथ Declined होता है। कम समानता या स्कोर न करने योग्य जोड़ी भी 200 लौटाती है — केवल HTTP कोड ही नहीं, बल्कि face_match.status और face_match.warnings की भी जाँच करें। जब save_api_request=true हो, तो request_id सुरक्षित रखा गया सत्र आईडी होता है।

request_id
string<uuid>

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

face_match
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