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

نظرة عامة

تُرجع هذه الواجهة مهمة مراقبة AML المستمرة التي بدأت من تفعيل أو إيقاف مراقبة AML للمستخدمين أو تفعيل أو إيقاف مراقبة AML للشركات: حالتها، والعدادات لكل نتيجة، وعنصر results واحد لكل مستخدم أو شركة تمت معالجتها. تُشغَّل التحديدات التي تضم أكثر من 20 ملفًا شخصيًا في الخلفية، ويعيد استدعاء التفعيل أو الإيقاف الرمز 202 مع مهمة بحالة PENDING. استعلم من هذا endpoint كل بضع ثوانٍ حتى تصبح status إما COMPLETED أو FAILED. تُملأ results تدريجيًا أثناء معالجة الملفات الشخصية، وبالترتيب نفسه الذي تُعالج به، وتكتمل عند بلوغ المهمة الحالة COMPLETED. تُسجَّل نتائج كل سجل فقط للمهام التي بدأت عبر API؛ أما المهمة التي بدأت من Business Console فتعرض العدادات فقط.

حالة المهمة

توثَّق قيم outcome لكل سجل في صفحات التفعيل.

الأذونات

يمكن لأي مفتاح API نشط يتبع التطبيق استدعاء هذا endpoint. لا تكون المهمة مرئية إلا للتطبيق الذي أنشأها، وأي job_id آخر يعيد الرمز 404.

ذات صلة

التفويضات

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.

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

job_id
string<uuid>
مطلوب

معرّف job_id الذي يرجعه endpoint التبديل.

الاستجابة

المهمة.

job_id
string<uuid>
status
enum<string>
الخيارات المتاحة:
PENDING,
PROCESSING,
COMPLETED,
FAILED
is_enabled
boolean

true عندما تفعّل المهمة المراقبة، وfalse عندما تعطلها.

target_type
enum<string>

أي عائلة ملفات تعريف تبدّلها المهمة.

الخيارات المتاحة:
user,
business
total
integer

الملفات الشخصية التي تعالجها المهمة.

processed
integer

الملفات الشخصية التي تمت معالجتها حتى الآن.

outcomes
object

عدادات النتائج لكل سجل. يُحل كل ملف تعريفي محدد إلى عداد واحد بالضبط؛ لا يتم تخطي أي شيء بصمت.

results
object[]

إدخال واحد لكل ملف شخصي تمت معالجته، وفق ترتيب المعالجة. تتزايد الإدخالات أثناء تشغيل المهمة؛ وتكتمل بمجرد أن تصبح الحالة COMPLETED. يُسجَّل للمهام التي بدأت عبر API؛ أما المهمة التي تبدأ من Business Console فتبلغ عن العدادات فقط.

error
string | null

رسالة فشل عامة عندما تكون الحالة FAILED؛ يتم الاحتفاظ بالسبب التفصيلي من جهة المنصة.

created_at
string<date-time>
completed_at
string<date-time> | null
آخر تعديل في ٧ نوفمبر ٢٠٢٦