> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# निर्णय ईमेल पूर्वावलोकन API: स्वीकृत और अस्वीकृत ईमेल
> Didit से स्वीकृत या अस्वीकृत ईमेल का पूर्वावलोकन करें: प्राप्तकर्ता, प्रेषक और भाषा के साथ, सत्र की स्थिति बदलने से पहले।
निर्णय ईमेल पूर्वावलोकन प्रॉम्प्ट
प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें
\
\`Preview the Approved or Declined email a Didit session sends the person, then confirm the decision so exactly that email goes out.
Endpoint:
POST https://verification.didit.me/v3/session/{session_id}/decision-email-preview/
Authentication:
x-api-key (client API key) or a user-auth token. Privilege: write:sessions. A scoped API key needs write access to decisions.
Path parameter:
\- session_id (UUID): KYC or KYB; Didit resolves it against both session types.
Request body:
\- new_status (string, required): "Approved" or "Declined".
\- email_language (string, optional, default "en"): language of the email. A language that is not offered falls back to English.
The session's current status must be one of: Approved, Declined, In Review, Kyc Expired, Abandoned, Resubmitted.
Previewing changes nothing and sends nothing.
Response (200, Cache-Control: no-store):
\- recipient: the person's own address (the one they verified in the flow, else the one in contact_details). Empty string when none is known.
\- recipient_source: "email_verification", "contact_details", or "" when there is no address.
\- sender, sender_name, sender_email: the From header and its parts.
\- sender_kind: "customer" (your verified sender domain) or "didit" (Didit's sender).
\- subject, html: the email exactly as sent. Render html in a sandboxed frame.
\- language: the language actually used.
\- will_be_sent (boolean) and not_sent_reason: null, "status_unchanged", "notification_emails_disabled", "no_recipient" or "sandbox".
\- preview_token: receipt for this exact email, valid 15 minutes. Empty when there is no recipient.
Confirm with PATCH https://verification.didit.me/v3/session/{session_id}/update-status/:
\{
"new_status": "",
"send_email": true,
"email_address": "",
"email_language": "",
"email_preview_token": ""
}
If the recipient, language, session status, sender or email changed since the preview, or the receipt is older than 15 minutes, update-status returns 409 { "detail": "This email preview changed or expired. Preview the message again before confirming." } and changes nothing. Preview again and confirm with the new receipt.
curl example:
curl -X POST https://verification.didit.me/v3/session//decision-email-preview/ \
-H "x-api-key: " \
-H "Content-Type: application/json" \
-d '{ "new_status": "Approved", "email_language": "en" }'
Failure modes:
\- 400: the session is not in an accepted status ({ "detail": "Only sessions with status ... can be updated. Current status: ..." }), or new_status is missing or invalid.
\- 401: the scoped API key has expired.
\- 403: missing credentials (a wrong, revoked or expired key gets 401), the caller lacks write:sessions, a scoped key lacks decisions write, or the session belongs to another application ({ "detail": "You do not have permission to perform this action." }).
\- 404: { "detail": "Not found." } when no session with this session_id exists.
For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`
\
यहाँ पेस्ट करें
पूर्वावलोकन से कुछ नहीं बदलता और कोई ईमेल नहीं भेजा जाता।
जब आप सत्र को `send_email: true` के साथ `Approved` या `Declined` पर सेट करते हैं, तो प्रतिक्रिया में वही ईमेल दिखता है जैसा व्यक्ति उसे प्राप्त करता है।
यह यह भी बताती है कि ईमेल किसे मिलेगा, वह किसकी ओर से आएगा, और पुष्टि करने पर ईमेल भेजा जाएगा या नहीं।## किसे ईमेल मिलता हैईमेल व्यक्ति के अपने पते पर जाता है: वह पता जिसे उसने वर्कफ़्लो के ईमेल सत्यापन चरण में सत्यापित किया था, या यदि वह नहीं है, तो सत्र बनाते समय `contact_details` में दिया गया पता।
`recipient_source` बताता है कि कौन सा लागू होता है (`email_verification` या `contact_details`)।
यदि सत्र में व्यक्ति के लिए कोई पता नहीं है, तो `recipient`, `recipient_source` और `preview_token` खाली स्ट्रिंग होते हैं और कोई ईमेल नहीं भेजा जा सकता।जब आपका [व्हाइट-लेबल कॉन्फ़िगरेशन](https://docs.didit.me/hi/console/white-label.md) लागू होता है (`sender_kind: customer`), तो ईमेल आपके एप्लिकेशन के सत्यापित प्रेषक डोमेन से जाता है। अन्यथा वह Didit के प्रेषक से जाता है (`sender_kind: didit`)।## ईमेल भेजा जाएगा या नहीं`will_be_sent` तब `true` होता है जब `send_email: true` के साथ परिवर्तन की पुष्टि करने पर ईमेल भेजा जाता है।
जब यह `false` होता है, तो `not_sent_reason` कारण बताता है:| `not_sent_reason` | इसका अर्थ |
| - | - |
| `status_unchanged` | सत्र की यह स्थिति पहले से है, इसलिए अपडेट कुछ नहीं बदलता और कोई ईमेल नहीं भेजता। |
| `notification_emails_disabled` | सत्र `contact_details.send_notification_emails: true` के बिना बनाया गया था, इसलिए `contact_details` में दिए पते पर कोई निर्णय ईमेल नहीं जाता। |
| `no_recipient` | व्यक्ति के लिए कोई पता ज्ञात नहीं है। |
| `sandbox` | सत्र एक सैंडबॉक्स सत्र है और प्राप्तकर्ता ने सैंडबॉक्स ईमेल डिलीवरी के लिए सहमति नहीं दी है, इसलिए ईमेल केवल सिमुलेट किया जाता है। देखें [ईमेल ऑप्ट-इन](https://docs.didit.me/hi/integration/sandbox-testing.md#códigos-otp-y-consentimiento-para-recibir-correos-electrónicos)। |## निर्णय की पुष्टि करेंइन फ़ील्ड्स के साथ [सत्र स्थिति अपडेट करें](https://docs.didit.me/hi/sessions-api/update-status.md) API कॉल करें:| सत्र स्थिति अपडेट करें फ़ील्ड | मान |
| - | - |
| `new_status` | वही `new_status` जिसका आपने पूर्वावलोकन किया था |
| `send_email` | `true` |
| `email_address` | पूर्वावलोकन से `recipient` |
| `email_language` | पूर्वावलोकन से `language` |
| `email_preview_token` | पूर्वावलोकन से `preview_token` |रसीद 15 मिनट बाद समाप्त हो जाती है।
यदि पूर्वावलोकन के बाद प्राप्तकर्ता, भाषा, सत्र की स्थिति, प्रेषक या ईमेल बदलता है, तो अपडेट कुछ भी बदलने से पहले `409` लौटाता है।
फिर से पूर्वावलोकन करें और नई रसीद के साथ पुष्टि करें।## संबंधित- [सत्र स्थिति अपडेट करें](https://docs.didit.me/hi/sessions-api/update-status.md): सत्र को स्वीकृत या अस्वीकृत करें और ईमेल भेजें।
- [पुनः सबमिशन ईमेल का पूर्वावलोकन करें](https://docs.didit.me/hi/sessions-api/preview-resubmission.md): इसके बजाय पुनः सबमिशन के लिए ईमेल का पूर्वावलोकन करें।
- [व्हाइट लेबल](https://docs.didit.me/hi/console/white-label.md): ईमेल द्वारा उपयोग किया जाने वाला प्रेषक और ब्रांडिंग।
## OpenAPI
````yaml hi/openapi-25.json POST /v3/session/{sessionId}/decision-email-preview/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: पहचान सत्यापन API। x-api-key हेडर के साथ प्रमाणीकृत करें।
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/session/{sessionId}/decision-email-preview/:
post:
tags:
- Sessions
summary: सत्र के निर्णय ईमेल का पूर्वावलोकन करें
description: >-
जब आप `send_email: true` के साथ सत्र को `Approved` या `Declined` पर सेट
करते हैं, तब सत्र में कोई बदलाव किए बिना और कुछ भी भेजे बिना उस व्यक्ति
को प्राप्त होने वाले ईमेल को रेंडर करें। रिस्पॉन्स विषय और HTML को ठीक
वैसे ही दिखाता है जैसे वे भेजे जाते हैं, साथ ही प्राप्तकर्ता, प्रेषक,
भाषा, और क्या परिवर्तन की पुष्टि करने पर वास्तव में ईमेल भेजा जाएगा
(`will_be_sent`, `not_sent_reason`)।
प्राप्तकर्ता व्यक्ति का अपना पता होता है: वह पता जिसे उन्होंने फ़्लो के
ईमेल सत्यापन चरण में सत्यापित किया था, अन्यथा वह पता जो सत्र बनाते समय
`contact_details` में दिया गया था। प्रेषक आपके एप्लिकेशन का सत्यापित
प्रेषक डोमेन होता है जब व्हाइट लेबल लागू होता है (`sender_kind:
customer`), अन्यथा Didit का प्रेषक (`sender_kind: didit`)।
आपने जो पूर्वावलोकन किया था उसे ठीक उसी रूप में भेजने के लिए, उसी
`new_status`, `send_email: true`, `email_address` को `recipient` पर सेट
करके, `email_language` को `language` पर सेट करके और
`email_preview_token` को `preview_token` पर सेट करके [Update Session
Status](/hi/sessions-api/update-status) को कॉल करें। रसीद 15 मिनट के बाद
समाप्त हो जाती है। जब पूर्वावलोकन के बाद से प्राप्तकर्ता, भाषा, सत्र
स्थिति, प्रेषक या ईमेल बदल गया हो, तो कुछ भी बदलने से पहले अपडेट `409`
लौटाता है; फिर से पूर्वावलोकन करें और नई रसीद के साथ पुष्टि करें।
`Approved`, `Declined`, `In Review`, `Kyc Expired`, `Abandoned` या
`Resubmitted` स्थिति में उपयोगकर्ता सत्यापन (KYC) और व्यवसाय सत्यापन
(KYB) सत्रों के लिए काम करता है। स्थिति की जाँच बॉडी सत्यापन से पहले
चलती है। इसके लिए `write:sessions` विशेषाधिकार की आवश्यकता होती है; एक
स्कोप्ड API कुंजी को निर्णयों के लिए राइट एक्सेस की आवश्यकता होती है।
रिस्पॉन्स `Cache-Control: no-store` का उपयोग करते हैं: उन्हें संवेदनशील
सत्यापन सामग्री के रूप में मानें।
operationId: post_v3_session_decision_email_preview
parameters:
- in: path
name: sessionId
required: true
description: >-
सत्यापन सत्र का UUID। उपयोगकर्ता (KYC) और व्यवसाय (KYB) दोनों सत्र
ID स्वीकार करता है।
schema:
type: string
format: uuid
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- new_status
properties:
new_status:
type: string
enum:
- Approved
- Declined
description: वह निर्णय जिसके ईमेल का आप पूर्वावलोकन करना चाहते हैं।
example: Approved
email_language:
type: string
default: en
description: >-
ईमेल की भाषा, Update Session Status के समान डिफ़ॉल्ट। जो
भाषा उपलब्ध नहीं है वह अंग्रेज़ी पर फ़ालबैक हो जाती है;
रिस्पॉन्स में `language` बताता है कि किसका उपयोग किया गया
है।
example: en
examples:
Approved:
summary: अंग्रेज़ी में स्वीकृत ईमेल का पूर्वावलोकन करें
value:
new_status: Approved
Declined in Spanish:
summary: स्पैनिश में अस्वीकृत ईमेल का पूर्वावलोकन करें
value:
new_status: Declined
email_language: es
responses:
'200':
description: >-
केवल पूर्वावलोकन। सत्र अपरिवर्तित रहता है और कोई ईमेल नहीं भेजा जाता
है।
headers:
Cache-Control:
description: >-
हमेशा `no-store`: पूर्वावलोकन में सत्यापन सामग्री होती है और इसे
कैश नहीं किया जाना चाहिए।
schema:
type: string
example: no-store
content:
application/json:
schema:
type: object
required:
- recipient
- recipient_source
- sender
- sender_name
- sender_email
- sender_kind
- subject
- html
- text
- language
- will_be_sent
- not_sent_reason
- preview_token
properties:
recipient:
type: string
description: >-
वह पता जिस पर ईमेल जाता है। जब व्यक्ति के लिए कोई पता
ज्ञात नहीं होता है तो एक खाली स्ट्रिंग: तब कोई ईमेल नहीं
भेजा जा सकता है और `preview_token` भी खाली होता है। पुष्टि
करते समय इसे `email_address` के रूप में पास करें।
example: person@example.com
recipient_source:
type: string
enum:
- email_verification
- contact_details
- ''
description: >-
`recipient` कहाँ से आता है। `email_verification`: वह पता
जिसे व्यक्ति ने फ़्लो के ईमेल सत्यापन चरण में सत्यापित
किया था। `contact_details`: सत्र निर्माण के समय
`contact_details` में दिया गया पता। कोई पता न होने पर एक
रिक्त स्ट्रिंग।
example: email_verification
sender:
type: string
description: वह `From` हेडर जिसके साथ ईमेल जाता है।
example: Example App
sender_name:
type: string
description: '`sender` का डिस्प्ले नाम वाला भाग।'
example: Example App
sender_email:
type: string
format: email
description: '`sender` का पता वाला भाग।'
example: no-reply@mail.example.com
sender_kind:
type: string
enum:
- customer
- didit
description: >-
`customer`: ईमेल आपके एप्लिकेशन के सत्यापित प्रेषक डोमेन
(व्हाइट लेबल) से जाता है। `didit`: यह Didit के अपने प्रेषक
से जाता है।
example: customer
subject:
type: string
description: विषय पंक्ति ठीक वैसे ही जैसे भेजी गई है।
example: Your verification has been approved in Example App
html:
type: string
description: >-
ईमेल का HTML ठीक उसी रूप में जैसा वह भेजा गया है, जिसमें
उसका लोगो डेटा URL के रूप में एम्बेडेड है। इसे सैंडबॉक्स
किए गए फ़्रेम में रेंडर करें, कभी भी सीधे अपने एप्लिकेशन
DOM में नहीं।
example: ...
text:
type: string
description: >-
एक संक्षिप्त पूर्वावलोकन के लिए व्यक्ति के Messages थ्रेड
के अनुसार ईमेल के शब्द प्लेन टेक्स्ट के रूप में (HTML वही
ईमेल रहता है जो व्यक्ति को प्राप्त होता है)।
example: >-
Verification Approved
Your identity has been successfully verified with Acme
Pay. No further action is needed on your part.
language:
type: string
description: >-
ईमेल जिस भाषा में लिखा गया है। यदि आपके द्वारा अनुरोधित
`email_language` उपलब्ध नहीं है, तो अंग्रेज़ी (`en`) का
उपयोग किया जाता है।
example: en
will_be_sent:
type: boolean
description: >-
क्या `send_email: true` के साथ परिवर्तन की पुष्टि करने पर
यह ईमेल भेजा जाता है। `not_sent_reason` सेट होने पर
`false`।
example: true
not_sent_reason:
type: string
nullable: true
enum:
- status_unchanged
- notification_emails_disabled
- no_recipient
- sandbox
- null
description: >-
पुष्टि करने पर कोई ईमेल क्यों नहीं भेजा जाएगा, या भेजे
जाने पर `null`। `status_unchanged`: सत्र की यह स्थिति पहले
से ही है, इसलिए अपडेट से कुछ नहीं बदलता और कुछ नहीं भेजा
जाता। `notification_emails_disabled`: सत्र
`contact_details.send_notification_emails: true` के बिना
बनाया गया था, इसलिए `contact_details` में दिए गए पते पर
कोई निर्णय ईमेल नहीं जाता है। `no_recipient`: व्यक्ति के
लिए कोई पता ज्ञात नहीं है। `sandbox`: एक सैंडबॉक्स सत्र
जिसके प्राप्तकर्ता ने सैंडबॉक्स ईमेल डिलीवरी का विकल्प
नहीं चुना है, इसलिए भेजना केवल सिम्युलेट किया जाता है।
example: null
preview_token:
type: string
description: >-
इस सटीक ईमेल के लिए हस्ताक्षरित रसीद, जो 15 मिनट के लिए
मान्य है। इसे [Update Session
Status](/hi/sessions-api/update-status) में
`email_preview_token` के रूप में पास करें। जब कोई
प्राप्तकर्ता नहीं होता है तो यह एक खाली स्ट्रिंग होती है।
example: >-
eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000
examples:
Will Be Sent:
summary: >-
स्वीकृत ईमेल उस पते पर जाता है जिसे फ़्लो में सत्यापित किया
गया है
value:
recipient: person@example.com
recipient_source: email_verification
sender: Example App
sender_name: Example App
sender_email: no-reply@mail.example.com
sender_kind: customer
subject: Your verification has been approved in Example App
html: ...
language: en
will_be_sent: true
not_sent_reason: null
preview_token: >-
eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000
No Recipient:
summary: व्यक्ति के लिए कोई पता ज्ञात नहीं है
value:
recipient: ''
recipient_source: ''
sender: Example App
sender_name: Example App
sender_email: no-reply@mail.example.com
sender_kind: customer
subject: Your verification has been declined in Example App
html: ...
language: en
will_be_sent: false
not_sent_reason: no_recipient
preview_token: ''
'400':
description: >-
सत्र उस स्थिति में नहीं है जिसे यह endpoint स्वीकार करता है
(`{"detail": ...}`), या बॉडी अमान्य है (`{"":
[""]}`).
content:
application/json:
examples:
Wrong Current Status:
summary: सत्र ऐसी स्थिति में नहीं है जिसे यह endpoint स्वीकार करता है
value:
detail: >-
Only sessions with status Approved, Declined, In Review,
Kyc Expired, Abandoned, Resubmitted can be updated.
Current status: In Progress
Invalid new_status:
summary: new_status Approved या Declined नहीं है
value:
new_status:
- '"Resubmitted" is not a valid choice.'
Missing new_status:
summary: आवश्यक फ़ील्ड छोड़ा गया
value:
new_status:
- This field is required.
'401':
description: स्कोप्ड API कुंजी की समय-सीमा समाप्त हो गई है।
content:
application/json:
examples:
Expired API Key:
summary: अपनी समाप्ति तिथि पार कर चुकी स्कोप्ड API कुंजी
value:
detail: This API key has expired.
'403':
description: >-
क्रेडेंशियल मौजूद नहीं हैं, कॉलर के पास `write:sessions` विशेषाधिकार
नहीं है, स्कोप्ड API कुंजी के पास इस endpoint के लिए आवश्यक एक्सेस
नहीं है, या ऐसा `session_id` है जो किसी अन्य एप्लिकेशन का है।
content:
application/json:
examples:
Invalid Credentials:
summary: अनुपलब्ध या अमान्य x-api-key
value:
detail: >-
Authentication credentials were not provided or are
invalid.
Missing Privilege:
summary: कॉलर के पास write:sessions की कमी है
value:
detail: You do not have permission to perform this action.
Scoped Key Without Access:
summary: इस एक्सेस के बिना स्कोप्ड API कुंजी
value:
detail: This API key has no write access to decisions.
'404':
description: इस `session_id` वाला कोई KYC या KYB सत्र मौजूद नहीं है।
content:
application/json:
examples:
Not Found:
summary: अज्ञात session_id
value:
detail: Not found.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: |-
curl -X POST \
https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/decision-email-preview/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"new_status": "Approved", "email_language": "en"}'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.preview_decision_email(
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
new_status="Approved",
)
print(result)
- lang: javascript
label: Node.js
source: >-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await
didit.sessions.previewDecisionEmail("3fa85f64-5717-4562-b3fc-2c963f66afa6",
{
new_status: "Approved",
});
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.PreviewDecisionEmail(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.SessionsPreviewDecisionEmailParams{\n\tNewStatus: \"Approved\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
import me.didit.Didit;
import me.didit.types.SessionsPreviewDecisionEmailParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result =
client.sessions().previewDecisionEmail("3fa85f64-5717-4562-b3fc-2c963f66afa6",
SessionsPreviewDecisionEmailParams.builder()
.newStatus(SessionsPreviewDecisionEmailParams.NewStatus.of("Approved"))
.build());
System.out.println(result);
- lang: php
label: PHP
source: >-
sessions->previewDecisionEmail('3fa85f64-5717-4562-b3fc-2c963f66afa6',
[
'new_status' => 'Approved',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.preview_decision_email(
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
new_status: "Approved"
)
puts result.to_h
- lang: csharp
label: .NET
source: >-
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await
client.Sessions.PreviewDecisionEmailAsync("3fa85f64-5717-4562-b3fc-2c963f66afa6",
new SessionsPreviewDecisionEmailParams
{
NewStatus = "Approved",
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
आपकी एप्लिकेशन की 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।
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.