الانتقال إلى المحتوى الرئيسي
PATCH
curl
الروابط الموقّعة مسبقاً في extra_files تنتهي صلاحيتها. استرجع روابط جديدة من قرار الجلسة عندما تحتاج إلى الملفات لاحقًا. لتصحيح البيانات المستخرجة من مستند بدلاً من ذلك، استخدم تحديث بيانات الجلسة.

التفويضات

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) لإضافة الملف إليها (وهو session_id المُرجع بواسطة POST /v3/session/). يرجع معرّف جلسة التحقق من الشركات (KYB) الرمز 404.

مثال:

"11111111-2222-3333-4444-555555555555"

الجسم

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

الصورة أو ملف PDF. الامتدادات المسموح بها: jpg، وjpeg، وpng، وwebp، وtiff، وpdf. بحد أقصى 15 ميغابايت عند الرفع؛ ثم يُضغط الملف ويُرفض برمز 400 إذا ظل حجمه أكبر من 2 ميغابايت (2,097,152 بايت). يتم رفض الملفات الفارغة.

model_type
enum<string>
مطلوب

kyc يضيف الملف إلى نتيجة التحقق من الهوية، وpoa إلى نتيجة إثبات العنوان.

الخيارات المتاحة:
kyc,
poa
مثال:

"kyc"

file_password
string

كلمة مرور ملف PDF مشفر. بدونها، أو عند إدخال كلمة مرور خاطئة، يُرجع ملف PDF المشفر الرمز 400.

الاستجابة

تمت إضافة الملف. يُرجع كل الملفات الإضافية لتلك النتيجة، بما في ذلك الملف الجديد.

extra_files
(string<uri> | null)[]
مطلوب

روابط موقعة مسبقاً قصيرة الأجل لجميع الملفات الإضافية للنتيجة المحددة بواسطة model_type، الأقدم أولاً. كل رابط يكون null لمفتاح API ذي نطاق محدد بدون إذن media: read. اقرأ روابط جديدة من قرار الجلسة لاحقاً.

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