मुख्य सामग्री पर जाएं
POST
curl
किसी base64-एन्कोडेड चेहरे की छवि को चेहरे की ब्लॉकलिस्ट या अनुमतिसूची में अपलोड करें। Didit छवि में मौजूद चेहरों की पहचान करता है, सबसे बड़ा चेहरा रखता है, छवि और उस चेहरे का क्रॉप सहेजता है, और चेहरे के बायोमेट्रिक टेम्पलेट की गणना करता है जिससे नए सत्रों की तुलना की जाती है। नई एंट्री का value उस चेहरे का UUID होता है। यह केवल entry_type: face और list_type: blocklist या list_type: allowlist वाली सूचियों के लिए उपलब्ध है।
अगर आप किसी मौजूदा सत्र से चेहरे को ब्लॉकलिस्ट या अनुमतिसूची में डालना चाहते हैं, तो इसके बजाय reference_session_id के साथ एंट्री बनाएँ का उपयोग करें: एंट्री उस सत्र से लिंक हो जाती है।
छवि में एक साफ़ दिखने वाला चेहरा होना चाहिए, और डिकोड होने के बाद उसका आकार अधिकतम 2 MB होना चाहिए। अगर कोई चेहरा नहीं मिलता, तो अनुरोध 400 लौटाता है और कोई एंट्री नहीं बनती। अगर चेहरे का विश्लेषण अस्थायी रूप से उपलब्ध नहीं है, तो यह 503 लौटाता है: बाद में पुनः प्रयास करें।
चेहरे को सूची से हटाने के लिए, उसकी एंट्री हटाएँ। इसके बाद वह नए सत्रों से मेल नहीं खाएगा।

प्राधिकरण

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।

पथ पैरामीटर

list_uuid
string<uuid>
आवश्यक

entry_type: face और list_type: blocklist या allowlist वाली सूची का UUID।

बॉडी

application/json
image
string<byte>
आवश्यक

Base64-एन्कोडेड JPEG या PNG, डीकोड होने के बाद अधिकतम 2 MB, जिसमें साफ़ तौर पर दिखाई देने वाला चेहरा हो। बिना किसी data:image/...;base64, प्रीफ़िक्स के केवल सामान्य base64 स्ट्रिंग भेजें।

comment
string
डिफ़ॉल्ट:""

वैकल्पिक फ़्री-टेक्स्ट नोट, जैसे कि लिस्टिंग का कारण।

प्रतिक्रिया

चेहरा प्रविष्टि बनाई गई थी।

सूची में एक मान।

uuid
string<uuid>
आवश्यक

प्रविष्टि पहचानकर्ता। ‘सूची प्रविष्टि हटाएँ’ में इसे entry_uuid के रूप में उपयोग करें।

value
string
आवश्यक

सूचीबद्ध मान: E.164 में एक फ़ोन नंबर, एक ईमेल पता, एक दस्तावेज़ संख्या, एक IP पता या CIDR रेंज, एक डिवाइस फ़िंगरप्रिंट, एक वॉलेट पता, एक बैंक खाता, एक ISO 3166-1 alpha-3 देश कोड, एक vendor_data, key सूची पर कोई भी स्ट्रिंग, या फ़ेस सूची पर संग्रहीत चेहरे का UUID। आपके द्वारा भेजे गए मान लोअरकेस में संग्रहीत किए जाते हैं, फ़ोन नंबरों और देश कोडों को छोड़कर। मिलान केस-इनसेंसिटिव होता है।

display_label
string | null
आवश्यक

मानव-पठनीय लेबल। Didit इसे किसी सत्र से ली गई प्रविष्टियों (उदाहरण के लिए धारक का नाम और दस्तावेज़ संख्या) के लिए भरता है जब आप कोई नहीं भेजते हैं।

Maximum string length: 512
comment
string
आवश्यक

मुक्त-पाठ नोट। सेट न होने पर खाली स्ट्रिंग।

added_by
string | null
आवश्यक

प्रविष्टि किसने जोड़ी: api (एक API कुंजी), कंसोल उपयोगकर्ता का ईमेल पता या console, system या migration (Didit द्वारा बनाई गई प्रविष्टियाँ), या rule (एक लेन-देन या निगरानी नियम कार्रवाई)।

reference_session_id
string<uuid> | null
आवश्यक

सत्यापन सत्र जिससे प्रविष्टि ली गई थी। null जब प्रविष्टि मान द्वारा जोड़ी गई थी।

reference_session_number
integer | null
आवश्यक

उस सत्र का एप्लिकेशन-स्कोप नंबर, जैसा कि कंसोल में दिखाया गया है।

reference_session_type
enum<string> | null
आवश्यक

व्यक्ति सत्यापन सत्र के लिए kyc, व्यवसाय सत्यापन सत्र के लिए kyb, कोई सत्र न होने पर null।

उपलब्ध विकल्प:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
आवश्यक

वह रिकॉर्ड जिसका प्रतिनिधित्व यह प्रविष्टि करती है: सत्र से पढ़ा गया चेहरा, दस्तावेज़, फ़ोन या ईमेल रिकॉर्ड, ‘सूची में चेहरा अपलोड करें’ द्वारा बनाया गया चेहरा, या आपके द्वारा भेजा गया UUID (उदाहरण के लिए एक लेन-देन UUID या उपयोगकर्ता की didit_internal_id)।

metadata
object | null
आवश्यक

अतिरिक्त संदर्भ। Didit द्वारा सेट की गई कुंजियों (यहाँ सूचीबद्ध) को प्रविष्टि बनाते समय आपके द्वारा भेजे गए किसी भी metadata के साथ मर्ज करके रखता है, जो संग्रहीत रूप में लौटाया जाता है। कुछ न होने पर null।

created_at
string<date-time>
आवश्यक

जब प्रविष्टि जोड़ी गई थी।

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