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

نظرة عامة

ينقل كيان المستخدم بين ACTIVE وFLAGGED وBLOCKED. راجع دورة حياة الكيان للاطلاع على آلة الحالات كاملة.

متى تستخدمه

  • حظر مستخدم بعد التأكد من وجود احتيال أو خرق للامتثال.
  • وضع علامة على مستخدم بانتظار المراجعة اليدوية دون حظره حظراً كاملاً.
  • إلغاء الحظر عن مستخدم بعد معالجة الوضع بنجاح.
  • نقل الإشارات الخارجية: مثلاً عندما يمنح محرك الاحتيال الخاص بك مستخدماً درجة أعلى من الحد، انقله إلى FLAGGED عبر هذه الواجهة.

ملاحظات

  • القيم الصالحة هي ACTIVE وFLAGGED وBLOCKED. القيم غير الصالحة تُرجع 400.
  • مرّر reason اختيارياً (حتى 1000 حرف) لتسجيل سبب تغيير الحالة. يحتفظ Didit به كتعليق على إدخال تغيير الحالة في نشاط الشخص: comments[].comment في المستخدم، والنشاط في Business Console. يُسجَّل فقط عندما تتغير الحالة فعلاً.
  • تُرفض تلقائياً جميع الجلسات الجديدة وجميع المعاملات الجديدة للمستخدمين في حالة BLOCKED.
  • يُصدر webhook من نوع user.status.updated مع previous_status وstatus. لا يتضمن webhook الحقل reason.

الإنفاذ

الأذونات

يمكن للمفتاح السري الرئيسي ومفاتيح API ذات الصلاحيات الكاملة استدعاء هذا endpoint في أي وقت. يحتاج المفتاح ذو الوصول المخصص إلى صلاحية الكتابة على الأشخاص (users). لا يستطيع المفتاح المقيّد ببعض سير العمل أو بالجلسات المعتمدة الوصول إلى هذا endpoint. تحدد الأدوار والأذونات في Console ما يمكن لعضو الفريق فعله داخل Console. لا تُقيَّم هذه الأذونات لطلبات مفاتيح API.

ذات صلة

التفويضات

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.

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

vendor_data
string
مطلوب

معرّفك الفريد للمستخدم.

الجسم

application/json
status
enum<string>
مطلوب

حالة دورة الحياة الجديدة. يؤدي استخدام BLOCKED أيضاً إلى إضافة vendor_data إلى قائمة الحظر الخاصة بالنظام.

الخيارات المتاحة:
ACTIVE,
FLAGGED,
BLOCKED
reason
string | null

سبب تغيير الحالة. يُسجّل في قيد تغيير الحالة ضمن سجل نشاط المستخدم (comments[].comment، وActivity في Business Console)، فقط عندما تتغير الحالة فعلياً. لا تتضمنه أحداث webhook.

Maximum string length: 1000

الاستجابة

تم تحديث حالة المستخدم. تم إرجاع سجل المستخدم الكامل.

تفاصيل المستخدم الكاملة. يوسع UserListItem بالبيانات الوصفية، والتعليقات، وحقل updated_at.

didit_internal_id
string<uuid>

معرّف UUID الداخلي الثابت من Didit لهذا المستخدم.

vendor_data
string | null

معرّفك الفريد لهذا المستخدم (يتم تمريره عند إنشاء الجلسات). يمكن أن يكون هذا null في حال عدم تقديم معرّف بائع.

display_name
string | null

اسم عرض مخصص تم تعيينه بواسطتك

full_name
string | null

الاسم الكامل المستخرج من المستندات التي تم التحقق منها

date_of_birth
string<date> | null
effective_name
string | null

أفضل اسم متاح: display_name إذا كان محدداً، وإلا فـ full_name

status
enum<string>

حالة دورة حياة سجل المستخدم (ليست حالة جلسة). القيمة الافتراضية هي ACTIVE، وFLAGGED تميز المستخدم للمراجعة اليدوية، وBLOCKED تمنع إنشاء جلسات جديدة لقيمة vendor_data هذه.

الخيارات المتاحة:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

رابط موقع مسبقاً للصورة الشخصية للمستخدم (تنتهي صلاحيته بعد بضع ساعات)

session_count
integer

العدد الإجمالي لجلسات التحقق لهذا المستخدم

approved_count
integer

عدد الجلسات المقبولة

declined_count
integer

عدد الجلسات المرفوضة

in_review_count
integer

عدد الجلسات قيد المراجعة

issuing_states
string[]

رموز ISO 3166-1 alpha-3 لدول الإصدار الواردة في مستندات الهوية المقبولة لهذا المستخدم، مثل ["USA", "ESP"]. مصفوفة فارغة في حال عدم وجود أي منها.

approved_emails
string[]

عناوين البريد الإلكتروني التي تم التحقق منها والمجمعة من الجلسات المقبولة لهذا المستخدم، على سبيل المثال ["john@example.com"].

approved_phones
string[]

أرقام الهواتف التي تم التحقق منها والمجمعة من الجلسات المقبولة لهذا المستخدم، على سبيل المثال ["+14155551234"].

features
object

الحالة المجمعة لكل ميزة عبر جميع جلسات هذا المستخدم. المفاتيح المحتملة: ID_VERIFICATION، NFC، LIVENESS، FACE_MATCH، POA، QUESTIONNAIRE، EMAIL_VERIFICATION، PHONE، AML، IP_ANALYSIS، AGE_ESTIMATION، DATABASE_VALIDATION. القيم المحتملة: Approved، Declined، In Review، Not Finished، Resub Requested.

features_list
object[]

البيانات نفسها مثل features، كمصفوفة مرتبة من كائنات {feature, status}.

last_session_at
string<date-time> | null

الطابع الزمني لأحدث جلسة

first_session_at
string<date-time> | null

الطابع الزمني للجلسة الأولى

last_activity_at
string<date-time> | null

الطابع الزمني لأحدث نشاط لهذا المستخدم (جلسة، معاملة، تغيير حالة، تعديل بيانات، إلخ).

tags
object[]

تعيينات العلامات. ملاحظة: في استجابات التفاصيل يكون كل إدخال كائن ربط علامة ({uuid, tag: {...}, added_by_email, added_by_name, created_at})، على عكس التنسيق المسطح {uuid, name, color} المُستخدم في استجابات القوائم.

created_at
string<date-time>
metadata
object

بيانات وصفية مخصصة بتنسيق JSON أرفقتها بهذا المستخدم. القيمة الافتراضية هي {}.

comments
object[]

سجل الأنشطة والتعليقات الخاصة بهذا المستخدم (تغييرات الحالة، تعديلات الملف التعريفي، الملاحظات اليدوية).

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