curl -X GET https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.biometric_templates.retrieve(
"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.biometricTemplates.retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.BiometricTemplates.Retrieve(ctx, "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b")
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.biometricTemplates().retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->biometricTemplates->retrieve('9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.biometric_templates.retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.BiometricTemplates.RetrieveAsync("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f",
"vendor_data": "user-42",
"source_type": "session_delete",
"provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f",
"retention_policy": "retain_until_user_deleted",
"retention_override": null,
"retained_at": "2026-08-28T10:15:42.318402Z",
"expires_at": "2027-08-28T10:15:42.318402Z",
"retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e",
"retained_by_type": "API_KEY",
"instruction_class": "operational_session_delete",
"instruction_source": "api",
"instruction_id": "post-approval-cleanup-2026-08",
"held_out_of_use": false,
"status": "active",
"purged_at": null
}{
"detail": "You do not have permission to perform this action."
}{
"detail": "Biometric template not found."
}الحصول على القالب البيومتري – واجهة API
GET /v3/biometric-templates// — استرجاع قالب وجه بيومتري محفوظ واحد من Didit مع المستخدم المالك ومصدره وتاريخ انتهائه وحالته.
curl -X GET https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.biometric_templates.retrieve(
"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.biometricTemplates.retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.BiometricTemplates.Retrieve(ctx, "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b")
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.biometricTemplates().retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->biometricTemplates->retrieve('9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.biometric_templates.retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.BiometricTemplates.RetrieveAsync("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f",
"vendor_data": "user-42",
"source_type": "session_delete",
"provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f",
"retention_policy": "retain_until_user_deleted",
"retention_override": null,
"retained_at": "2026-08-28T10:15:42.318402Z",
"expires_at": "2027-08-28T10:15:42.318402Z",
"retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e",
"retained_by_type": "API_KEY",
"instruction_class": "operational_session_delete",
"instruction_source": "api",
"instruction_id": "post-approval-cleanup-2026-08",
"held_out_of_use": false,
"status": "active",
"purged_at": null
}{
"detail": "You do not have permission to perform this action."
}{
"detail": "Biometric template not found."
}biometric_template_uuid الذي تُرجعه حذف الجلسة، أو biometric_template_id في نتيجة مطابقة في البحث بالوجه، أو معرّفاً من القائمة.
curl -X GET https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \
-H "x-api-key: YOUR_API_KEY"
{
"uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f",
"vendor_data": "user-42",
"source_type": "session_delete",
"provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f",
"retention_policy": "retain_until_user_deleted",
"retention_override": null,
"retained_at": "2026-08-28T10:15:42.318402Z",
"expires_at": "2027-08-28T10:15:42.318402Z",
"retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e",
"retained_by_type": "API_KEY",
"instruction_class": "operational_session_delete",
"instruction_source": "api",
"instruction_id": "post-approval-cleanup-2026-08",
"held_out_of_use": false,
"status": "active",
"purged_at": null
}
الأخطاء
| الحالة | متى | نص الاستجابة |
|---|---|---|
403 | token الخاص بمستخدم لوحة التحكم، أو لا يُسمح لمفتاح API بهذا الإجراء | {"detail": "You do not have permission to perform this action."} |
404 | قالب غير معروف، أو قالب يخص تطبيقاً آخر، أو قالب تمت إزالته نهائياً | {"detail": "Biometric template not found."} |
التفويضات
مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.
معلمات المسار
معرّف القالب، كما يتم إرجاعه في biometric_template_uuid بواسطة endpoints حذف الجلسة، أو biometric_template_id عند وجود نتيجة مطابقة في البحث بالوجه، أو endpoint القائمة.
"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b"
الاستجابة
القالب.
معرّف القالب. تم إنشاؤه عشوائياً؛ ولا يتم اشتقاقه من الجلسة المحذوفة أو وجهها.
المستخدم المالك.
بيانات vendor_data الحالية للمستخدم، والتي يتم تحديدها عند قراءة القالب (لا يتم نسخها أبداً).
كيفية إنشاء القالب: حذف جلسة (عبر API أو Console)، أو نافذة الاحتفاظ بالبيانات التلقائية للتطبيق، أو عملية تعبئة سابقة أجرتها Didit بتوجيه منك.
session_delete, automatic_retention, backfill مرجع مبهم يربط القالب بسجل التدقيق الخاص به. ليس معرّف الجلسة المحذوفة ولا يمكن تحويله إليها.
سياسة التطبيق في وقت الاحتفاظ.
delete_with_session, retain_until_user_deleted قيمة retain_face_embeddings المرسلة عند الحذف، أو null عند تطبيق السياسة.
متى تنتهي صلاحية القالب ويتم مسحه تلقائياً. يتم تعيينها دائماً.
الجهة الرئيسية التي أصدرت التعليمات: معرّف التطبيق لمفاتيح API، أو معرّف عضو Console لإجراءات Console، أو معرّف service: للاحتفاظ التلقائي. لا يكون عنوان بريد إلكتروني أبداً.
API_KEY, CONSOLE_USER, SYSTEM operational_session_delete, privacy_erasure api, console, automatic_retention, backfill, privacy_erasure, explicit_template_purge, vendor_user_delete, expiry, reconciliation, migration, system معرّف instruction_id المرسل عند الحذف، أو معرّف تم إنشاؤه بواسطة Didit.
تكون القيمة true فقط أثناء سريان حجز قانوني. ويُستبعد القالب المحجوز من كافة عمليات المطابقة.
فقط القوالب ذات الحالة active التي ليست معلقة، ولم تتجاوز expires_at، ولا يزال المستخدم الخاص بها موجودًا، تشارك في المطابقة.
pending, active, expired, held_out_of_use, purge_pending, purge_failed, purged