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

تصفية نوع الجلسة

استخدم معامل الاستعلام session_kind لتحديد نوع الجلسات المطلوب إرجاعها: يتضمن كل صف في الاستجابة الحقل session_kind: "user" | "business" حتى يتمكن عميلك من تحديد بنية كل صف على حدة.

التصفية المشتركة

تنطبق هذه الفلاتر على النوعين (تُتجاهل عمليات التصفية الخاصة بالمستخدمين عند session_kind=business، والعكس صحيح):

أمثلة

الاستجابة (مختصرة):

تختلف بنية الصفوف حسب النوع

تتضمن صفوف التحقق من المستخدمين (KYC) الحقول: portrait_image وdocument_type وfull_name وcountry (الولاية المُصدِرة) وphone_number وemail_address، إضافةً إلى بعض حقول المراجعة: assignee (مراجِع الكونسول المكلَّف بالجلسة، أو null)، وwaiting_since وsla_due_at (تُحدَّد فقط عندما تكون الجلسة في حالة In Review)، وtop_warnings (أهم التحذيرات، ولكل تحذير الحقول risk وfeature وlog_type وshort_description)، وwarnings_count. تتضمن صفوف التحقق من الشركات (KYB) الحقول: workflow_type وworkflow_label وcompany_name وregistration_number وcountry (بلد التأسيس). ويتضمن النوعان: session_id وsession_kind وsession_number وstatus وvendor_data وcreated_at. للاطلاع على مصفوفة الميزات الكاملة، راجع نظرة عامة على الجلسات.

تقسيم الصفحات

يستخدم تقسيم الصفحات المعاملين limit (القيمة الافتراضية 50) وoffset (القيمة الافتراضية 0)، وتتضمن الاستجابة عناوين URL مطلقة هي next وprevious. يقبل كلا المعاملين قيمًا تصل إلى 1000000، وأي قيمة أكبر تُرجع 400. القيمة count دقيقة حتى 100 وتبقى عند 100 فيما بعد، لذا لا تعتمد عليها بوصفها إجماليًا. استمر في طلب عنوان next حتى تصبح قيمته null. ومع session_kind=all، تكون القيمة count مجموع النوعين، ويقتصر كل نوع على 100.

ذات صلة

التفويضات

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.

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

session_kind
enum<string>
افتراضي:user

أي نوع من الجلسات سيتم إدراجه: user (KYC فقط، افتراضي)، أو business (KYB فقط)، أو all (كلاهما، مدمجان - راجع الوصف لمعرفة دلالات تقسيم الصفحات المدمج). المطابقة غير حساسة لحالة الأحرف (يعمل BUSINESS)؛ وأي قيمة أخرى لا تُعدّ صيغةً من صيغ حالة الأحرف لـ user/business/all تُرجع 400.

الخيارات المتاحة:
user,
business,
all
limit
integer
افتراضي:50

الحد الأقصى لعدد الصفوف لكل صفحة (لكل نوع عند session_kind=all). القيمة الافتراضية هي 50.

النطاق المطلوب: 1 <= x <= 1000000
offset
integer
افتراضي:0

عدد الصفوف المراد تخطيها قبل أول صف مُرجع. القيمة الافتراضية هي 0. يُفضّل تتبّع عناوين URL في next/previous من الاستجابة.

النطاق المطلوب: 0 <= x <= 1000000
status
string

قائمة مفصولة بفواصل لحالات الجلسة لتضمينها، مثل Approved,In Review. القيم حساسة لحالة الأحرف؛ راجع حالات التحقق. القيم غير المعروفة لا تطابق أي شيء.

vendor_data
string

عنصر تصفية للتطابق التام على vendor_data الذي أرسلته عند إنشاء الجلسة (معرّف المستخدم/الشركة الخاص بك). للمطابقات الجزئية، استخدم search بدلاً من ذلك.

المرجع الكامل المعروض مثل S-0001 (مستخدم) أو B-0001 (شركة) يطابق فقط رقم الجلسة ونوعها؛ لا تؤثر الأصفار البادئة وحالة الأحرف على المطابقة. بحث ذكي في النص الحر. يطابق معرّف UUID الكامل حقل session_id؛ بينما يطابق الإدخال الرقمي بادئة رقم الجلسة، أو أرقام المستندات/الأرقام الشخصية، أو بادئة الهاتف، أو vendor_data؛ ويطابق الإدخال الذي يحتوي على @ بادئات البريد الإلكتروني؛ وتطابق النصوص الأخرى الأسماء (دون حساسية لعلامات التشكيل) وvendor_data. كما يطابق النص الحر الذي يحتوي على أرقام حقول البحث عن أرقام المستندات/الأرقام الشخصية وبادئات أرقام الجلسات بالإضافة إلى ذلك.

