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

التفويضات

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.

الترويسات

Content-Type
string

يُضبط على application/json عند إرسال نص طلب بتنسيق JSON.

مثال:

"application/json"

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

session_id
string<uuid>
مطلوب

معرّف UUID لجلسة التحقق من المستخدمين (KYC). يجب أن تنتمي إلى التطبيق نفسه الخاص بمفتاح API — تُرجع معرّفات UUID من تطبيقات أخرى والجلسات المحذوفة ومعرّفات جلسات التحقق من الشركات (KYB) الرمز 404.

مثال:

"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d"

الجسم

application/json
new_status
enum<string> | null

تسمية حالة اختيارية لتسجيلها في المدخل. تقبل أي قيمة لحالة الجلسة، وهي حساسة لحالة الأحرف (يتم رفض "approved" برمز 400). تسجيل حالة هنا لا يغير الحالة الفعلية للجلسة — استخدم endpoint تحديث الحالة لذلك.

الخيارات المتاحة:
Not Started,
In Progress,
Approved,
Declined,
In Review,
Expired,
Abandoned,
Kyc Expired,
Resubmitted,
Awaiting User
مثال:

"In Review"

comment
string | null

ملاحظة اختيارية بنص حر (بدون حد مفروض للطول). يتم تخزينها حرفياً؛ لا تتم معالجة إشارات @email على هذا الـ endpoint.

مثال:

"Flagging for manual document re-check."

الاستجابة

مُدخل مسجل في مسار التدقيق الخاص بالجلسة. تظل الجلسة نفسها دون تغيير — وتحتفظ status بقيمتها السابقة ولا يتم إرسال أي webhook. يظهر المُدخل الجديد أيضاً في أعلى GET …/reviews/ (مع actor_display: "Unknown").

user
string

اسم العرض لمؤلف الإدخال. دائماً "Unknown" للإدخالات التي تم إنشاؤها عبر هذا الـ endpoint، لأنه لا يسجل إسناد الإدخال إلى فاعل.

مثال:

"Unknown"

new_status
enum<string> | null

تسمية الحالة المسجلة في المدخل، أو null إذا لم يتم إرسال أي منها. لا تتأثر الحالة الفعلية للجلسة.

الخيارات المتاحة:
Not Started,
In Progress,
Approved,
Declined,
In Review,
Expired,
Abandoned,
Kyc Expired,
Resubmitted,
Awaiting User
مثال:

"In Review"

comment
string | null

الملاحظة المسجّلة على المدخلة، أو null إذا لم يتم إرسال أي ملاحظة.

مثال:

"Flagging for manual document re-check."

created_at
string<date-time>

وقت كتابة المُدخل، بتنسيق ISO 8601 UTC.

مثال:

"2026-06-12T00:18:44.466537Z"

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