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

التفويضات

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 لجلسة التحقق من الشركات (KYB). يجب أن تنتمي إلى التطبيق الخاص بمفتاح API.

مثال:

"33333333-4444-5555-6666-777777777777"

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

node_id
string

عقدة سير العمل الخاصة بخطوة KYB. لازمة فقط عندما يحتوي سير العمل على أكثر من عقدة KYB واحدة؛ افتراضياً، تستخدم Didit عقدة الجلسة نفسها.

الجسم

multipart/form-data
documents
file[]
مطلوب

الملفات المطلوب رفعها: JPG، أو JPEG، أو PNG، أو TIFF، أو WEBP، أو PDF أو أرشيفات ZIP منها. ملفات PDF حتى 50 MB، والصور حتى 6 MB قبل الضغط.

document_passwords
string[]

إدخال واحد لكل ملف في documents، وبنفس الترتيب: كلمة مرور ملف PDF المحمي، ويكون فارغاً لأي ملف آخر.

document_group
enum<string>

مجموعة المستندات المطلوبة التي يستجيب لها هذا الرفع.

الخيارات المتاحة:
LEGAL_PRESENCE,
COMPANY_DETAILS,
OWNERSHIP_STRUCTURE,
REPRESENTATIVES_AUTHORIZATION
locale
string

اللغة المستخدمة لترجمة استجابة الخطوة التالية.

Maximum string length: 10

الاستجابة

تمت معالجة المستندات. عندما يتم استيفاء كل مجموعة مطلوبة تتقدم الجلسة ويُحدد next_step الخطوة التالية؛ بخلاف ذلك تظل في خطوة المستندات وتوضح document_groups وdocument_answer ما لا يزال مفقوداً.

valid
boolean
next_step
string | null

الخطوة التي توجد بها الجلسة بعد الرفع.

kyb_status
string

حالة فحص الشركة.

document_answer
object

النتيجة لكل مستند تم رفعه وعمليات الرفع المتبقية.

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