workflow_id
string

معرّفات سير العمل بصيغة UUID مفصولة بفواصل (يمكنك العثور عليها في صفحة Workflows في Console). يتم تجاهل معرّفات UUID غير الصالحة في القائمة؛ وإذا لم يكن أي منها صالحاً، فستكون النتيجة فارغة.

date_from
string<date>

فقط الجلسات التي تم إنشاؤها في هذا التاريخ (UTC) أو بعده، بالتنسيق YYYY-MM-DD. التواريخ غير الصحيحة تُرجع 400.

date_to
string<date>

فقط الجلسات التي تم إنشاؤها حتى هذا التاريخ (UTC)، بالتنسيق YYYY-MM-DD. بالنسبة لصفوف KYC، يتم تضمين اليوم بأكمله؛ أما بالنسبة لصفوف KYB، فإن المقارنة تكون created_at <= date_to (منتصف الليل)، لذا استخدم تاريخ اليوم التالي لتضمين يوم كامل من جلسات KYB.

tags
string

معرّفات الوسوم مفصولة بفواصل (tags الخاصة بتطبيقك). تُرجع الجلسات التي تحمل أياً منها. يتم تجاهل المعرّفات التي لا تمثل UUIDs صالحة، وعندما لا يكون أي منها صالحاً تكون القائمة فارغة.

decided_from
string<date-time>

تاريخ ووقت بتنسيق ISO 8601. يُرجع الجلسات التي تغيرت حالتها آخر مرة عنده أو بعده. يقوم بالتصفية بناءً على وقت آخر تغيير للحالة، وليس وقت الإنشاء.

decided_to
string<date-time>

تاريخ ووقت بتنسيق ISO 8601. يُرجع الجلسات التي تغيرت حالتها آخر مرة قبله. يمكن دمجه مع decided_from للحصول على نطاق نصف مفتوح.

country
string

تصفية الدولة مفصولة بفواصل. لصفوف KYC: رموز ISO 3166-1 alpha-3 لدولة إصدار مستند الهوية (مثل ESP,USA)، والتي قد تختلف عن الجنسية. لصفوف KYB: رمز دولة الشركة المسجلة.

document_type
string

رموز أنواع مستندات الهوية المفصولة بفواصل والتي تم التحقق منها في الجلسة (صفوف KYC فقط): P (جواز سفر)، ID (بطاقة هوية)، DL (رخصة قيادة)، RP (تصريح إقامة)، SSC (بطاقة الضمان الاجتماعي)، HIC (بطاقة التأمين الصحي)، WP (تصريح عمل)، TC (بطاقة ضريبية)، VISA، PSC (بطاقة الخدمات العامة)، BC (شهادة ميلاد)، OTHER. لاحظ أن حقل الاستجابة document_type يحتوي على اسم العرض، وليس الرمز.

document_name
string

أسماء المستندات الدقيقة؛ يمكن تمرير عدة أسماء مفصولة بفواصل، ولكن لا يتم تقسيم القيمة عند الفواصل إلا إذا كانت تحتوي على أكثر من فاصل - واحد (تتم مطابقة الاسم المنفرد الذي يحتوي على فاصلة مدمجة بالكامل). الأسماء كما تم التعرف عليها بواسطة التحقق من المستندات (الوجه الأمامي أو الخلفي)، على سبيل المثال Spain - Id Card (2021). صفوف KYC فقط.

region
string

قيم المنطقة/الولاية للمستند مفصولة بفواصل (للمستندات الصادرة حسب المنطقة، مثل رخص القيادة الأمريكية). صفوف KYC فقط.

didit_internal_id
string<uuid>

التصفية حسب معرّف المستخدم الداخلي لدى Didit (حقل الاستجابة didit_internal_id) لإدراج جميع جلسات مستخدم واحد تم التحقق منه. يجب أن يكون UUID صالحاً؛ وترجع القيم غير صحيحة التنسيق 400. صفوف KYC فقط.

session_type
string

