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

نظرة عامة

استخدم نقطة النهاية هذه عند استيراد المستخدمين من مزوّد آخر ولديك بالفعل صورة وجه موثوقة لكل شخص. يبقى المستخدم مرتبطًا بـ vendor_data الخاصة بك، لكن نقطة نهاية إرفاق الملف الشخصي هذه تستخدم didit_internal_id لتحديد المستخدم المستهدف بشكل لا لبس فيه.
هذا يختلف عن رفع وجه إلى القائمة. يُرفق رفع الملف الشخصي وجهًا بملف المستخدم الشخصي لاستخدامه كدليل، ولاكتشاف التكرار، وللبحث بالوجه. أما رفع الوجه إلى القائمة فيضيف وجهًا إلى قائمة حظر مخصصة للوجوه، حتى يمكن رفض جلسات المطابقة المستقبلية.

نقطة النهاية

POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/

مسار الترحيل

1

إنشاء المستخدم أو العثور عليه

استدعِ POST /v3/users/create/ لإنشاء ملف شخصي جديد، أو GET /v3/users/{vendor_data}/ لملف موجود.
2

تخزين didit_internal_id

تتضمن استجابة المستخدم الحقل didit_internal_id. ستظل تستخدم vendor_data في قاعدة بياناتك؛ استخدم didit_internal_id فقط مع نقاط نهاية إرفاق الملف الشخصي.
3

رفع الوجه

أرسل بيانات صورة خامًا بترميز base64 في الحقل image. يتحقق الخادم من فك ترميز الصورة وحجمها واكتشاف الوجه قبل حفظها.

مثال

محتوى الطلب

الاستجابة

التحقق والحدود

  • الحد الأقصى 5 وجوه مرفوعة يدويًا لكل مستخدم.
  • الحد الأقصى لحجم الصورة بعد فك الترميز هو 2 MB.
  • يجب أن تكون الصورة بترميز base64 صالح وأن تُفك كصورة.
  • يجب أن تحتوي الصورة على وجه قابل للاكتشاف. استخدم صورة مقصوصة لوجه أمامي ومضاء جيدًا عند الإمكان.
  • يُفهرس الوجه المرفوع لاكتشاف التكرار والبحث بالوجه مستقبلًا.
  • لا يُضاف الوجه المرفوع تلقائيًا إلى قائمة الحظر.

عرض الوجوه المرفوعة أو حذفها

عرض وجوه الملف الشخصي:
حذف وجه واحد من الملف الشخصي:

الأذونات

استخدم مفتاح API للتطبيق نفسه. ويجب أن يكون المفتاح تابعًا لتطبيق مسموح له بإدارة ملف المستخدم المستهدف.

أنماط الفشل

  • 400: ترميز base64 غير صالح، أو صورة غير صالحة، أو عدم وجود وجه قابل للاكتشاف، أو تجاوز حجم الصورة 2 MB، أو وجود 5 وجوه مرفوعة للمستخدم بالفعل.
  • 401: بيانات الاعتماد مفقودة أو غير صالحة.
  • 403: مفتاح API صالح لكنه غير مسموح له بإدارة هذا الملف الشخصي للمستخدم.
  • 404: لا يوجد مستخدم بهذا didit_internal_id في التطبيق.
  • 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.

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

organization_id
string<uuid>
مطلوب

UUID الخاص بالمؤسسة التي تملك التطبيق.

application_id
string<uuid>
مطلوب

معرّف UUID للتطبيق الذي يمتلك ملف تعريف المستخدم.

didit_internal_id
string<uuid>
مطلوب

معرّف UUID الداخلي للمستخدم في Didit، والذي يُرجع كـ didit_internal_id بواسطة GET /v3/users/{vendor_data}/ وPOST /v3/users/create/.

الجسم

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

صورة وجه خام بصيغة JPG أو PNG بترميز base64. لا تُضمِّن البادئة data:image/...;base64,. الحد الأقصى للحجم بعد فك الترميز: 2 MB.

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

ملاحظة اختيارية مرئية للمشغّل للوجه الذي تم رفعه.

الاستجابة

تم رفع الوجه وإرفاقه بملف تعريف المستخدم.

uuid
string<uuid>
مطلوب

معرّف UUID لسجل وجه المستخدم المرفوع.

image_url
string<uri> | null
مطلوب

رابط URL موقّع لصورة الوجه المرفوعة.

comment
string | null
مطلوب

التعليق المقدَّم عند تحميل الوجه.

uploaded_by
string | null
مطلوب

البريد الإلكتروني أو معرّف الجهة الفاعلة للقائم بالرفع عند توفره.

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

الطابع الزمني للرفع.

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