الانتقال إلى المحتوى الرئيسي
POST
curl

الإضافة الاستخباراتية

اضبط enable_enrichment على true لتشغيل استخبارات البريد الإلكتروني على العنوان أيضًا، فتحصل على درجة المخاطر وسجل تسريبات البيانات المرتبطة به. تُحتسب الإضافة بسعر $0.05 لكل طلب وفق السعر المعلن، وتُضاف إلى سعر الفحص نفسه. يُعيد الطلب الاستجابة 403 عندما لا يغطي رصيدك تكلفتها. تحدد ثلاثة حقول ما تفعله الإشارات. كل حقل منها إما NO_ACTION (وهي القيمة الافتراضية) أو DECLINE، ولا يسري أي منها إلا عندما تكون قيمة enable_enrichment هي true. مع NO_ACTION، تُعاد الإشارة في email.email_intelligence مع ذلك، لتتمكن من تطبيق قاعدتك الخاصة.

التفويضات

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.

الجسم

application/json
email
string<email>
مطلوب

عنوان البريد الإلكتروني نفسه المستخدم في استدعاء POST /v3/email/send/ المطابق. هذا ما يربط التحقق بعملية الإرسال.

مثال:

"alice@example.com"

code
string
مطلوب

رمز OTP الذي استلمه المستخدم النهائي: من 4 إلى 8 أرقام، أو من 4 إلى 8 أحرف/أرقام عند استخدام alphanumeric_code: true في وقت الإرسال. المقارنة لا تتأثر بحالة الأحرف.

Maximum string length: 10
مثال:

"123456"

duplicated_email_action
enum<string>
افتراضي:NO_ACTION

الإجراء المتخذ عند استخدام نفس العنوان مسبقاً وقبوله من قبل مستخدم مختلف (يتم احتساب عمليات التحقق المقبولة سابقاً فقط) (بيانات vendor_data مختلفة) لتطبيقك. يؤدي خيار DECLINE إلى تحويل status النهائي إلى Declined؛ ويسجل خيار NO_ACTION المخاطر في email.warnings ويملأ email.matches.

الخيارات المتاحة:
NO_ACTION,
DECLINE
breached_email_action
enum<string>
افتراضي:NO_ACTION

الإجراء المتبع عندما يظهر العنوان في تسريبات بيانات معروفة (email.is_breached). يحول DECLINE القيمة النهائية لـ status إلى Declined؛ ويسجل NO_ACTION الخطر في email.warnings.

الخيارات المتاحة:
NO_ACTION,
DECLINE
disposable_email_action
enum<string>
افتراضي:NO_ACTION

الإجراء المتخذ عندما ينتمي النطاق إلى موفر بريد إلكتروني مؤقت أو يمكن التخلص منه (email.is_disposable). يؤدي خيار DECLINE إلى تحويل status النهائي إلى Declined؛ ويسجل خيار NO_ACTION المخاطر في email.warnings.

الخيارات المتاحة:
NO_ACTION,
DECLINE
enable_enrichment
boolean
افتراضي:false

عندما تكون true، يتم أيضاً تشغيل استخبارات البريد الإلكتروني على العنوان: درجة المخاطر وسجل الاختراقات الخاص به. تتم الفوترة كوحدة email_intelligence_api واحدة لكل طلب ($0.05 بسعر القائمة) بالإضافة إلى سعر endpoint هذا نفسه. يُرجع الطلب 403 عندما لا يكفي رصيدك لتغطيته.

مثال:

false

email_intelligence_score_action
enum<string>
افتراضي:NO_ACTION

الإجراء عند تجاوز درجة مخاطر معلومات البريد الإلكتروني للحد المعين. القيمة DECLINE تحول الـ status النهائي إلى Declined؛ والقيمة NO_ACTION تسجل الإشارة دون رفض. يسري مفعوله فقط عندما يكون enable_enrichment مضبوطاً على true.

الخيارات المتاحة:
NO_ACTION,
DECLINE
recent_email_breach_action
enum<string>
افتراضي:NO_ACTION

الإجراء المتخذ عندما يظهر العنوان في تسريب بيانات معروف حديث. يغير DECLINE الـ status النهائي إلى Declined؛ ويسجل NO_ACTION الإشارة دون رفض. يسري مفعوله فقط عندما يكون enable_enrichment مضبوطاً على true.

الخيارات المتاحة:
NO_ACTION,
DECLINE
frequent_email_breach_action
enum<string>
افتراضي:NO_ACTION

الإجراء المتخذ عندما يظهر العنوان في العديد من تسريبات البيانات المعروفة. يغير DECLINE الـ status النهائي إلى Declined؛ ويسجل NO_ACTION الإشارة دون رفض. يسري مفعوله فقط عندما يكون enable_enrichment مضبوطاً على true.

الخيارات المتاحة:
NO_ACTION,
DECLINE
enable_social
boolean
افتراضي:false

عند التعيين على true، يتم أيضاً البحث عن الأثر الرقمي الاجتماعي للعنوان - منصات البريد الإلكتروني والمنصات الاجتماعية والمهنية والتجارة الإلكترونية والترفيه المسجل عليها. يُفوتر كوحدة email_social واحدة لكل طلب بالإضافة إلى سعر هذا الـ endpoint نفسه.

مثال:

true

email_no_social_presence_action
enum<string>
افتراضي:NO_ACTION

الإجراء عندما يجد فحص الأثر الاجتماعي أن العنوان غير مسجل على أي من المنصات التي يغطيها. يُقبل فقط NO_ACTION وDECLINE في هذا الـ endpoint؛ يتوفر REVIEW في مفتاح تهيئة سير العمل الذي يحمل نفس الاسم.

الخيارات المتاحة:
NO_ACTION,
DECLINE

الاستجابة

اكتمل التحقق — تُرجع الرموز الخاطئة وعمليات التحقق المفقودة أيضاً الرمز 200؛ تحقّق من status، وليس رمز HTTP. يتم ملء email فقط في النتائج النهائية (Approved/Declined)، ويكون null عند Failed، وغير موجود عند Expired or Not Found.

request_id
string<uuid>

عند Approved/Declined: معرّف الجلسة لعملية التحقق المتطابقة — مطابق لـ request_id المُرجع بواسطة POST /v3/email/send/. عند Failed وExpired or Not Found: معرّف UUID عشوائي لمرة واحدة لا يمكن البحث عنه لاحقاً.

status
enum<string>

Approved — رمز صحيح، دون وجود مخاطر تؤدي إلى الرفض. Declined — نهائية: تطابقت مخاطر تؤدي إلى الرفض أو استُنفد الحد المسموح به من المحاولات (3). Failed — رمز خاطئ، مع بقاء محاولات متبقية. Expired or Not Found — لا توجد عملية تحقق معلقة لهذا العنوان خلال آخر 5 دقائق.

الخيارات المتاحة:
Approved,
Declined,
Failed,
Expired or Not Found
message
string

تفسير سهل القراءة للنتيجة، بما في ذلك عدد المحاولات المتبقية بعد إدخال رمز خاطئ.

email
object | null

تقرير البريد الإلكتروني الكامل. موجود (غير null) فقط في النتائج النهائية (Approved/Declined)؛ ويكون null في حالة Failed وغير موجود في حالة Expired or Not Found.

vendor_data
string | null

vendor_data لجلسة التحقق المطابقة. وتكون null عند Expired or Not Found.

metadata
object | null

metadata لجلسة التحقق المتطابقة. null عند Expired or Not Found.

created_at
string<date-time>

الطابع الزمني لاستجابة هذا الفحص.

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