मुख्य सामग्री पर जाएं
POST
Python
पूर्वावलोकन करने से सत्र नहीं बदलता और कोई ईमेल नहीं भेजा जाता। रिस्पॉन्स की समीक्षा करने के बाद Update Session Status से पुष्टि करें और लौटाए गए preview_token को email_preview_token के रूप में पास करें। रसीद 15 मिनट बाद समय-सीमा समाप्त हो जाती है। बदली हुई या समय-सीमा समाप्त रसीद होने पर सत्र बदलने या ईमेल भेजने से पहले 409 लौटता है। टकराव होने पर नया पूर्वावलोकन बनाएँ। मौजूदा API इंटीग्रेशन रसीद छोड़ सकते हैं; पूर्वावलोकन की पुष्टि करते समय कंसोल उसे उपलब्ध कराता है। भेजने वाला और ब्रांडिंग आपके मौजूदा व्हाइट लेबल कॉन्फ़िगरेशन के अनुसार होते हैं। संदेश की सामग्री अनुवादित सत्यापन टेम्पलेट से आती है; मनमाने विषय, संदेश के मुख्य भाग और कार्रवाई URL टेम्पलेट इनपुट के रूप में स्वीकार नहीं किए जाते।

ईमेल कौन प्राप्त करता है

email_address वैकल्पिक है। इसके बिना ईमेल व्यक्ति के अपने पते पर जाता है: वह पता जो उन्होंने फ़्लो के ईमेल सत्यापन चरण में सत्यापित किया था, या अन्यथा वह पता जो सत्र बनाते समय contact_details में दिया गया था। email_address में आप जो पता पास करते हैं, वही प्राथमिकता पाता है। recipient_source बताता है कि कौन सा पता लागू होता है:

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

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

पुनः जमा की पुष्टि करें

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

केवल बैकएंड से बार-बार पुनः जमा

जब पुनः जमा किए जाने वाले हर चरण व्यक्ति के बिना चलते हैं (AML, डेटाबेस सत्यापन या IP विश्लेषण), तब किसी सत्र को उनके लिए केवल हर 30 सेकंड में एक बार पुनः जमा किया जा सकता है। उस अवधि के भीतर पूर्वावलोकन 429 लौटाता है, जैसा Update Session Status भी लौटाता, और प्रतीक्षा का समय Retry-After हेडर में होता है।

संबंधित

  • Update Session Status: पुनः जमा की पुष्टि करें।
  • Preview Decision Email: इसके बजाय स्वीकृत या अस्वीकृत ईमेल का पूर्वावलोकन करें।
  • व्हाइट लेबल: ईमेल में उपयोग किया जाने वाला भेजने वाला और ब्रांडिंग।

प्राधिकरण

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 स्वीकार करता है — सेवा दोनों सत्र प्रकारों में ID को रिज़ॉल्व करती है।

उदाहरण:

"11111111-2222-3333-4444-555555555555"

बॉडी

application/json
nodes_to_resubmit
object[]

पुनः सबमिशन के समान सत्यापन, चयन और वर्कफ़्लो क्रम का उपयोग करते हुए पूर्वावलोकन के चरण। पुनः सबमिशन की आवश्यकता वाले रिकॉर्ड किए गए प्रयासों को ऑटो-सेलेक्ट करने के लिए इसे छोड़ दें।

email_address
string<email>

वैकल्पिक। व्यक्ति के अपने पते के बजाय इस पते पर ईमेल भेजें। इसके बिना, प्राप्तकर्ता वह पता होता है जिसे व्यक्ति ने फ़्लो में सत्यापित किया था, अन्यथा contact_details में दिया गया पता होता है। इस कॉल द्वारा कोई ईमेल नहीं भेजा जाता है।

उदाहरण:

"user@example.com"

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

सूचना ईमेल के लिए भाषा। स्कीमा स्तर पर किसी भी स्ट्रिंग को स्वीकार करता है; असमर्थित कोड बिना किसी सूचना के अंग्रेज़ी (en) पर फ़ालबैक हो जाते हैं।

उदाहरण:

"en"

प्रतिक्रिया

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

recipient
string
आवश्यक

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

उदाहरण:

"person@example.com"

recipient_source
enum<string>
आवश्यक

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

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

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

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

उदाहरण:

"Action Required: Complete your verification in Example App"

html
string
आवश्यक

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

उदाहरण:

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

text
string
आवश्यक

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

उदाहरण:

"Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123"

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। no_user_action: प्रत्येक चयनित चरण व्यक्ति के बिना चलता है, इसलिए पुनः सबमिशन अपने आप समाप्त हो जाता है और कोई ईमेल नहीं जाता है। no_recipient: व्यक्ति के लिए कोई पता ज्ञात नहीं है और आपने कोई पता पास नहीं किया है। sandbox: एक सैंडबॉक्स सत्र जिसके प्राप्तकर्ता ने सैंडबॉक्स ईमेल डिलीवरी का विकल्प नहीं चुना है, इसलिए भेजना केवल सिम्युलेट किया जाता है।

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

null

nodes_to_resubmit
object[]
आवश्यक
requires_user_action
boolean
आवश्यक

क्या कम से कम एक चयनित जांच के लिए उपयोगकर्ता इंटरैक्शन की आवश्यकता होती है। यह अंतिम वर्कफ़्लो परिणाम का पूर्वानुमान नहीं लगाता है।

preview_token
string
आवश्यक

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

उदाहरण:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

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