मुख्य सामग्री पर जाएं
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।

बॉडी

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

प्राप्तकर्ता का ईमेल पता। विकृत पते 400 लौटाते हैं; सिंटैक्स की दृष्टि से मान्य पते जो मेल प्राप्त नहीं कर सकते (विफल DNS/MX सत्यापन) status: "Undeliverable" के साथ 200 लौटाते हैं।

उदाहरण:

"alice@example.com"

options
object

OTP प्रारूप, स्थानीयकरण और ब्रांडिंग विकल्प। सभी फ़ील्ड वैकल्पिक हैं।

signals
object

अंतिम उपयोगकर्ता के बारे में वैकल्पिक डिवाइस और नेटवर्क सिग्नल, जो धोखाधड़ी-रोधी परत को अग्रेषित किए जाते हैं ताकि दुरुपयोगी या स्वचालित ट्रैफ़िक का बेहतर पता लगाया जा सके। सभी फ़ील्ड वैकल्पिक हैं।

vendor_data
string

वैकल्पिक कॉलर-नियंत्रित पहचानकर्ता (आपकी आंतरिक उपयोगकर्ता id, एक ईमेल, एक UUID, आदि) जो सत्र में सुरक्षित रहता है और भेजने के रिस्पॉन्स, मिलान जांच रिस्पॉन्स, webhook और Business Console में वापस लौटाया जाता है। Didit के request_id को अपने उपयोगकर्ता रिकॉर्ड के साथ सहसंबंधित करने के लिए इसका उपयोग करें।

metadata
object | null

वैकल्पिक फ़्री-फ़ॉर्म JSON ऑब्जेक्ट जो सत्र पर बना रहता है और सेंड रिस्पॉन्स, मिलान जांच रिस्पॉन्स, webhooks और Business Console में वापस प्रदर्शित होता है।

प्रतिक्रिया

भेजने की पुष्टि की गई। status की जाँच करें: Success और Retry का अर्थ है कि एक कोड रास्ते में है; Undeliverable का अर्थ है कि पता मेल प्राप्त नहीं कर सकता है और सत्यापन पहले ही Declined के रूप में अंतिम रूप ले चुका है। request_id संग्रहीत सत्र आईडी है (Retry पर वही आईडी)।

request_id
string<uuid>

सत्यापन का सत्र id। Retry भेजने पर मूल भेजने के समान request_id लौटता है। यह id Business Console में दिखाई देता है, फ़ाइनलाइज़ किए गए POST /v3/email/check/ द्वारा फिर से लौटाया जाता है, और इसे GET /v3/session/{sessionId}/decision/ पर पास किया जा सकता है।

status
enum<string>

Success — OTP को एक नए सत्यापन पर ईमेल किया गया (बिल किया गया)। Retry — पिछले प्रेषण द्वारा बनाए गए लंबित सत्यापन के लिए नया OTP ईमेल किया गया (निःशुल्क)। Undeliverable — पता डिलीवरी सत्यापन में विफल रहा या संदेश नहीं भेजा जा सका; सत्यापन को तुरंत Declined के रूप में फ़ाइनलाइज़ कर दिया जाता है और कुछ भी बिल नहीं किया जाता है।

उपलब्ध विकल्प:
Success,
Retry,
Undeliverable
reason
enum<string> | null

status के Undeliverable होने पर email_can_not_be_delivered; अन्यथा null।

उपलब्ध विकल्प:
email_can_not_be_delivered,
null
vendor_data
string | null

सत्र पर संग्रहीत vendor_data का इको (पहली बार भेजे गए डेटा से)।

metadata
object | null

सत्र पर संग्रहीत metadata का इको (पहली बार भेजे गए डेटा से)।

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