ابدأ الآن
التكامل / SDKs
التحقق من المستخدمين
التحقق من الشركات
مراقبة المعاملات
سجل التغييراتcurl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "retain_until_user_deleted",
"face_retention_days": 365,
"biometric_consent_mode": "auto",
"available_events": [
{
"value": "status.updated",
"label": "Session status updated"
},
{
"value": "data.updated",
"label": "Session data updated"
},
{
"value": "user.status.updated",
"label": "User status updated"
},
{
"value": "user.data.updated",
"label": "User data updated"
},
{
"value": "business.status.updated",
"label": "Business status updated"
},
{
"value": "business.data.updated",
"label": "Business data updated"
},
{
"value": "activity.created",
"label": "Activity created"
},
{
"value": "transaction.created",
"label": "Transaction created"
},
{
"value": "transaction.status.updated",
"label": "Transaction status updated"
},
{
"value": "travel_rule.status.updated",
"label": "Travel Rule Status Updated"
},
{
"value": "workflow.compliance_changed",
"label": "Workflow Compliance Changed"
}
],
"allowed_return_hosts": [
"shop.example.com"
],
"endpoints": [
{
"uuid": "11111111-2222-3333-4444-555555555555",
"label": "Production session webhooks",
"url": "https://yourapp.com/webhooks/didit",
"enabled": true,
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA",
"subscribed_events": [
"status.updated",
"data.updated"
],
"created_at": "2026-01-04T08:00:00.000000Z",
"updated_at": "2026-04-22T14:09:11.523671Z"
}
]
}تحديث إعدادات webhook في واجهة برمجة Didit
غيّر webhook على مستوى التطبيق في Didit، ودوّر سره المشترك، واضبط الاحتفاظ بالبيانات والقالب البيومتري، وسجّل نطاقات محفظة الهوية.
curl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "retain_until_user_deleted",
"face_retention_days": 365,
"biometric_consent_mode": "auto",
"available_events": [
{
"value": "status.updated",
"label": "Session status updated"
},
{
"value": "data.updated",
"label": "Session data updated"
},
{
"value": "user.status.updated",
"label": "User status updated"
},
{
"value": "user.data.updated",
"label": "User data updated"
},
{
"value": "business.status.updated",
"label": "Business status updated"
},
{
"value": "business.data.updated",
"label": "Business data updated"
},
{
"value": "activity.created",
"label": "Activity created"
},
{
"value": "transaction.created",
"label": "Transaction created"
},
{
"value": "transaction.status.updated",
"label": "Transaction status updated"
},
{
"value": "travel_rule.status.updated",
"label": "Travel Rule Status Updated"
},
{
"value": "workflow.compliance_changed",
"label": "Workflow Compliance Changed"
}
],
"allowed_return_hosts": [
"shop.example.com"
],
"endpoints": [
{
"uuid": "11111111-2222-3333-4444-555555555555",
"label": "Production session webhooks",
"url": "https://yourapp.com/webhooks/didit",
"enabled": true,
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA",
"subscribed_events": [
"status.updated",
"data.updated"
],
"created_at": "2026-01-04T08:00:00.000000Z",
"updated_at": "2026-04-22T14:09:11.523671Z"
}
]
}rotate_secret_key يُدوّر السر على مستوى التطبيق فقط، وهو السر الذي يوقّع عمليات التسليم إلى webhook_url القديم. أما كل وجهة webhook فتوقّع بالسر المشترك الخاص بها secret_shared_key، وهذا الاستدعاء لا يغيّره.allowed_return_hosts في تسجيل وجهة الإرجاع الخاصة بك.
يحدد biometric_consent_mode (auto أو always أو never) متى يطلب سير التحقق الموافقة البيومترية الصريحة قبل التقاط الوجه. راجع الموافقة البيومترية.
لقراءة القيم الحالية أولاً، استدعِ الحصول على إعدادات webhook.التفويضات
مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.
الجسم
أرسل الحقول المراد تغييرها فقط. لا تتم إدارة الوجهات هنا.
رابط webhook قديم على مستوى التطبيق. يستخدمه Didit فقط في حال لم يكن لدى التطبيق أي وجهة مُمكَّنة، وحينها فقط للحدثين status.updated وdata.updated. وهو لا يُنشئ وجهة، وأي عملية إنشاء أو تحديث أو حذف لوجهة لاحقة ستحل محله. لتلقي إشعارات webhook، أنشئ وجهة باستخدام POST /v3/webhook/destinations/ بدلاً من ذلك.
2000إصدار payload لـ webhook_url القديم.
v1, v2, v3 تستبدل القيمة true المفتاح secret_shared_key على مستوى التطبيق بقيمة عشوائية جديدة على الفور؛ وتكون القيمة الجديدة في الاستجابة. ولا تتغير أسرار الوجهات. كل استدعاء يتضمن true يُنشئ سراً جديداً، لذا فإن العملية ليست idempotent.
إعداد تطبيق قديم. لا يقرأه سير التحقق.
MOBILE, MOBILE_AND_DESKTOP نافذة الحذف التلقائي بالأشهر (يُحتسب الشهر على أنه 30 يوماً)، أو null لعدم وجود حذف تلقائي. ينطبق التغيير على الجلسات الحالية أيضاً: يتم حذف كل جلسة تحقق من المستخدمين أقدم من النافذة الجديدة تلقائياً، وهذا الحذف غير قابل للتراجع.
1 <= x <= 120ما يحدث لتضمين الوجه الخاص بالجلسة عند حذف الجلسة. يتطلب retain_until_user_deleted وجود face_retention_days في الطلب نفسه أو تعيينه مسبقاً. ينطبق أي تغيير على عمليات حذف الجلسات من ذلك الحين فصاعداً؛ ولا ينشئ أو يمسح أي قالب بيومتري موجود.
delete_with_session, retain_until_user_deleted فترة الاحتفاظ، بالأيام، بالقوالب البيومترية بموجب retain_until_user_deleted.
1 <= x <= 3650متى يطلب التدفق المستضاف وحزم SDK الأصلية من الشخص الموافقة البيومترية الصريحة قبل التقاط الوجه. يطلب auto (الافتراضي) فقط عند انطباق مُشغِّل: ولاية مُعلنة، أو عنوان IP الخاص بالشخص، أو جهة إصدار مستند الهوية في إلينوي أو تكساس أو كولورادو، أو يبدو أن الشخص في الولايات المتحدة دون ولاية معروفة. يطلب always من كل شخص يلتقط سير العمل الخاص به وجهاً. لا يعرض never الخطوة أبداً، وتقوم بجمع الموافقة بنفسك قبل التقاط صورة سيلفي. يتم تسجيل كل تغيير في سجل التدقيق. راجع الموافقة البيومترية.
auto, always, never يستبدل القائمة الكاملة لمضيفي العودة لمحفظة الهوية الرقمية (Digital ID). أسماء مضيفين مجردة فقط، مثل shop.example.com: بدون بروتوكول أو منفذ أو مسار أو محارف بديلة. يتم تحويل القيم إلى أحرف صغيرة وتجاهل التكرارات. أرسل [] لمسح القائمة.
20253يستبدل القائمة الكاملة للأصول المسموح بها. الأصول (على سبيل المثال https://app.example.com؛ وhttp مسموح به فقط لـ localhost) التي يمكن تضمين سير عمل التحقق المستضاف فيها والتي يمكنها إعادة المستخدم إليها عبر callback للجلسة. لا تتأثر الاستدعاءات بين الخوادم. القائمة الفارغة تعني عدم وجود أي قيود. تقوم Didit بتخزين كل أصل بأحرف صغيرة دون منفذ افتراضي. يفشل الإدخال غير الصالح بالرمز 400 في allowed_domains. أرسل [] لإزالة القيد.
50300["https://app.example.com"]
الاستجابة
التكوين الكامل بعد التحديث، بنفس بنية GET /v3/webhook/. عندما تقوم بتدوير السر، قم بتخزين secret_shared_key الجديد قبل التخلص من الاستجابة.
تكوين webhook على مستوى التطبيق، وسياسة الاحتفاظ بالبيانات، ومضيفو إرجاع محفظة الهوية الرقمية، مع كل وجهة webhook.
رابط webhook على مستوى التطبيق (القديم). يرسل Didit إليه فقط في حال عدم وجود وجهة مفعّلة للتطبيق، وحينها يرسل status.updated وdata.updated فقط. كل عملية إنشاء أو تحديث أو حذف لوجهة تضبطه على عنوان URL لأقدم وجهة مفعّلة، أو null عند عدم وجود أي وجهة مفعّلة.
إصدار payload لـ webhook_url القديم. لكل وجهة webhook_version خاص بها.
v1, v2, v3 سر التوقيع على مستوى التطبيق (token آمن لعناوين URL مكوّن من 43 حرفاً). يقوم بتوقيع عمليات التسليم المرسلة إلى webhook_url القديم فقط؛ بينما توقّع كل وجهة باستخدام secret_shared_key الخاص بها. يستلمه مستدعو مفتاح API دائماً بالكامل؛ بينما يتلقى مستخدمو Console الذين لا يملكون إذن read:webhooks سلسلة فارغة.
إعداد تطبيق قديم. لا يقرأه سير التحقق: خيارات الالتقاط يتم تكوينها لكل سير عمل.
MOBILE, MOBILE_AND_DESKTOP نافذة الحذف التلقائي. تُحذف جلسات التحقق من المستخدمين التي تم إنشاؤها قبل أكثر من هذا العدد من الأشهر (الشهر يُحسب كـ 30 يومًا) تلقائيًا، وهذا الحذف لا يمكن التراجع عنه. تعني القيمة null أنه لا يتم حذف الجلسات تلقائيًا أبدًا. راجع الاحتفاظ بالبيانات.
1 <= x <= 120ما يحدث لتضمين الوجه الخاص بالجلسة عند حذف الجلسة. delete_with_session (افتراضي) يحذفه مع الجلسة. retain_until_user_deleted هو خيار الاشتراك في الاحتفاظ بالقالب البيومتري: تتم إدارة قالب بيومتري خالٍ من الصور مرتبط بالمستخدم (User) بشكل منفصل حتى تنتهي فترة الاحتفاظ به، أو يُحذف المستخدم، أو تقوم بمسحه.
delete_with_session, retain_until_user_deleted فترة الاحتفاظ، بالأيام، بالقوالب البيومترية بموجب retain_until_user_deleted. مطلوبة عند تعيين تلك السياسة.
1 <= x <= 3650كل نوع حدث يمكن للوجهة الاشتراك فيه، مع تسمية للعرض.
Show child attributes
Show child attributes
أسماء المضيفين (تطابق تام، عبر HTTPS فقط) التي يجوز لعملية تحقق مستقلة من محفظة الهوية الرقمية إعادة المستخدم إليها عبر return_url. يُسمح دائماً بنطاق العلامة البيضاء الخاص بك أيضاً. راجع تسجيل وجهة الإرجاع الخاصة بك.
20253كل وجهة webhook للتطبيق، الأقدم أولاً، مع سر التوقيع الخاص بكل منها. للقراءة فقط هنا: يمكنك إدارة الوجهات باستخدام endpoints الخاصة بـ /v3/webhook/destinations/.
Show child attributes
Show child attributes
متى يطلب التدفق المستضاف وحزم SDK الأصلية من الشخص الموافقة البيومترية الصريحة قبل التقاط الوجه. يطلب auto (الافتراضي) فقط عند انطباق مُشغِّل: ولاية مُعلنة، أو عنوان IP الخاص بالشخص، أو جهة إصدار مستند الهوية في إلينوي أو تكساس أو كولورادو، أو يبدو أن الشخص في الولايات المتحدة دون ولاية معروفة. يطلب always من كل شخص يلتقط سير العمل الخاص به وجهاً. لا يعرض never الخطوة أبداً، وتقوم بجمع الموافقة بنفسك قبل التقاط صورة سيلفي. يتم تسجيل كل تغيير في سجل التدقيق. راجع الموافقة البيومترية.
auto, always, never الأصول (على سبيل المثال https://app.example.com؛ وhttp لـ localhost فقط) التي قد يتم تضمين سير عمل التحقق المستضاف فيها، وقد يُعاد إرسال المستخدم إليها عبر استدعاء رجوعي للجلسة. لا تتأثر الاستدعاءات بين الخوادم. تعني القائمة الفارغة عدم وجود أي قيود. يخزن Didit كل أصل بأحرف صغيرة دون منفذ افتراضي. أي إدخال غير صالح يفشل بخطأ 400 في allowed_domains.
50300["https://app.example.com"]