الانتقال إلى المحتوى الرئيسي
POST
curl

التفويضات

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.

الترويسات

Idempotency-Key
string

مفتاح اختياري لأمان إعادة المحاولة، حتى 255 حرفاً. تؤدي إعادة استخدام نفس المفتاح مع نفس نص الطلب إلى إرجاع الاستجابة الأصلية دون تشغيل أو فوترة فحص ثانٍ. تؤدي إعادة استخدام المفتاح مع نص مختلف إلى إرجاع 409.

Maximum string length: 255

الجسم

application/json
full_name
string
مطلوب

الاسم الكامل للشخص أو الشركة المراد فحصها. الحد الأدنى حرفان - وهو الحد الأدنى الخاص بمزود الفحص نفسه. يؤدي إرسال اسم أقصر أو فارغ إلى إرجاع 400 في هذا الحقل قبل تشغيل أي فحص، وبالتالي لا تتم فوترة أي شيء.

Minimum string length: 2
مثال:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
افتراضي:person

نوع الكيان المراد فحصه. القيمة الافتراضية هي person.

الخيارات المتاحة:
person,
company
date_of_birth
string<date>

تاريخ الميلاد (للأشخاص) أو تاريخ التأسيس (للشركات)، YYYY-MM-DD. يحسّن دقة التطابق عبر وزن DOB.

مثال:

"1972-02-29"

nationality
string

رمز الدولة وفقاً لـ ISO 3166-1 alpha-2 (مثل ES). الرموز غير الصالحة تُرجع 400. يحسّن دقة التطابق من خلال وزن الدولة.

مثال:

"ES"

document_number
string

رقم مستند الهوية. غير مرجّح بأوزان — يعمل كمفتاح حاسم: التطابق التام يتجاوز match_score للنتيجة إلى 100، وعدم التطابق الصريح يقلل الدرجة. يُرسل إلى مزوّد الفحص كمرشح بحث فقط عندما يتراوح بين 2-50 حرفاً؛ تُقبل القيمة الخارجة عن هذا النطاق وتُخزّن، ويستمر الفحص وتتم فوترته، ولكن دون تضييق نطاقه برقم المستند.

aml_score_approve_threshold
number
افتراضي:80

حد درجة المخاطر الذي تكون النتيجة عنده أو دونه Approved. يجب أن يكون ≤ aml_score_review_threshold (وإلا فسيتم إرجاع 400).

النطاق المطلوب: 0 <= x <= 100
aml_score_review_threshold
number
افتراضي:100

حد درجة المخاطر الذي تصبح النتيجة فوقه Declined. وتؤدي الدرجات بين الحدين إلى الحالة In Review.

النطاق المطلوب: 0 <= x <= 100
aml_name_weight
integer
افتراضي:60

وزن تشابه الأسماء في درجة التطابق لكل نتيجة مطابقة. يجب أن يكون مجموع الأوزان الثلاثة 100 بالضبط (وإلا 400).

النطاق المطلوب: 0 <= x <= 100
aml_dob_weight
integer
افتراضي:25

وزن تاريخ الميلاد في درجة التطابق لكل نتيجة مطابقة.

النطاق المطلوب: 0 <= x <= 100
aml_country_weight
integer
افتراضي:15

وزن الدولة/الجنسية في درجة التطابق لكل نتيجة مطابقة.

النطاق المطلوب: 0 <= x <= 100
aml_match_score_threshold
integer
افتراضي:93

الحد الفاصل لكل تطابق: التطابقات التي تكون قيمة match_score لها أقل من هذا الحد تُعد False Positive (مستبعدة من تقييم المخاطر)؛ أما التطابقات التي تساوي هذا الحد أو تتجاوزه فتُعد تطابقات محتملة Unreviewed.

النطاق المطلوب: 0 <= x <= 100
include_adverse_media
boolean
افتراضي:false

ابحث أيضاً في وسائل الإعلام الإخبارية عن التغطيات السلبية. يضيف هذا ما يصل إلى ~30 ثانية من زمن الانتقال أثناء جمع النتائج — استخدم مهلة انتظار للعميل تبلغ 60 ثانية على الأقل.

include_ongoing_monitoring
boolean
افتراضي:false

الاستمرار في إعادة فحص هذا الملف التعريفي ودفع التغييرات عبر webhook. يتطلب save_api_request=true (وإلا 400).

save_api_request
boolean
افتراضي:true

حفظ الفحص كجلسة (الظهور في لوحة التحكم، endpoint القرار، webhooks، مراجعة النتائج). اضبطه على false لإجراء فحص عديم الحالة.

vendor_data
string

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

metadata
object | null

كائن JSON بصيغة حرة يُخزن مع الطلب وتتم إعادته في الاستجابة.

sandbox_scenario
string

المعرّف القصير للسيناريو الخاص بالبيئة التجريبية فقط. يُقبل فقط عندما ينتمي مفتاح API إلى تطبيق في وضع البيئة التجريبية؛ ويُرفض في تطبيقات بيئة الإنتاج. لا يحتوي الفحص المستقل على جلسة لتفعيلها مسبقاً، لذا يوضع المعرّف القصير في طلب الفحص نفسه: يعيد decline_aml_hit تطابقاً واحداً بشكل مشابه لبيئة الإنتاج ويحسم الفحص كـ Declined، ويحسمه review_aml_possible_match كـ In Review، والسيناريو الذي لا يفعّل أي نتيجة لفحص AML يترك الفحص نظيفاً خالياً من النتائج. راجع دليل السيناريوهات عبر GET /v1/sandbox/scenarios/ أو البيئة التجريبية وبيانات الاختبار.

مثال:

"decline_aml_hit"

الاستجابة

اكتمل الفحص. تعكس aml.status حدودك المحددة؛ ويتم إدراج كل تطابق عند الحد الأدنى الداخلي للإدراج أو أعلى منه في aml.hits مع match_score للهوية، وrisk_score للكيان، وscore_breakdown يوضح أسباب التطابق.

request_id
string<uuid>

معرّف الجلسة المحفوظة عندما تكون save_api_request=true (يمكن استخدامه مع GET /v3/session/{sessionId}/decision/)؛ وإلا فسيكون UUID ارتباط مؤقت.

aml
object
vendor_data
string | null

تكرار لقيمة vendor_data التي أرسلتها.

metadata
object | null

نسخة مطابقة من metadata التي أرسلتها.

created_at
string<date-time>
آخر تعديل في ٧ نوفمبر ٢٠٢٦