मुख्य सामग्री पर जाएं
POST
curl
सूची में एक एंट्री जोड़ें। मान की जाँच सूची के एंट्री प्रकार के अनुसार की जाती है:
  • email: एक मान्य ईमेल पता
  • phone: एक मान्य अंतरराष्ट्रीय फ़ोन नंबर, जो E.164 में संग्रहीत होता है (उदाहरण के लिए +14155552671)
  • ip_address: एक मान्य IP पता या CIDR रेंज (जैसे 192.168.1.1 या 10.0.0.0/8)
  • device_fingerprint: अक्षरों, अंकों, -, _, : और . में से कम से कम 8 वर्ण। ब्लॉकलिस्ट ऐसे फ़िंगरप्रिंट को अस्वीकार करती है जिसे कई अलग-अलग डिवाइसों ने रिपोर्ट किया हो, क्योंकि उसे ब्लॉक करने से असंबंधित लोग भी रुक जाएँगे।
  • country: एक मान्य ISO 3166-1 alpha-3 देश कोड (जैसे USA, GBR, ESP)। alpha-2 कोड (जैसे US) स्वीकार किए जाते हैं और अपने-आप alpha-3 में बदल दिए जाते हैं।
  • user, business: उपयोगकर्ता या व्यवसाय का vendor_data
  • face, document, wallet_address, bank_account, key: कोई भी खाली न हो, ऐसी कोई स्ट्रिंग
सभी एंट्री मान केस-इनसेंसिटिव होते हैं। आप जो मान भेजते हैं, वे संग्रहीत करते समय सामान्यीकृत किए जाते हैं (फ़ोन नंबर E.164 में, देश कोड बड़े अक्षरों में, बाकी सब छोटे अक्षरों में) और सत्यापन के दौरान केस-इनसेंसिटिव तरीके से मिलाए जाते हैं। उदाहरण के लिए, User@Example.COM को ब्लॉक करने पर user@example.com भी पकड़ा जाएगा। एक सूची में हर मान केवल एक बार रहता है: सूची में पहले से मौजूद मान जोड़ने पर 400 लौटता है।
चेहरे के लिए, जब आपके पास केवल इमेज हो तो Upload face का उपयोग करें, या किसी मौजूदा सत्र का चेहरा लेने के लिए reference_session_id भेजें। चेहरे की एंट्री के लिए संग्रहीत चेहरा चाहिए जिससे मिलान किया जा सके, और टाइप किया गया value वह उपलब्ध नहीं कराता।

सत्र से जोड़ना

जब आप reference_session_id देते हैं, तो Didit:
  1. सत्र खोजता है (वह उसी एप्लिकेशन का होना चाहिए)
  2. सत्र में सूची के एंट्री प्रकार के सबसे हाल के रिकॉर्ड से मान पढ़ता है:
    • face: लाइवनेस सेल्फ़ी का चेहरा; value चेहरे का UUID है
    • document: दस्तावेज़ संख्या; पूरा नाम, जारी करने वाला राज्य, दस्तावेज़ प्रकार, क्षेत्र और दस्तावेज़ संख्या metadata में संग्रहीत होते हैं, और display_label डिफ़ॉल्ट रूप से धारक का नाम और दस्तावेज़ संख्या होता है
    • phone: फ़ोन नंबर
    • email: ईमेल पता
    • ip_address: सत्र का IP पता
    • device_fingerprint: एक ऐसा फ़िंगरप्रिंट जो एक डिवाइस की पहचान करे, जिसमें वह डिवाइस प्राथमिकता पाए जिसने सत्यापन का कोई चरण पूरा किया हो। ब्लॉकलिस्ट पर, Didit ऐसे सत्र को अस्वीकार करता है जिसमें केवल डिवाइस-क्लास फ़िंगरप्रिंट हो, या जो एक से अधिक डिवाइसों पर पूरा हुआ हो: इन स्थितियों में सटीक फ़िंगरप्रिंट value के रूप में भेजें।
  3. एंट्री को ट्रेसेबिलिटी के लिए सत्र (reference_session_id) और रिकॉर्ड (reference_object_uuid) से लिंक करता है
सिस्टम की चेहरा, दस्तावेज़, फ़ोन और ईमेल ब्लॉकलिस्ट पर, रिकॉर्ड को ब्लॉकलिस्टेड भी चिह्नित किया जाता है, ताकि उससे मेल खाने वाले नए सत्र अस्वीकार हों। किसी भी अन्य एंट्री प्रकार के लिए, value भी भेजें। 400 लौटता है अगर सत्र नहीं मिलता या उसमें अनुरोधित एंट्री प्रकार का डेटा नहीं है।

दस्तावेज़ कैप्चर सेल्फ़ी से चेहरे

