الانتقال إلى المحتوى الرئيسي
PATCH
curl
مفاتيح الحقول هي المفاتيح التي قمت بتهيئتها للمستند في سير العمل. راجع Document AI لمعرفة كيفية إعداد المستندات والحقول، وتقرير Document AI لمعرفة المكان الذي تظهر فيه النتيجة ضمن قرار الجلسة.

التفويضات

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 لجلسة التحقق (session_id الذي تم إرجاعه بواسطة POST /v3/session/). يقبل معرّفات جلسات التحقق من المستخدمين (KYC) والتحقق من الشركات (KYB): يطابق الخادم المعرّف عبر كلا نوعي الجلسات. يجب أن يكون UUID صالح البنية؛ تؤدي القيمة غير صالحة البنية إلى عدم مطابقة المسار وإرجاع 404 بتنسيق HTML.

مثال:

"11111111-2222-3333-4444-555555555555"

documentUuid
string<uuid>
مطلوب

معرّف UUID لمستند Document AI (document_ai_documents[].items[].uuid في GET /v3/session/{sessionId}/decision/). يجب أن ينتمي إلى الجلسة الموجودة في المسار.

مثال:

"44444444-5555-6666-7777-888888888888"

الجسم

application/json
extracted_data
object

مفاتيح الحقول (المفاتيح التي قمت بتهيئتها للمستند) وقيمها المصححة. يجب أن تكون كائن JSON؛ وتُدمج مفتاحاً بمفتاح في البيانات المخزنة. لا تُرسلها بدلاً من إرسال null، حيث يؤدي ذلك إلى إرجاع 400.

مثال:
status
enum<string>

حالة المراجعة الجديدة للمستند.

الخيارات المتاحة:
Approved,
Declined,
In Review,
Not Finished
مثال:

"Approved"

الاستجابة

تم تحديث المستند. يُرجع المستند بعد الدمج.

uuid
string<uuid>
مطلوب

معرّف المستند.

document_key
string
مطلوب

المستند المُعَدّ الذي يتوافق معه هذا الرفع.

original_filename
string | null
مطلوب

اسم الملف الذي رُفع به المستند.

file_url
string | null
مطلوب

مسار تخزين الملف المرفوع. هذا ليس رابط تنزيل: اقرأ file_url الموقّع مسبقاً من قرار الجلسة لتنزيل الملف.

status
enum<string>
مطلوب

حالة مراجعة المستند.

الخيارات المتاحة:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
extracted_data
object | null
مطلوب

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

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