الانتقال إلى المحتوى الرئيسي
GET
curl
يُرجِع قالباً بيومترياً واحداً. استخدم biometric_template_uuid الذي تُرجعه حذف الجلسة، أو biometric_template_id في نتيجة مطابقة في البحث بالوجه، أو معرّفاً من القائمة.
لا تتضمن الاستجابة أبداً صورة أو متجهاً أو معرّف الجلسة المحذوفة أو بيانات الهوية. راجع نظرة عامة لمعرفة كل حقل.

الأخطاء

التفويضات

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.

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

template_uuid
string<uuid>
مطلوب

معرّف القالب، كما يتم إرجاعه في biometric_template_uuid بواسطة endpoints حذف الجلسة، أو biometric_template_id عند وجود نتيجة مطابقة في البحث بالوجه، أو endpoint القائمة.

مثال:

"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b"

الاستجابة

القالب.

uuid
string<uuid>

معرّف القالب. تم إنشاؤه عشوائياً؛ ولا يتم اشتقاقه من الجلسة المحذوفة أو وجهها.

vendor_user_uuid
string<uuid>

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

vendor_data
string | null

بيانات vendor_data الحالية للمستخدم، والتي يتم تحديدها عند قراءة القالب (لا يتم نسخها أبداً).

source_type
enum<string>

كيفية إنشاء القالب: حذف جلسة (عبر API أو Console)، أو نافذة الاحتفاظ بالبيانات التلقائية للتطبيق، أو عملية تعبئة سابقة أجرتها Didit بتوجيه منك.

الخيارات المتاحة:
session_delete,
automatic_retention,
backfill
provenance_reference
string<uuid>

مرجع مبهم يربط القالب بسجل التدقيق الخاص به. ليس معرّف الجلسة المحذوفة ولا يمكن تحويله إليها.

retention_policy
enum<string>

سياسة التطبيق في وقت الاحتفاظ.

الخيارات المتاحة:
delete_with_session,
retain_until_user_deleted
retention_override
boolean | null

قيمة retain_face_embeddings المرسلة عند الحذف، أو null عند تطبيق السياسة.

retained_at
string<date-time>
expires_at
string<date-time>

متى تنتهي صلاحية القالب ويتم مسحه تلقائياً. يتم تعيينها دائماً.

retained_by
string | null

الجهة الرئيسية التي أصدرت التعليمات: معرّف التطبيق لمفاتيح API، أو معرّف عضو Console لإجراءات Console، أو معرّف service: للاحتفاظ التلقائي. لا يكون عنوان بريد إلكتروني أبداً.

retained_by_type
enum<string>
الخيارات المتاحة:
API_KEY,
CONSOLE_USER,
SYSTEM
instruction_class
enum<string>
الخيارات المتاحة:
operational_session_delete,
privacy_erasure
instruction_source
enum<string>
الخيارات المتاحة:
api,
console,
automatic_retention,
backfill,
privacy_erasure,
explicit_template_purge,
vendor_user_delete,
expiry,
reconciliation,
migration,
system
instruction_id
string

معرّف instruction_id المرسل عند الحذف، أو معرّف تم إنشاؤه بواسطة Didit.

held_out_of_use
boolean

تكون القيمة true فقط أثناء سريان حجز قانوني. ويُستبعد القالب المحجوز من كافة عمليات المطابقة.

status
enum<string>

فقط القوالب ذات الحالة active التي ليست معلقة، ولم تتجاوز expires_at، ولا يزال المستخدم الخاص بها موجودًا، تشارك في المطابقة.

الخيارات المتاحة:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed,
purged
purged_at
string<date-time> | null
آخر تعديل في ٧ نوفمبر ٢٠٢٦