मुख्य सामग्री पर जाएं
POST
curl
पूर्वावलोकन से कुछ नहीं बदलता और कोई ईमेल नहीं भेजा जाता। जब आप सत्र को send_email: true के साथ Approved या Declined पर सेट करते हैं, तो प्रतिक्रिया में वही ईमेल दिखता है जैसा व्यक्ति उसे प्राप्त करता है। यह यह भी बताती है कि ईमेल किसे मिलेगा, वह किसकी ओर से आएगा, और पुष्टि करने पर ईमेल भेजा जाएगा या नहीं।

किसे ईमेल मिलता है

ईमेल व्यक्ति के अपने पते पर जाता है: वह पता जिसे उसने वर्कफ़्लो के ईमेल सत्यापन चरण में सत्यापित किया था, या यदि वह नहीं है, तो सत्र बनाते समय contact_details में दिया गया पता। recipient_source बताता है कि कौन सा लागू होता है (email_verification या contact_details)। यदि सत्र में व्यक्ति के लिए कोई पता नहीं है, तो recipient, recipient_source और preview_token खाली स्ट्रिंग होते हैं और कोई ईमेल नहीं भेजा जा सकता। जब आपका व्हाइट-लेबल कॉन्फ़िगरेशन लागू होता है (sender_kind: customer), तो ईमेल आपके एप्लिकेशन के सत्यापित प्रेषक डोमेन से जाता है। अन्यथा वह Didit के प्रेषक से जाता है (sender_kind: didit)।

ईमेल भेजा जाएगा या नहीं

will_be_sent तब true होता है जब send_email: true के साथ परिवर्तन की पुष्टि करने पर ईमेल भेजा जाता है। जब यह false होता है, तो not_sent_reason कारण बताता है:

निर्णय की पुष्टि करें

इन फ़ील्ड्स के साथ सत्र स्थिति अपडेट करें API कॉल करें: रसीद 15 मिनट बाद समाप्त हो जाती है। यदि पूर्वावलोकन के बाद प्राप्तकर्ता, भाषा, सत्र की स्थिति, प्रेषक या ईमेल बदलता है, तो अपडेट कुछ भी बदलने से पहले 409 लौटाता है। फिर से पूर्वावलोकन करें और नई रसीद के साथ पुष्टि करें।

संबंधित

प्राधिकरण

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।

पथ पैरामीटर

sessionId
string<uuid>
आवश्यक

सत्यापन सत्र का UUID। उपयोगकर्ता (KYC) और व्यवसाय (KYB) दोनों सत्र ID स्वीकार करता है।

उदाहरण:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

बॉडी

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

वह निर्णय जिसके ईमेल का आप पूर्वावलोकन करना चाहते हैं।

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

"Approved"

email_language
string
डिफ़ॉल्ट:en

ईमेल की भाषा, Update Session Status के समान डिफ़ॉल्ट। जो भाषा उपलब्ध नहीं है वह अंग्रेज़ी पर फ़ालबैक हो जाती है; रिस्पॉन्स में language बताता है कि किसका उपयोग किया गया है।

उदाहरण:

"en"

प्रतिक्रिया

केवल पूर्वावलोकन। सत्र अपरिवर्तित रहता है और कोई ईमेल नहीं भेजा जाता है।

recipient
string
आवश्यक

वह पता जिस पर ईमेल जाता है। जब व्यक्ति के लिए कोई पता ज्ञात नहीं होता है तो एक खाली स्ट्रिंग: तब कोई ईमेल नहीं भेजा जा सकता है और preview_token भी खाली होता है। पुष्टि करते समय इसे email_address के रूप में पास करें।

उदाहरण:

"person@example.com"

recipient_source
enum<string>
आवश्यक

recipient कहाँ से आता है। email_verification: वह पता जिसे व्यक्ति ने फ़्लो के ईमेल सत्यापन चरण में सत्यापित किया था। contact_details: सत्र निर्माण के समय contact_details में दिया गया पता। कोई पता न होने पर एक रिक्त स्ट्रिंग।

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

"email_verification"

sender
string
आवश्यक

वह From हेडर जिसके साथ ईमेल जाता है।

उदाहरण:

"Example App <no-reply@mail.example.com>"

sender_name
string
आवश्यक

sender का डिस्प्ले नाम वाला भाग।

उदाहरण:

"Example App"

sender_email
string<email>
आवश्यक

sender का पता वाला भाग।

उदाहरण:

"no-reply@mail.example.com"

sender_kind
enum<string>
आवश्यक

customer: ईमेल आपके एप्लिकेशन के सत्यापित प्रेषक डोमेन (व्हाइट लेबल) से जाता है। didit: यह Didit के अपने प्रेषक से जाता है।

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

"customer"

subject
string
आवश्यक

विषय पंक्ति ठीक वैसे ही जैसे भेजी गई है।

उदाहरण:

"Your verification has been approved in Example App"

html
string
आवश्यक

ईमेल का HTML ठीक उसी रूप में जैसा वह भेजा गया है, जिसमें उसका लोगो डेटा URL के रूप में एम्बेडेड है। इसे सैंडबॉक्स किए गए फ़्रेम में रेंडर करें, कभी भी सीधे अपने एप्लिकेशन DOM में नहीं।

उदाहरण:

"<!DOCTYPE html><html><body>...</body></html>"

text
string
आवश्यक

एक संक्षिप्त पूर्वावलोकन के लिए व्यक्ति के Messages थ्रेड के अनुसार ईमेल के शब्द प्लेन टेक्स्ट के रूप में (HTML वही ईमेल रहता है जो व्यक्ति को प्राप्त होता है)।

उदाहरण:

"Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part."

language
string
आवश्यक

ईमेल जिस भाषा में लिखा गया है। यदि आपके द्वारा अनुरोधित email_language उपलब्ध नहीं है, तो अंग्रेज़ी (en) का उपयोग किया जाता है।

उदाहरण:

"en"

will_be_sent
boolean
आवश्यक

क्या send_email: true के साथ परिवर्तन की पुष्टि करने पर यह ईमेल भेजा जाता है। not_sent_reason सेट होने पर false।

उदाहरण:

true

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

पुष्टि करने पर कोई ईमेल क्यों नहीं भेजा जाएगा, या भेजे जाने पर null। status_unchanged: सत्र की यह स्थिति पहले से ही है, इसलिए अपडेट से कुछ नहीं बदलता और कुछ नहीं भेजा जाता। notification_emails_disabled: सत्र contact_details.send_notification_emails: true के बिना बनाया गया था, इसलिए contact_details में दिए गए पते पर कोई निर्णय ईमेल नहीं जाता है। no_recipient: व्यक्ति के लिए कोई पता ज्ञात नहीं है। sandbox: एक सैंडबॉक्स सत्र जिसके प्राप्तकर्ता ने सैंडबॉक्स ईमेल डिलीवरी का विकल्प नहीं चुना है, इसलिए भेजना केवल सिम्युलेट किया जाता है।

उपलब्ध विकल्प:
status_unchanged,
notification_emails_disabled,
no_recipient,
sandbox,
null
उदाहरण:

null

preview_token
string
आवश्यक

इस सटीक ईमेल के लिए हस्ताक्षरित रसीद, जो 15 मिनट के लिए मान्य है। इसे Update Session Status में email_preview_token के रूप में पास करें। जब कोई प्राप्तकर्ता नहीं होता है तो यह एक खाली स्ट्रिंग होती है।

उदाहरण:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

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