जब उपयोगकर्ता अपने दस्तावेज़ की फ़ोटो खींच रहा होता है, तब फ्रंट कैमरा उसकी सेल्फ़ी ले सकता है (पहचान सत्यापन रिपोर्ट की front_image_camera_front और back_image_camera_front इमेज)। वह चेहरा लाइवनेस वाले चेहरे के साथ-साथ चेहरा ब्लॉकलिस्ट में भी जोड़ा जा सकता है: जो इमेज चाहिए उसके साथ face_image_source पास करें।
  • एंट्री केवल सिस्टम की चेहरा ब्लॉकलिस्ट में बनती है, और value खाली छोड़ना होगा: Didit सत्र की सेल्फ़ी से चेहरा लेता है।
  • सेल्फ़ी में एक साफ़ चेहरा होना चाहिए। अगर न हो, तो अनुरोध 400 लौटाता है और कुछ नहीं जोड़ा जाता।
  • हर सेल्फ़ी एक बार ही जोड़ी जा सकती है। एंट्री का metadata.face_image_source और metadata.reference_node_id बताते हैं कि वह किस सेल्फ़ी से आई है।
  • एक से अधिक पहचान सत्यापन चरण वाले वर्कफ़्लो में, reference_node_id वह चरण चुनता है जिसकी सेल्फ़ी इस्तेमाल हो। डिफ़ॉल्ट रूप से Didit वह सबसे हाल का पहचान सत्यापन इस्तेमाल करता है जिसमें वह सेल्फ़ी हो।
  • इसके बाद चेहरे की जाँच किसी भी ब्लॉकलिस्टेड चेहरे की तरह होती है: हर नए सत्र की लाइवनेस सेल्फ़ी से, और हर नई दस्तावेज़-कैप्चर सेल्फ़ी से (देखें FRONT_CAMERA_FACE_IN_BLOCKLIST)।
  • एंट्री हटाने पर चेहरा ब्लॉकलिस्ट से हट जाता है, और नए सत्रों से मेल खाना बंद कर देता है।

एक ही प्रकार के कई रिकॉर्ड वाले सत्र

एक सत्र में किसी प्रकार के एक से अधिक रिकॉर्ड हो सकते हैं, जैसे मल्टी-स्टेप वर्कफ़्लो से दो फ़ोन नंबर। Didit हमेशा सबसे हाल का रिकॉर्ड पढ़ता है। अगर आप reference_session_id के साथ value भी भेजते हैं, तो एंट्री आपका value संग्रहीत करती है, पर वह फिर भी उसी सबसे हाल के रिकॉर्ड से लिंक रहती है, और सिस्टम ब्लॉकलिस्ट पर वही रिकॉर्ड चिह्नित होता है। किसी पिछले रिकॉर्ड का मान सूची में डालने के लिए, उसे केवल value से जोड़ें, reference_session_id के बिना:

लेन-देन, उपयोगकर्ताओं और व्यवसायों का संदर्भ

जब किसी लेन-देन या वेंडर उपयोगकर्ता/व्यवसाय का डेटा ब्लॉकलिस्ट करते हैं, तो इकाई का UUID reference_object_uuid के रूप में दें और metadata में स्रोत प्रकार बताएँ:
इससे आप ब्लॉकलिस्ट एंट्री से कंसोल में मूल लेन-देन, उपयोगकर्ता या व्यवसाय तक पहुँच सकते हैं। Didit आपकी metadata की कुंजियाँ संग्रहीत करता है, सिवाय reference_image_url और front_image_url के, जिन्हें केवल Didit सेट करता है। सत्र से पढ़ी गई एंट्री के लिए, Didit अपनी कुंजियाँ आपकी कुंजियों में जोड़ता है, और जब दोनों में टकराव हो तो उसकी कुंजियाँ ही प्राथमिकता पाती हैं। सिस्टम की उपयोगकर्ता और व्यवसाय ब्लॉकलिस्ट पर, Didit मेल खाने वाले उपयोगकर्ताओं या व्यवसायों को भी BLOCKED सेट करता है: वे जिनका vendor_data, value के बराबर है, या जिनका didit_internal_id, reference_object_uuid के बराबर है। देखें उपयोगकर्ता ब्लॉकलिस्ट और व्यवसाय ब्लॉकलिस्ट।

प्राधिकरण

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>
आवश्यक

जिस सूची में जोड़ना है उसका UUID। ऐसे चेहरे के लिए जो आपके पास केवल एक छवि के रूप में है, इसके बजाय Upload a face to a list का उपयोग करें।

बॉडी

application/json

value, reference_session_id, या दोनों भेजें। कौन से फ़ील्ड लागू होते हैं यह सूची के entry_type पर निर्भर करता है।

value
string