قنوات إنشاء الجلسة مفصولة بفواصل: API، HOSTED، MIGRATED. القيمة الخاصة ALL (أو حذف المعامل) تعطل التصفية. لصفوف KYC فقط.

api_service
enum<string>

تصفية جلسات API المستقلة حسب الخدمة. تُرجع القيم غير الصالحة 400. لصفوف KYC فقط.

الخيارات المتاحة:
ID_VERIFICATION,
FACE_MATCH,
AGE_ESTIMATION,
FACE_SEARCH,
POA,
AML,
KYB_REGISTRY,
PASSIVE_LIVENESS,
DATABASE_VALIDATION,
PHONE_VERIFICATION,
EMAIL_VERIFICATION
screened_full_name
string

بحث في الأسماء غير حساس لعلامات التشكيل داخل البيانات التي تم فحصها عبر AML والتحقق من قواعد البيانات. عند دمجه مع api_service=AML أو api_service=DATABASE_VALIDATION، يقتصر البحث على البيانات التي تم فحصها لتلك الميزة فقط. صفوف KYC فقط.

warning
string

رموز مخاطر التحذيرات مفصولة بفواصل؛ تُرجع الجلسات التي أثارت أياً منها (مثل POSSIBLE_FRAUD). رموز المخاطر مدرجة لكل ميزة في توثيق التحذيرات. تنطبق على صفوف KYC، وتنطبق مع رموز تحذيرات الشركات على صفوف KYB.

status_initialized_as_in_review
boolean

عندما تكون true، يتم تضمين الجلسات فقط التي كان قرارها في البداية In Review (مفيد لتدقيق حجم المراجعة اليدوية). صفوف KYC فقط.

is_kyc_to_be_reviewed
boolean

تُرجع القيمة true الجلسات التي تم تمييز التحقق من المستندات فيها لإجراء مراجعة يدوية؛ وتُرجع القيمة false الجلسات التي لم يتم تمييز التحقق من المستندات فيها صراحةً. اترك المعامل دون تحديد للتعطيل. لصفوف KYC فقط.

euuid
string<uuid>

التصفية حسب euuid للمستخدم النهائي (UUID المعيّن للمستخدم الذي يجري التحقق، والمستخدم في الروابط العميقة للوحة التحكم). يجب أن يكون UUID صالحاً؛ تؤدي القيم غير الصالحة إلى ظهور خطأ 400 في الحقل. لصفوف KYC فقط.

organization_name
string

أسماء المؤسسات مفصولة بفواصل. مخصصة للوحة التحكم؛ مع مفتاح API (المحدد نطاقه بالفعل لتطبيق واحد)، فإنها تطابق فقط اسم مؤسستك.

الاستجابة

قائمة جلسات مقسّمة إلى صفحات. عناصر results هي صفوف KYC أو صفوف KYB أو كلاهما اعتماداً على session_kind؛ يتم التمييز بينها باستخدام حقل session_kind الخاص بكل صف.

count
integer
مطلوب

عدد الجلسات المطابقة لعوامل التصفية: دقيق حتى 100 ويقتصر على 100 كحد أقصى بعد ذلك، لذا لا تستخدمه كإجمالي. استخدم next لمعرفة ما إذا كانت هناك صفحات أخرى. بالنسبة إلى session_kind=all، فهو مجموع كلا النوعين، مع اقتصار كل منهما على 100 كحد أقصى.

مثال:

2

next
string<uri> | null
مطلوب

رابط URL مطلق للصفحة التالية، أو null في الصفحة الأخيرة.

مثال:

"https://verification.didit.me/v3/sessions/?limit=20&offset=20"

previous
string<uri> | null
مطلوب

رابط URL مطلق للصفحة السابقة، أو null في الصفحة الأولى.

مثال:

null

results
(KYC session row (session_kind: user) · object | KYB session row (session_kind: business) · object)[]
مطلوب

صفوف الجلسات، الأحدث أولاً. مع session_kind=all، تأتي صفوف KYC أولاً، ثم صفوف KYB.

صف ملخص لجلسة التحقق من المستخدمين (KYC). تتم تعبئة حقول الهوية (full_name، country، document_type، portrait_image، وحقول الاتصال) تدريجياً مع إكمال المستخدم لخطوات التحقق، وتكون قيمتها null حتى تنتهي الخطوة ذات الصلة. الحقول المقيدة بإعدادات سمات الاستجابة لسير العمل تُعاد أيضاً كـ null.

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