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

इंटेलिजेंस ऐड-ऑन

ईमेल पते पर इंटेलिजेंस भी चलाने के लिए enable_enrichment को true पर सेट करें। इससे आपको एक जोखिम स्कोर और उसका डेटा उल्लंघन इतिहास मिलेगा। यह ऐड-ऑन जाँच की कीमत के अलावा, सूचीबद्ध कीमत के अनुसार प्रति अनुरोध $0.05 पर बिल किया जाता है। जब आपका बैलेंस इसे कवर नहीं कर पाता, तो अनुरोध 403 लौटाता है। तीन फ़ील्ड तय करते हैं कि सिग्नल क्या करेंगे। इनमें से हर एक NO_ACTION (डिफ़ॉल्ट) या DECLINE हो सकता है, और हर एक तभी लागू होता है जब enable_enrichment true हो। NO_ACTION के साथ भी सिग्नल email.email_intelligence में लौटाया जाता है, ताकि आप अपना नियम खुद लागू कर सकें।

प्राधिकरण

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।

बॉडी

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

वही ईमेल पता जो संबंधित POST /v3/email/send/ कॉल में उपयोग किया गया था। यह चेक को सेंड से लिंक करता है।

उदाहरण:

"alice@example.com"

code
string
आवश्यक

अंतिम उपयोगकर्ता को प्राप्त OTP: 4–8 अंक, या 4–8 अक्षर/अंक जब भेजते समय alphanumeric_code: true का उपयोग किया गया था। तुलना केस-असंवेदनशील है।

Maximum string length: 10
उदाहरण:

"123456"

duplicated_email_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

आपके एप्लिकेशन के किसी भिन्न उपयोगकर्ता (भिन्न vendor_data) द्वारा समान पते का पहले ही उपयोग और स्वीकृत किए जाने पर क्या कार्रवाई की जाए (केवल पहले स्वीकृत सत्यापन ही गिने जाते हैं)। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION जोखिम को email.warnings में रिकॉर्ड करता है और email.matches को भरता है।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
breached_email_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब पता ज्ञात डेटा उल्लंघनों में दिखाई देता है (email.is_breached) तो क्या कार्रवाई करें। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION जोखिम को email.warnings में रिकॉर्ड करता है।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
disposable_email_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

डोमेन के डिस्पोज़ेबल/अस्थायी-मेल प्रदाता (email.is_disposable) से संबंधित होने पर क्या कार्रवाई की जाए। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION जोखिम को email.warnings में रिकॉर्ड करता है।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
enable_enrichment
boolean
डिफ़ॉल्ट:false

जब true होता है, तो पते पर ईमेल इंटेलिजेंस भी चलाएं: एक जोखिम स्कोर और इसका ब्रीच इतिहास। इस endpoint की अपनी कीमत के अतिरिक्त प्रति अनुरोध एक email_intelligence_api यूनिट ($0.05 सूची मूल्य पर) के रूप में बिल किया जाता है। जब आपका बैलेंस इसे कवर नहीं कर पाता है, तो अनुरोध 403 लौटाता है।

उदाहरण:

false

email_intelligence_score_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब ईमेल इंटेलिजेंस जोखिम स्कोर थ्रेशोल्ड से अधिक हो, तब की जाने वाली कार्रवाई। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION अस्वीकार किए बिना सिग्नल रिकॉर्ड करता है। केवल तभी प्रभावी होता है जब enable_enrichment का मान true हो।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
recent_email_breach_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

कार्रवाई जब पता हाल ही में ज्ञात डेटा ब्रीच में दिखाई देता है। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION अस्वीकार किए बिना सिग्नल रिकॉर्ड करता है। केवल तब प्रभावी होता है जब enable_enrichment का मान true हो।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
frequent_email_breach_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

कार्रवाई जब पता कई ज्ञात डेटा ब्रीच में दिखाई देता है। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION अस्वीकार किए बिना सिग्नल रिकॉर्ड करता है। केवल तब प्रभावी होता है जब enable_enrichment का मान true हो।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
enable_social
boolean
डिफ़ॉल्ट:false

true होने पर, पते के सोशल फ़ुटप्रिंट की भी खोज करें - ईमेल, सोशल, व्यावसायिक, ई-कॉमर्स और मनोरंजन प्लेटफ़ॉर्म जिन पर यह पंजीकृत है। इस endpoint की अपनी कीमत के अतिरिक्त प्रति अनुरोध एक email_social इकाई के रूप में बिल किया जाता है।

उदाहरण:

true

email_no_social_presence_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब सोशल फ़ुटप्रिंट जाँच में पता चलता है कि पता इसके द्वारा कवर किए गए किसी भी प्लेटफ़ॉर्म पर पंजीकृत नहीं है, तब की जाने वाली कार्रवाई। इस endpoint पर केवल NO_ACTION और DECLINE स्वीकार किए जाते हैं; REVIEW इसी नाम की वर्कफ़्लो कॉन्फ़िगरेशन कुंजी पर उपलब्ध है।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE

प्रतिक्रिया

जांच पूरी हुई — गलत कोड और छूटे हुए सत्यापन भी 200 लौटाते हैं; HTTP कोड नहीं, status का निरीक्षण करें। email केवल अंतिम परिणामों (Approved/Declined) पर पॉप्युलेट होता है, Failed पर null, और Expired or Not Found पर अनुपस्थित होता है।

request_id
string<uuid>

Approved/Declined पर: मिलान किए गए सत्यापन की सत्र id — POST /v3/email/send/ द्वारा लौटाए गए request_id के समान। Failed और Expired or Not Found पर: एक यादृच्छिक वन-ऑफ़ UUID जिसे बाद में देखा नहीं जा सकता।

status
enum<string>

Approved — सही कोड, अस्वीकृति का कोई जोखिम नहीं। Declined — अंतिम: अस्वीकृति का कोई जोखिम मेल खा गया या प्रयास सीमा (3) समाप्त हो गई। Failed — गलत कोड, प्रयास शेष हैं। Expired or Not Found — पिछले 5 मिनट में इस पते के लिए कोई लंबित सत्यापन नहीं।

उपलब्ध विकल्प:
Approved,
Declined,
Failed,
Expired or Not Found
message
string

गलत कोड के बाद शेष प्रयासों की संख्या सहित परिणाम का मानव-पठनीय स्पष्टीकरण।

email
object | null

पूर्ण ईमेल रिपोर्ट। केवल अंतिम परिणामों (Approved/Declined) पर मौजूद (null नहीं); Failed पर null और Expired or Not Found पर अनुपस्थित।

vendor_data
string | null

मिलान किए गए सत्यापन के सत्र का vendor_data। Expired or Not Found पर null।

metadata
object | null

मेल खाने वाले सत्यापन के सत्र का metadata। Expired or Not Found पर null।

created_at
string<date-time>

इस जांच के रिस्पॉन्स का टाइमस्टैम्प।

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