सूचीबद्ध करने योग्य मान, जिसे सूची के entry_type के विरुद्ध मान्य किया गया है: email एक मान्य ईमेल पता; phone एक मान्य अंतर्राष्ट्रीय नंबर, जो E.164 में संग्रहीत है; ip_address एक IP पता या CIDR रेंज (उदाहरण के लिए 10.0.0.0/8); device_fingerprint अक्षरों, अंकों, -, _, : और . में से कम से कम 8 वर्ण (एक ब्लॉकलिस्ट उस फ़िंगरप्रिंट को अस्वीकार कर देती है जिसे कई अलग-अलग डिवाइसों ने रिपोर्ट किया है); country एक ISO 3166-1 alpha-2 या alpha-3 कोड, जो alpha-3 के रूप में संग्रहीत है; user और business vendor_data; कोई अन्य प्रकार एक गैर-रिक्त स्ट्रिंग। फ़ोन नंबरों और देश कोडों को छोड़कर लोअरकेस में संग्रहीत किया जाता है, और एक सूची प्रत्येक मान को एक बार रखती है (केस-असंवेदनशील)। जब तक reference_session_id नहीं भेजा जाता तब तक आवश्यक है; दस्तावेज़-कैप्चर face_image_source के साथ इसे खाली छोड़ दिया जाना चाहिए।

reference_session_id
string<uuid>

आपके एप्लिकेशन का एक व्यक्ति या व्यवसाय सत्यापन सत्र जिससे मान लिया जाना है। Didit सूची के प्रविष्टि प्रकार (face, document, phone, email, ip_address या device_fingerprint) से संबंधित सत्र के सबसे हालिया रिकॉर्ड को पढ़ता है, प्रविष्टि को सत्र और उस रिकॉर्ड से लिंक करता है, और दस्तावेज़ों के लिए display_label और metadata भरता है। device_fingerprint ब्लॉकलिस्ट के लिए, ऐसा सत्र जिसमें केवल डिवाइस-क्लास फ़िंगरप्रिंट है, या जो एक से अधिक डिवाइस पर पूरा किया गया था, अस्वीकार कर दिया जाता है: सटीक फ़िंगरप्रिंट को value के रूप में भेजें। अन्य प्रविष्टि प्रकारों के लिए, या जब सत्र में ऐसा कोई रिकॉर्ड न हो, तो value भी भेजें; तब आपका value संग्रहीत किया जाता है और प्रविष्टि अभी भी सत्र से लिंक रहती है।

reference_object_uuid
string<uuid>

उस रिकॉर्ड का UUID जिसके लिए प्रविष्टि है, जब यह किसी सत्र से नहीं आती है: लेन-देन का UUID, या किसी उपयोगकर्ता या व्यवसाय का didit_internal_id। इसे metadata.reference_type के साथ जोड़ें। जब reference_session_id कोई रिकॉर्ड प्रदान करता है, तो इसे सत्र के रिकॉर्ड से बदल दिया जाता है।

face_image_source
enum<string>
डिफ़ॉल्ट:liveness

reference_session_id वाली फ़ेस सूचियाँ: सत्र की किन छवियों से चेहरा लिया गया है। liveness (डिफ़ॉल्ट) लाइवनेस सेल्फ़ी है। front_image_camera_front और back_image_camera_front वे सेल्फ़ी हैं जो सामने वाले कैमरे ने तब ली थीं जब उपयोगकर्ता ने अपने दस्तावेज़ के आगे या पीछे के हिस्से की तस्वीर खींची थी: इन्हें केवल सिस्टम फ़ेस ब्लॉकलिस्ट पर स्वीकार किया जाता है, reference_session_id और एक खाली value के साथ। प्रत्येक सेल्फ़ी को एक बार जोड़ा जा सकता है और इसमें एक स्पष्ट चेहरा दिखना चाहिए।

उपलब्ध विकल्प:
liveness,
front_image_camera_front,
back_image_camera_front
reference_node_id
string | null

दस्तावेज़-कैप्चर face_image_source के साथ: पहचान सत्यापन नोड जिसकी सेल्फ़ी का उपयोग किया जाना है, एक से अधिक पहचान सत्यापन नोड वाले वर्कफ़्लो के लिए। डिफ़ॉल्ट रूप से सबसे हालिया पहचान सत्यापन जिसमें वह छवि है। liveness के साथ अस्वीकृत।

Maximum string length: 100
display_label
string

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

Maximum string length: 512
comment
string

मुक्त-पाठ नोट, जैसे सूचीबद्ध करने का कारण।

metadata
object

प्रविष्टि के साथ संग्रहीत और संग्रहीत रूप में ही लौटाया गया फ़्री-फ़ॉर्म JSON। reference_type और reference_id का उपयोग करें ताकि कंसोल वापस स्रोत से लिंक हो सके। reference_image_url और front_image_url केवल Didit द्वारा सेट किए जाते हैं और यदि आप उन्हें भेजते हैं तो उन्हें छोड़ दिया जाता है। किसी सत्र से पढ़ी गई प्रविष्टि के लिए, Didit की कुंजियों को आपकी कुंजियों के साथ मर्ज कर दिया जाता है।

प्रतिक्रिया

एंट्री बनाई गई थी।

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

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