मुख्य सामग्री पर जाएं
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 तक कंप्रेस की जाती हैं, इसलिए बहुत उच्च रिज़ॉल्यूशन सटीकता में सुधार नहीं करते हैं। इमेज में कम से कम एक डिटेक्ट किया जा सकने वाला चेहरा होना चाहिए — अन्यथा endpoint 400 लौटाता है। जब कई चेहरे मौजूद होते हैं, तो सबसे बड़े चेहरे की खोज की जाती है और MULTIPLE_FACES_DETECTED चेतावनी जोड़ी जाती है।

search_type
enum<string>
डिफ़ॉल्ट:most_similar

सर्च नीति। most_similar (डिफ़ॉल्ट) आपके एप्लिकेशन में प्रत्येक नामांकित चेहरे को समानता के आधार पर रैंक करता है। blocklisted_or_approved उम्मीदवारों को ब्लॉकलिस्ट किए गए चेहरों, अनुमति प्राप्त चेहरों, स्वीकृत सत्रों के चेहरों और इंपोर्ट किए गए उपयोगकर्ता-प्रोफ़ाइल चेहरों तक सीमित करता है — जिसमें ब्लॉकलिस्ट की गई प्रविष्टियों को सबसे पहले रैंक किया जाता है।

उपलब्ध विकल्प:
most_similar,
blocklisted_or_approved
उदाहरण:

"most_similar"

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

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

उदाहरण:

false

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

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

उदाहरण:

true

vendor_data
string

वैकल्पिक अपारदर्शी पहचानकर्ता (आपकी उपयोगकर्ता ID, ईमेल, UUID…) जो स्थायी सत्र पर संग्रहीत होता है और वापस भेजा जाता है। यह खोज परिणामों से समान-उपयोगकर्ता के चेहरों को बाहर नहीं करता है।

उदाहरण:

"user-123"

metadata
object

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

उदाहरण:

प्रतिक्रिया

चेहरा खोज पूर्ण। face_search.matches समानता के क्रम में अधिकतम 5 समान चेहरों को रखता है; एक खाली ऐरे का अर्थ है कि किसी भी नामांकित चेहरे ने समानता की न्यूनतम सीमा को पार नहीं किया। status केवल ब्लॉकलिस्ट हिट पर ही Declined होता है — अकेले डुप्लिकेट मिलान Approved लौटाते हैं, इसलिए केवल status ही नहीं, बल्कि matches और warnings की भी जांच करें। जब save_api_request=true हो, तो request_id सुरक्षित रखा गया सत्र आईडी होता है। प्रत्येक मिलान में source (session, imported, list_entry, या retained_template), vendor_user_id, और biometric_template_id होता है; एक retained_template मिलान स्रोत सत्र के हटाए जाने के बाद रखे गए छवि-मुक्त बायोमेट्रिक टेम्पलेट से आता है और इसमें सत्र फ़ील्ड, match_image_url, और user_details, null होते हैं।

request_id
string<uuid>

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

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