الانتقال إلى المحتوى الرئيسي
GET
curl
الـ payload الموجود داخل request_body هو نفسه المذكور في webhook، والرؤوس هي نفسها التي يغطيها التحقق من التوقيع. لإعادة إرسال التسليم، استخدم إعادة إرسال تسليم webhook للجلسة.

التفويضات

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.

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

sessionId
string<uuid>
مطلوب

معرّف UUID لجلسة التحقق، للمستخدمين (KYC) أو للشركات (KYB): session_id الذي تم إرجاعه بواسطة POST /v3/session/. يطابق الخادم المعرّف عبر كلا نوعي الجلسات.

يجب أن يكون UUID صالحًا. يطابق المسار قيم UUID صالحة البنية فقط، لذا يتم رفض أي قيمة غير صالحة البنية بواسطة موجه URL قبل تشغيل أي كود برمجي للتطبيق وتكون الاستجابة صفحة HTML برمز 404 بدلاً من تنسيق JSON لـ {"detail": ...} الموضح أدناه.

webhook_uuid
string<uuid>
مطلوب

معرّف UUID لعملية التسليم: وهو الـ uuid لمدخل تم إرجاعه بواسطة GET /v3/session/{sessionId}/webhooks/. يجب أن ينتمي إلى الجلسة الموجودة في المسار.

الاستجابة

التسليم، مع رؤوس الطلب ونصه.

محاولة تسليم webhook واحدة مسجلة لجلسة تحقق، مع رؤوس الطلب ومتنه الدقيقة التي أرسلتها Didit.

uuid
string<uuid>
مطلوب

معرّف التسليم. استخدمه كـ {webhook_uuid} للحصول على عملية التسليم هذه أو إعادة إرسالها.

session_id
string<uuid>
مطلوب

الجلسة التي تنتمي إليها عملية التسليم (الجلسة الموجودة في المسار).

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

رابط URL الذي أُرسل إليه التسليم.

response_status
integer | null
مطلوب

حالة HTTP التي أرجعها الـ endpoint الخاص بك. null طالما أن التسليم في قائمة الانتظار ولم تتم محاولته بعد. عندما لا يتم تلقي أي استجابة HTTP، تسجل Didit حالة خاصة بها: 504 عندما لم يُجب الـ endpoint الخاص بك في غضون 5 ثوانٍ، و503 لفشل الاتصال، و400 عندما تم رفض عنوان URL لعدم أمانه (على سبيل المثال عنوان خاص أو داخلي)، و404 لأي خطأ آخر في الطلب. يُعتبر الرمز 400 أو أعلى تسليمًا فاشلاً.

status
string | null
مطلوب

حالة الجلسة عند إنشاء الحدث، على سبيل المثال In Progress أو Approved أو Declined.

webhook_type
enum<string>
مطلوب

اسم حدث webhook المدعوم. استخدم هذه النصوص بدقة في subscribed_events؛ حيث يتم رفض القيم غير المدعومة.

الخيارات المتاحة:
status.updated,
data.updated,
user.status.updated,
user.data.updated,
business.status.updated,
business.data.updated,
activity.created,
transaction.created,
transaction.status.updated,
travel_rule.status.updated,
workflow.compliance_changed,
transaction_rule_suggestions.created,
auth.signup,
auth.login,
auth.login_failed,
auth.password_reset_requested,
auth.password_reset_completed,
auth.mfa_changed,
auth.new_device,
auth.account_locked,
investigator.report.ready,
investigator.decision.automated,
investigator.decision.overridden,
investigator.decision.contested,
investigator.question.raised,
investigator.automation.paused,
investigator.rfi.answered,
investigator.rfi.overdue,
investigator.drift.detected,
investigator.sla.breached,
investigator.qa.failed,
investigator.external.report.ready
request_header
string
مطلوب

نص JSON (سلسلة نصية) لرؤوس الطلب التي أرسلتها Didit: وهي Content-Type وX-Signature وX-Signature-V2 وX-Signature-Simple وX-Timestamp وUser-Agent. قم بتحليله باستخدام محلل JSON. يحتوي على التوقيعات، ولا يحتوي أبداً على سر التوقيع.

request_body
string
مطلوب

نص JSON (سلسلة نصية) للـ payload الدقيق الذي أرسلته Didit، مع فرز المفاتيح، بما في ذلك event_id وtimestamp. قم بتحليله باستخدام محلل JSON؛ راجع شكل الـ Payload. بالنسبة لمفتاح محدد النطاق بدون media: read، تكون عناوين URL للوسائط بداخله null؛ وبدون sessions: write، تكون رموز الجلسات وروابط التحقق المستضافة null. محتوى الطلب الذي تم تغييره بهذه الطريقة لا يعود مطابقاً لتوقيعاته. لا تسجل Didit محتوى الاستجابة الذي أرجعه الـ endpoint الخاص بك.

created_at
string<date-time>
مطلوب

وقت إنشاء التسليم.

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