البنية
المصادقة
تتطلب جميع الطلبات رأسx-api-key مع مفتاح API الخاص بتطبيقك. راجع مصادقة API لتدوير المفاتيح وفصل البيئات والنطاقات.
إنشاء الجلسة
نقطة نهاية واحدة:POST /v3/session/. يحدد نوع سير العمل ما إذا كانت الجلسة KYC أو KYB، ولا حاجة إلى حقل صريح باسم “business”.
الحقول الموصى بها عند الإنشاء:
المخطط الكامل: إنشاء جلسة.
تسليم الرابط المستضاف
الحقلurl في الاستجابة هو رابط تحقق مستضاف. خيارات التسليم:
- أرسله بالبريد الإلكتروني من منصتك.
- ضمّنه في واجهة التسجيل لديك كرابط.
- افتحه في webview داخل التطبيق (iOS / Android / React Native).
الاستطلاع مقابل webhooks
تُعد webhooks النمط الموصى به. يرسل Didit أحداث الإكمال بطريقة POST إلى نقطة النهاية التي اشتركت فيها فور انتهاء المعالجة. الاستطلاع مدعوم للتطوير، أو عندما تكون وجهة webhook غير قابلة للوصول:- استطلع
GET /v3/session/{id}/decision/بتأخير متزايد أسياً (كل 10 ثوانٍ في البداية، ويصل إلى 60 ثانية). - أوقف الاستطلاع عندما تكون
statusإحدى القيم"Approved"أو"Declined"أو"In Review".
التعامل مع webhooks
اشترك في الأحداث التي تهمك. تغطي الأحداث نفسها KYC وKYB، معsession_kind: "business" داخل payload لتحديد أحداث جلسات الشركات:
status.updated: تغيّرت حالة الجلسة. صفِّ بـsession_kind === "business"لجلسات KYB.data.updated: قام مراجع بتعديل بيانات السجل أو الأشخاص الرئيسيين في Business Console، أو أبلغ السجل عن تغيير. لا يُرسل هذا الحدث عندما يرفع المتقدم مستنداً أو يرسل الأشخاص الرئيسيين، لذا تابعstatus.updatedفي تلك الحالة. ينطبق الفلتر نفسهsession_kind.business.status.updated/business.data.updated: تغيّر كيان الشركة المرتبط.
التعامل مع القرارات
تدفق إعادة الإرسال
عندما تنتقل جلسة التحقق من الشركات (KYB) إلى الحالةResubmitted (أو عندما تُعلَّم ميزة للإرسال من جديد)، تحتاج الشركة إلى رفع بيانات مصححة أو إضافية.
يمكنك:
- إعادة إرسال الرابط
urlنفسه. يواصل التدفق المستضاف من النقطة التي تلزم فيها إعادة الإرسال. - إعادة إصدار رابط شخص رئيسي غير صالح: يحصل الطرف الذي حُذفت جلسة KYC الفرعية الخاصة به، أو انتهت صلاحيتها قبل أن يبدأها الشخص، على جلسة جديدة باستخدام إعادة إنشاء جلسة KYC للأشخاص الرئيسيين.
- فتح حالة في Business Console لتتبع التواصل المتبادل داخلياً.
تنفيذ الخطوات من واجهتك الأمامية
يمكن أيضاً تشغيل خطوتي المستندات والأشخاص الرئيسيين من خادمك باستخدام مفتاح API الخاص بك، فتحتفظ بواجهة المستخدم بينما يتولى Didit التحقق والقرار. يقتصر كل استدعاء على جلسة KYB، ويحتاج إلى الإذنwrite:businesses (وقراءة الأطراف المستخرجة تقبل أيضاً read:businesses أو read:sessions)، وينفذ الفحوصات نفسها، ويطبق الفوترة نفسها، ويتيح التقدم في الخطوة نفسها كما في الصفحة المستضافة.
- رفع المستندات المؤسسية بينما تكون الجلسة في خطوة مستندات KYB.
- قراءة الأطراف المذكورة في المستندات، بما في ذلك المساهمون ونسب الملكية، وعرضها على المتقدم.
- إنشاء وتعديل وحذف مسودات الأطراف. المسودة غير مُعلنة ولا تكلّف شيئاً.
- إرسال المسودات. يحدد Didit الأطراف الذين يجب التحقق منهم، وينشئ جلسة KYC لكل منهم، ويعيد
kyc_session_urlالخاص بها لترسله أو تضمّنه. - اقرأ القرار الموحد من الجلسة، كما في التدفق المستضاف.
409 kyb_step_mismatch مع الخطوة التي توجد فيها، وتُرجع الجلسة المكتملة الخطأ 409 kyb_session_not_writable.
تجميع ملف الشركة
إذا مررتvendor_data عند إنشاء الجلسة، يجمع Didit كل الجلسات الخاصة بتلك الشركة في كيان شركة واحد. استخدم الخريطة features في الكيان للإجابة عن سؤال “هل هذه الشركة موثقة بالكامل الآن؟” دون المرور على الجلسات واحدة تلو الأخرى.
الفوائد:
- تُلحق تدفقات إعادة التحقق الدورية من الشركات بالملف نفسه.
- تحمل المعاملات المراقبة بالقيمة
vendor_dataنفسها سياق المخاطر الخاص بالشركة. - يُربط المستفيدون الحقيقيون والمسؤولون بكيانات المستخدمين، فتُنشأ علاقات بين الكيانات.
أفضل الممارسات
معالجة الأخطاء
المرجع الكامل لـحدود المعدل.
الخطوات التالية
Webhooks
كل أحداث KYB وpayload الخاص بها.
الحالات
مرجع آلة الحالات.
مخطط الاستجابة
فك ترميز قرار KYB.