الانتقال إلى المحتوى الرئيسي
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 عقدة الجلسة نفسها.

الجسم

application/json
locale
string

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

Maximum string length: 10

الاستجابة

الأطراف المُصرّح بها (أو المُصرّح بها مسبقاً).

valid
boolean
next_step
string | null

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

status
string

حالة جلسة الشركة.

advanced
boolean

تكون true عندما يُقر هذا الاستدعاء بالأطراف ويتقدّم بالجلسة.

already_submitted
boolean

تكون true عندما تكون الأطراف قد تم الإقرار بها بواسطة استدعاء سابق.

kyb_key_people_status
string
parties
object[]
آخر تعديل في ٧ نوفمبر ٢٠٢٦