المرجع
reference هو معرّفك الثابت الخاص بالعميل، من 1 إلى 64 حرفًا من A-Z a-z 0-9 _ . : -. عند وجوده يحفظ الاستدعاء قضية في المكان الذي يطّلع عليه موظفوك. وبدونه لا يُخزَّن شيء في مساحة عملك ولا يُرسل أي webhook.
اختر مرجعًا لا يتغير وليس قيمة شخصية. معرّف قاعدة البيانات (client-0001, acct:8812) مناسب. أما عنوان البريد الإلكتروني فغير مناسب (الرمز @ غير مسموح، وسيضع بيانات شخصية في سجلاتك وفي webhooks).
القضية
القضية فريدة لكل مساحة عمل وبيئة ومرجع. ينشئها أول استدعاء يحمل المرجع، وتحدّثها الاستدعاءات اللاحقة:- يضيف
/extractمستندًا وحقوله المقروءة وفحوصه. - يحفظ
/verifyو/assessالحكم، ويحفظ/assessالتقييم أيضًا. وتُربط بالقضية المستندات التي تعيد إرسالdocument_idالخاص بها. - يحفظ
/eidطلب eID بحالة معلّق، ويسجّل الاستعلام الدوري (poll) النتيجة.
subject يحل محل الاسم المخزَّن. والاستدعاء بلا اسم يُبقي الاسم المخزَّن. وإذا لم يُرسل subject يُبنى الاسم من الحقول المقروءة.
الحالة التي عيّنها شخص في وحدة التحكم (approved, refused) لا يغيّرها حكم جديد أبدًا.
البيئة
environment إما sandbox (الافتراضي) أو production. المرجع نفسه في البيئتين يمثل قضيتين. انظر بيئة الاختبار والإنتاج لمعرفة ما يغيّره الحقل أيضًا.
المستند والحقول
يُقرأ المستند إلى حقول من مفردات ثابتة من المفاتيح (الأسماء والتواريخ والعنوان والبيانات البنكية وأرقام الكيانات وغيرها). كل قيمة نص. ويُغفل القارئ ما لا يستطيع قراءته. انظر أنواع المستندات والحقول.الحكم ودرجة الخطورة
لكل فحص درجة خطورة.critical يمنع، وwarning ينبّه لمراجعة شخص، وinfo للتوثيق. وتكون passed صحيحة عندما لا يفشل أي فحص حرج. انظر التحقق من ملف.
السياسة
يعمل كل استدعاء وفق سياسة مساحة عملك لنوع العميل (kyc أو kyb) وللبيئة. يمكن لمفتاح في الطلب أن يضيف فحوصًا، لكنه لا يستطيع إيقاف فحص تقفله السياسة. ويُدرج المفتاح المرفوض في policy.overrides_refused ولا يُعد خطأ. وتحدد السياسة العتبات (بالأيام) والأقفال والمستندات المطلوبة ومدى صرامة نطاقات المخاطر. وتُعدَّل في Settings, KYC policy في وحدة التحكم.
أنواع العملاء
ما لا تفعله واجهة البرمجة
- لا تتخذ القرار. تُرجع الفحوص والحكم، وسياستك هي التي تحدد ما يجب فعله.
- لا تُرجع درجة ثقة لكل حقل.
- ليست فيها نقطة نهاية للربط البنكي ولا نقاط من 1000. هذه منتجات في وحدة التحكم.
- ليست فيها نقطة نهاية للدفعات ولا مفتاح idempotency.