الانتقال إلى المحتوى الرئيسي
POST
Python
المعاينة لا تغيّر الجلسة ولا ترسل أي بريد إلكتروني. بعد مراجعة الاستجابة، أكّد الطلب عبر تحديث حالة الجلسة ومرّر القيمة preview_token المُعادة بوصفها email_preview_token. تنتهي صلاحية الإيصال بعد 15 دقيقة. يُرجع الإيصال المتغيّر أو منتهي الصلاحية الرمز 409 قبل تغيير الجلسة أو إرسال أي بريد إلكتروني. أنشئ معاينة جديدة بعد حدوث التعارض. قد تُغفل تكاملات API الحالية الإيصال، إذ تتولى وحدة التحكم توفيره عند تأكيد المعاينة. يتبع المُرسِل والعلامة التجارية إعدادات العلامة البيضاء الحالية لديك. يأتي محتوى الرسالة من قالب التحقق المترجم، ولا يُقبل أي موضوع أو نص رسالة أو رابط إجراء بوصفه مدخلاً للقالب.

من يستلم البريد الإلكتروني

الحقل email_address اختياري. في حال غيابه، يُرسل البريد إلى عنوان الشخص نفسه: العنوان الذي تحقق منه في خطوة التحقق من البريد الإلكتروني ضمن سير العمل، وإلا فالعنوان الوارد في contact_details عند إنشاء الجلسة. العنوان الذي تمرّره في email_address له الأولوية. يوضح لك recipient_source العنوان المعتمد:

هل يُرسل البريد الإلكتروني

يكون will_be_sent بقيمة true عندما يرسل تأكيد إعادة التقديم بقيمة send_email: true البريد الإلكتروني. وعندما تكون القيمة false، يوضح not_sent_reason السبب:

تأكيد إعادة التقديم

استدعِ تحديث حالة الجلسة باستخدام الحقول التالية: تمثّل language في الاستجابة لغة كتابة البريد الإلكتروني: تكون الإنجليزية إذا لم تتوفر اللغة التي طلبتها.

عمليات إعادة التقديم المتكررة التي تتم في الخلفية فقط

عندما تُنفَّذ كل خطوات إعادة التقديم دون مشاركة الشخص (AML أو التحقق من قواعد البيانات أو تحليل عنوان IP)، لا يمكن إعادة تقديم الجلسة لصالحه إلا مرة واحدة كل 30 ثانية. خلال تلك الفترة تُرجع المعاينة الرمز 429، كما يفعل تحديث حالة الجلسة، مع مدة الانتظار في الرأس Retry-After.

ذات صلة

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

معلمات المسار

sessionId
string<uuid>
مطلوب

معرّف UUID لجلسة التحقق المطلوب تحديثها. يقبل معرّفات جلسات المستخدمين (KYC) والشركات (KYB) — يطابق الخادم المعرّف عبر كلا نوعي الجلسات.

مثال:

"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 الخاص بالبريد الإلكتروني تماماً كما يُرسل، مع تضمين شعاره كـ data URL. اعرضه داخل إطار معزول، وتجنب تماماً عرضه مباشرة في DOM الخاص بتطبيقك.

مثال:

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

text
string
مطلوب

كلمات البريد الإلكتروني كنص عادي، كما يحتفظ بها تسلسل رسائل الشخص، للحصول على معاينة موجزة (يظل كود 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
مطلوب

اللغة المكتوب بها البريد الإلكتروني. تكون الإنجليزية (en) عندما لا تتوفر email_language التي طلبتها.

مثال:

"en"

will_be_sent
boolean
مطلوب

ما إذا كان تأكيد التغيير باستخدام send_email: true يرسل هذا البريد الإلكتروني. false عندما يكون not_sent_reason معيناً.

مثال:

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 دقيقة. مرّره كـ email_preview_token إلى تحديث حالة الجلسة. سلسلة فارغة في حال عدم وجود مستلم.

مثال:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

آخر تعديل في ٧ نوفمبر ٢٠٢٦