الانتقال إلى المحتوى الرئيسي
PATCH
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"

draftId
string<uuid>
مطلوب

معرّف UUID لمسودة الطرف (draft_id الذي تم إرجاعه عند إنشائها).

مثال:

"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d"

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

node_id
string

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

الجسم

application/json

أي مجموعة فرعية من حقول الطرف. يُدمج التعديل في المسودة المحفوظة ويتم التحقق من صحة الطرف المدمج ككل، بحيث يمكن إرسال المسودة التي كانت قابلة للإرسال قبل التعديل بعده أيضاً.

entity_type
enum<string>

ما إذا كان الطرف فرداً أو شركة.

الخيارات المتاحة:
person,
company
full_name
string

الاسم الكامل للشخص. أرسله، أو أرسل first_name وlast_name.

Maximum string length: 255
first_name
string
Maximum string length: 128
last_name
string
Maximum string length: 128
role
enum<string>

الدور الذي يشغله الطرف. قابل للتبديل مع roles؛ وعند إرسال الاثنين معاً يتم دمجهما.

الخيارات المتاحة:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
roles
enum<string>[]

كل دور يحمله الطرف. يحتاج الشخص إلى دور واحد على الأقل (هنا أو في role).

الخيارات المتاحة:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
position
string

المسمى الوظيفي لشخص ما.

Maximum string length: 128
date_of_birth
string<date> | null
company_name
string

اسم أحد أطراف الشركة. مطلوب عندما يكون entity_type هو company.

Maximum string length: 255
registration_number
string

رقم التسجيل لطرف من أطراف الشركة.

Maximum string length: 100
email
string<email>

المكان الذي يُرسل إليه رابط التحقق. مطلوب عندما يتعين على الطرف إكمال عملية التحقق، ويعتمد ذلك على إعدادات الدور وحدود الملكية في سير العمل.

ownership_percent
number | null

حصة الشركة التي يملكها الطرف.

nationality
string

جنسية الشخص، أو دولة تأسيس الشركة. مطلوبة لكل طرف.

Maximum string length: 100
phone_number
string
Maximum string length: 32
custom_fields
object

حقول إضافية محددة في سير العمل.

skip_verification
boolean
افتراضي:false

طلب تخطي التحقق لهذا الطرف. يتم قبول الطلب فقط عندما يسمح دور الطرف بالتخطي في إعدادات الأشخاص الرئيسيين لسير العمل.

الاستجابة

تم تحديث المسودة.

draft_id
string<uuid>
مطلوب
created_at
string<date-time>
مطلوب
updated_at
string<date-time>
مطلوب
party
object
مطلوب
آخر تعديل في ٧ نوفمبر ٢٠٢٦