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

نظرة عامة

تُحدّث الحقول القابلة للتعديل في كيان المستخدم. الحقول المنقولة من جلسات التحقق من المستخدمين (KYC) المُتحقَّق منها (full_name، وdate_of_birth، وportrait_image، والعدادات الإجمالية، وfeatures) للقراءة فقط.

متى تستخدمه

  • تحديث بياناتك الوصفية: نقل مستخدم بين المستويات، وتغيير الوسوم، وتسجيل ملاحظة داخلية.
  • إعادة تسمية: ضبط display_name أفضل لعروض لوحة التحكم الداخلية.
  • تجاوز البيانات المُتحقَّق منها (بحذر): التجاوزات اليدوية مسموحة، لكنها تُسجَّل في سجل التدقيق.

ملاحظات

  • لا يمكن تغيير vendor_data في عنوان URL عبر نقطة النهاية هذه. أنشئ مستخدمًا جديدًا واحذف القديم إذا احتجت إلى تغيير المعرّف.
  • يُرسل webhook باسم user.data.updated مع مصفوفة changed_fields، لتتمكن الأنظمة المستهلكة من المزامنة بكفاءة.
  • يعمل تغيير status هنا كما في تحديث حالة المستخدم. يُسجَّل في نشاط الشخص، مع reason الاختياري (حتى 1000 حرف) بوصفه تعليقًا عليه، وتؤدي الحالة BLOCKED إلى إضافة vendor_data إلى قائمة الحظر في النظام. لا يتضمن webhook باسم user.status.updated الحقل reason.
  • إذا أرسلت طلب PATCH لحقل تديره جلسة مُتحقَّق منها حاليًا، فستُقبل عملية التجاوز لكنها ستُعلَّم في سجل التدقيق.

الأذونات

يمكن للمفتاح السري الأساسي ومفاتيح API ذات الوصول الكامل استدعاء نقطة النهاية هذه في كل الأوقات. يحتاج المفتاح ذو الوصول المخصص إلى صلاحية الكتابة على الأشخاص (users). لا يستطيع المفتاح المقيّد ببعض سير العمل أو بالجلسات المقبولة الوصول إلى نقطة النهاية هذه. تحدد الأدوار والأذونات في لوحة التحكم ما يمكن لعضو الفريق فعله داخل لوحة التحكم. لا تُقيَّم هذه الأدوار لطلبات مفاتيح 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
مطلوب

معرّفك الفريد للمستخدم (سلسلة نصية حرة، وليس UUID).

الجسم

application/json
full_name
string | null

الاسم الكامل للمستخدم

Maximum string length: 512
display_name
string | null

اسم عرض مخصص لهذا المستخدم

date_of_birth
string<date> | null

تاريخ الميلاد بصيغة YYYY-MM-DD

status
enum<string>

حالة دورة حياة المستخدم. يتم تسجيل التغيير كنشاط STATUS_CHANGED، وتؤدي القيمة BLOCKED إلى إضافة vendor_data إلى قائمة الحظر في النظام (والانتقال من BLOCKED يزيل هذا الإدخال).

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

كائن JSON عشوائي ترفقه بالمستخدم. يستبدل بالكامل البيانات الوصفية الحالية عند التحديث — قم بالدمج من جانب العميل إذا كنت تريد إضافة مفاتيح فقط.

approved_emails
string[]

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

approved_phones
string[]

أرقام الهواتف التي تم التحقق منها لهذا المستخدم. تستبدل القائمة المخزنة بالكامل.

issuing_states
string[]

دول الإصدار (ISO 3166-1 alpha-3)، على سبيل المثال ["USA"]. تستبدل القائمة المخزنة بالكامل.

reason
string | null

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

Maximum string length: 1000

الاستجابة

تم تحديث المستخدم. يتم إرجاع سجل المستخدم المحدث بالكامل (بنفس شكل Get User).

تفاصيل المستخدم الكاملة. يوسع 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>
آخر تعديل في ٧ نوفمبر ٢٠٢٦