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

التفويضات

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.

الجسم

multipart/form-data
user_image
file
مطلوب

صورة وجه أمامية (مثل صورة سيلفي). الامتدادات المسموح بها: tiff، jpg، jpeg، png، webp. الحد الأقصى لحجم الرفع: 5 MB (يتم رفض الملفات الأكبر حجماً بالرمز 400). يتم ضغط الصور تلقائياً إلى ~0.5 MB قبل المعالجة، لذا فإن دقة الصورة العالية جداً لا تحسّن دقة النتائج. يجب أن تحتوي الصورة على شخص واحد — عند وجود عدة وجوه، يتم تقييم الوجه الأكبر ويُضاف تحذير MULTIPLE_FACES_DETECTED.

face_liveness_score_decline_threshold
number<float>
افتراضي:30

حد درجة كشف الحيوية (0–100). تُصدر الدرجة المحسوبة التي تكون عند أو أقل من هذه القيمة تحذير LOW_LIVENESS_SCORE وتُعيّن status إلى Declined. القيمة الافتراضية 30؛ ارفعها لاتباع نهج أكثر صرامة لمكافحة الانتحال. تُرجع القيم خارج النطاق 0–100 الخطأ 400.

النطاق المطلوب: 0 <= x <= 100
مثال:

30

rotate_image
boolean
افتراضي:false

عندما تكون true، تجرب الخدمة تدوير الإدخال بزيادات قدرها 90 درجة وتستخدم الاتجاه الذي يحقق أفضل كشف للوجه. مفيد عند فقدان اتجاه EXIF. يضيف تأخيراً في الاستجابة.

مثال:

false

save_api_request
boolean
افتراضي:true

عندما تكون true (الافتراضي)، يتم حفظ الاستدعاء كجلسة من نوع API، وتخزين صور الوجه، وإرسال webhook من نوع status.updated، وتسجيل الوجه المكتشف في فهرس البحث بالوجه الخاص بك. عندما تكون false، يكون الاستدعاء لمرة واحدة فقط — لا يتم تخزين أي شيء ولا يتم تسجيل الوجه. يعمل فحص قائمة الحظر والتكرار في كلتا الحالتين.

مثال:

true

vendor_data
string

معرّف مبهم اختياري (معرّف المستخدم لديك، البريد الإلكتروني، UUID...) يتم تخزينه في الجلسة المحفوظة وإعادته. يُستخدم أيضاً لاستبعاد الجلسات السابقة التي تحتوي على نفس vendor_data من فحص تكرار الوجه، بحيث لا تؤدي إعادة التحقق من نفس المستخدم إلى ظهور DUPLICATED_FACE.

مثال:

"user-123"

metadata
object

كائن JSON اختياري يُخزن مع الجلسة (عندما يكون save_api_request=true) ويُعاد في الاستجابة. في طلبات multipart، أرسله كحقل سلسلة نصية بترميز JSON — حيث يتم تحليله إلى كائن.

مثال:

الاستجابة

اكتمل كشف الحيوية السلبي. يمثل liveness.score درجة ثقة النموذج من 0 إلى 100 بأن الصورة تُظهر شخصاً حقيقياً؛ وتكون status هي Approved ما لم يُطلق تحذير بدرجة خطورة error. يُرجع الوجه المنتحل أو المدرج في قائمة الحظر الرمز 200 أيضاً — تحقق من liveness.status وliveness.warnings، وليس من رمز HTTP فقط. عندما تكون save_api_request=true، فإن request_id يمثل معرّف الجلسة المحفوظة.

request_id
string<uuid>

معرّف الجلسة المحفوظة عندما تكون save_api_request=true (يمكن استخدامه مع GET /v3/session/{sessionId}/decision/)؛ وإلا فسيكون UUID ارتباط مؤقت.

liveness
object
vendor_data
string | null

نسخة مطابقة من vendor_data التي أرسلتها، أو null.

metadata
object | null

نسخة مطابقة من كائن metadata الذي أرسلته، أو null.

created_at
string<date-time>

طابع زمني بتنسيق ISO 8601 (بالتوقيت العالمي المنسق UTC) لوقت إنشاء الاستجابة، مثل 2026-06-12T01:04:42.763237+00:00.

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