الانتقال إلى المحتوى الرئيسي
POST
curl
ارفع صورة وجه مُرمَّزة بصيغة base64 إلى قائمة حظر أو قائمة سماح للوجوه. يكتشف Didit الوجوه في الصورة، ويحتفظ بأكبرها، ويخزّن الصورة وقصاصة لذلك الوجه، ويحسب القالب البيومتري للوجه الذي تُقارن به الجلسات الجديدة. قيمة value للإدخال الجديد هي معرّف UUID لهذا الوجه. يتاح ذلك فقط للقوائم التي تحمل entry_type: face وlist_type: blocklist أو list_type: allowlist.
إذا كنت تضع وجهًا في قائمة الحظر أو قائمة السماح من جلسة موجودة، فاستخدم إنشاء إدخال مع reference_session_id بدلًا من ذلك: يبقى الإدخال مرتبطًا بالجلسة.
يجب أن تحتوي الصورة على وجه واضح الظهور، ألا يتجاوز حجمها 2 ميغابايت بعد فك الترميز. إذا لم يُكتشف أي وجه، يُرجع الطلب الرمز 400 ولا يُنشأ أي إدخال. وإذا كان تحليل الوجه غير متاح مؤقتًا، يُرجع الطلب الرمز 503: أعد المحاولة لاحقًا.
لإزالة الوجه من القائمة، احذف إدخاله: يتوقف عن المطابقة مع الجلسات الجديدة.

التفويضات

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.

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

list_uuid
string<uuid>
مطلوب

معرّف UUID لقائمة ذات entry_type: face وlist_type: blocklist أو allowlist.

الجسم

application/json
image
string<byte>
مطلوب

صورة بصيغة JPEG أو PNG بترميز Base64، وبحجم أقصاه 2 ميغابايت بعد فك الترميز، تُظهر وجهاً واضحاً للعيان. أرسل سلسلة base64 المجردة، دون البادئة data:image/...;base64,.

comment
string
افتراضي:""

ملاحظة اختيارية بنص حر، مثل سبب الإدراج في القائمة.

الاستجابة

تم إنشاء إدخال الوجه.

قيمة واحدة في قائمة.

uuid
string<uuid>
مطلوب

معرّف المُدخل. استخدمه كـ entry_uuid في حذف مُدخل من قائمة.

value
string
مطلوب

القيمة المدرجة: رقم هاتف بصيغة E.164، أو عنوان بريد إلكتروني، أو رقم مستند، أو عنوان IP أو نطاق CIDR، أو بصمة جهاز، أو عنوان محفظة، أو حساب مصرفي، أو رمز دولة وفق معيار ISO 3166-1 alpha-3، أو vendor_data، أو أي سلسلة نصية في قائمة key، أو UUID للوجه المخزن في قائمة الوجوه. تُخزن القيم التي ترسلها بأحرف صغيرة، باستثناء أرقام الهواتف ورموز الدول. مطابقة النصوص غير حساسة لحالة الأحرف.

display_label
string | null
مطلوب

تسمية سهلة القراءة. تملؤها Didit للإدخالات المأخوذة من جلسة (على سبيل المثال اسم حامل المستند ورقمه) إذا لم ترسل أياً منها.

Maximum string length: 512
comment
string
مطلوب

ملاحظة بنص حر. سلسلة فارغة عند عدم التعيين.

added_by
string | null
مطلوب

من أضاف الإدخال: api (مفتاح API)، أو عنوان البريد الإلكتروني لمستخدم لوحة التحكم أو console، أو system أو migration (إدخالات أنشأتها Didit)، أو rule (إجراء قاعدة معاملات أو قاعدة مراقبة).

reference_session_id
string<uuid> | null
مطلوب

جلسة التحقق التي تم أخذ الإدخال منها. null عندما تتم إضافة الإدخال حسب القيمة.

reference_session_number
integer | null
مطلوب

رقم لتلك الجلسة بنطاق التطبيق، كما يظهر في وحدة التحكم.

reference_session_type
enum<string> | null
مطلوب

kyc لجلسة التحقق من شخص، وkyb لجلسة التحقق من شركة، وnull عندما لا توجد جلسة.

الخيارات المتاحة:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
مطلوب

السجل الذي يمثله الإدخال: سجل الوجه، أو المستند، أو الهاتف، أو البريد الإلكتروني المقروء من الجلسة، أو الوجه الذي تم إنشاؤه عبر تحميل وجه إلى قائمة، أو UUID الذي أرسلته (على سبيل المثال UUID لمعاملة أو didit_internal_id الخاص بالمستخدم).

metadata
object | null
مطلوب

سياق إضافي. يحتوي على المفاتيح التي تعينها Didit (المدرجة هنا) مدمجة مع أي metadata أرسلتها عند إنشاء الإدخال، وتُعاد كما تم تخزينها. ويكون null عند عدم وجود أي منها.

created_at
string<date-time>
مطلوب

وقت إضافة المُدخل.

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