الانتقال إلى المحتوى الرئيسي
استخدم حقول config التالية داخل كل عنصر من عناصر المصفوفة features في طلبات POST /v3/workflows/ وPATCH /v3/workflows/{settings_uuid}/.
تُنشئ واجهة برمجة تطبيقات سير العمل v3 سير عمل خطياً قائماً على العقد من المصفوفة المرتبة features. أرسل الميزات بترتيب التنفيذ الدقيق.
أي محرك يشغّل ميزة، سواء كان محرك Didit الخاص أو مزوداً خارجياً، ليس أحد حقول config أدناه. تتم إدارته من خلال Marketplace في الكونسول، الذي يضبط provider_key وfallback_to_native في كائن config الخاص بالميزة نيابةً عنك.

قواعد التحقق

  • تكون قيمة OCR الافتراضية شاملة لجميع الدول وأنواع المستندات المدعومة عندما يُحذف config.documents_allowed أو يكون null أو {}. إذا أرسلت كائن documents_allowed مخصصاً، فيجب أن يحتوي على دولة صالحة واحدة على الأقل ونوع مستند مفعّل واحد على الأقل. يمكن لإعداد كل مستند أن يضبط sides على 1 لالتقاط الوجه الأمامي فقط، أو على 2 لالتقاط الوجهين الأمامي والخلفي.
  • يتطلب QUESTIONNAIRE وجود config.questionnaire_uuid.
  • يتطلب KYB_DOCUMENTS وجود config.kyb_required_document_groups.
  • يرفض SIGNATURE القيمة signature_level: "qes" مع الخطأ qes_not_available إلى أن تصبح التواقيع المؤهلة متاحة، ويرفض خطوة جديدة بقيمة signature_level: "aes" مع الخطأ aes_not_available ما دام signature_availability.aes يساوي false في سير العمل. ويجب أن تكون مستنداته موجودة عند إنشاء الجلسة: فإذا كان signature_documents_source يساوي workflow، تحتاج الخطوة إلى مستندات مرفوعة في الكونسول، وتبقى الخطوة التي لا تحتوي على أي مستندات مسودةً، لكنها لا تستطيع أن تُفعَّل. أما مع session، فيجب أن يرسل كل طلب إنشاء الحقل sign.documents.
  • يجب أن يأتي FACE_MATCH بعد OCR في طلبات سير العمل البسيطة.
  • يتطلب NFC وDATABASE_VALIDATION وجود OCR عندما يظهران في سير العمل نفسه. ويحتاج AML إلى واحدة من OCR أو KYB_REGISTRY أو DOCUMENT_AI قبله. ومع وجود DOCUMENT_AI وحده قبله، يجب أن يكون full_name المراد فحصه قابلاً للتعبئة، إما من حقل Document AI سابق مُعرَّف بالمفتاح full_name، فيُربط تلقائياً، وإما من إدخال صريح في config.aml_field_sources (انظر AML).
  • تتطلب الميزات الفرعية لـ KYB مثل KYB_DOCUMENTS وKYB_KEY_PEOPLE وجود KYB_REGISTRY سابقاً في سير العمل.
  • سير العمل إما أن يكون سير عمل للأشخاص (KYC) أو سير عمل للشركات (KYB)، ولا يمكن أن يكون الاثنين معاً. يمكن لسير العمل الذي يستخدم أي ميزة KYB (KYB_REGISTRY أو KYB_DOCUMENTS أو KYB_KEY_PEOPLE) أن يجمعها فقط مع AML وDOCUMENT_AI وQUESTIONNAIRE وPHONE_VERIFICATION وEMAIL_VERIFICATION وIP_ANALYSIS وSIGNATURE. ولا يمكن أن يتضمن ميزات خاصة بالأشخاص مثل OCR وLIVENESS وFACE_MATCH وNFC وPROOF_OF_ADDRESS وDATABASE_VALIDATION أو AGE_ESTIMATION، ولا يمكن لسير عمل الأشخاص أن يتضمن ميزات KYB. وفي سير عمل الشركات، يقارن DOCUMENT_AI أي حقل مُعلَّم بـ is_full_name بالشركة المُتحقَّق منها بدلاً من مقارنته بشخص. للتحقق من الأشخاص الذين يقفون وراء شركة، أنشئ سير عمل KYC منفصلاً وأشر إليه من عقدة KYB_KEY_PEOPLE باستخدام kyb_ubo_verification_workflow أو kyb_officer_verification_workflow أو kyb_shareholder_verification_workflow.
  • تستخدم حقول الإجراء DECLINE أو REVIEW أو NO_ACTION ما لم يذكر الحقل أدناه أنه مقيّد.
  • حقول الدرجة والحد أرقام من 0 إلى 100 ما لم تُذكر نطاقات أضيق.

قواعد الحالة المشتركة

تدعم كل ميزة مصفوفة اختيارية باسم status_rules. استخدمها لتجاوز حالة الميزة عندما يتطابق شرط على حقل معيّن.
اقرأ المثال أعلاه على النحو التالي: kyc.extra_fields.profession يطابق بالتقريب Soft. Engineer بحد أدنى للدرجة 80 ← تعيين حالة الميزة إلى Declined. في ميزة التحقق من الهوية، استهدف قيم extra_fields المستخرجة مثل kyc.extra_fields.profession، أو تواريخ صلاحية فئة رخصة القيادة مثل kyc.extra_fields.dl_class_code_b_from وkyc.extra_fields.dl_class_code_b_to، أو رموز القيود أو المعلومات الخاصة بكل فئة مثل kyc.extra_fields.dl_class_code_b_notes (العمود 12 من رخص القيادة البريطانية). تأتي هذه القيم من كائن extra_fields في نتيجة OCR، وليست جزءًا من expected_details.
حقلا dl_class_code_*_from وdl_class_code_*_to يكونان دائمًا إما تاريخ ISO صالحًا أو غائبين من extra_fields. لا يُرجع Didit أبدًا نص OCR غير قابل للقراءة في حقل تاريخ. إذا تعذّر قراءة خلية جدول الفئات، يُحذف الحقل بدلًا من إرساله كنص خام. لذلك استخدم العامل is_empty لتوجيه تواريخ الفئات غير القابلة للقراءة، ولا تفترض أن الحقل موجود دائمًا.
بالنسبة إلى حقول التاريخ، استخدم value_type: "relative_date" مع كائن قيمة بالشكل { "direction": "past" | "future", "amount": number, "unit": "days" | "months" | "years" }. على سبيل المثال، يطابق operator: "less_than" مع { "direction": "past", "amount": 3, "unit": "years" } التواريخ الأقدم من ثلاث سنوات من اليوم.

المقارنة مع خطوة محددة

يمكن لسير عمل بياني أن يشغّل الميزة نفسها أكثر من مرة، مثلًا ثلاث خطوات من التحقق من الهوية. مع value_type: "field"، أضف @<node_id> إلى القيمة لقراءتها من خطوة معيّنة. يجب أن تكون العقدة المشار إليها خطوة ميزة تُنفَّذ دائمًا قبل خطوة القاعدة نفسها، في كل مسار يصل إليها، أو أن تكون خطوة القاعدة نفسها. القيمة التي لا تحتوي على اللاحقة تُقرأ من خطوة القاعدة نفسها.
اقرأ هذه القاعدة، المعيّنة على الخطوة الثالثة من التحقق من الهوية، على النحو التالي: kyc.full_name في هذه الخطوة يطابق بالتقريب الاسم الكامل الذي قرأته الخطوة ocr_1 بحد أدنى للدرجة 80 ← تعيين حالة الميزة إلى Declined. في الكونسول، تعرض أداة اختيار المتغيرات كل خطوة مؤهلة برقمها على لوحة التصميم، وتضيف اللاحقة نيابةً عنك.

OCR / التحقق من الهوية

قيمة الميزة: OCR.
يُضبط كشف حيوية المستند بالحدود الستة document_liveness_* أعلاه، لا بحقول إجراء لكل إشارة. الحقول portrait_replacement_action وprinted_copy_action وscreen_capture_action إعدادات على مستوى الحساب، ولا تُقبل في إعدادات ميزات سير العمل: تُزيل الواجهة البرمجية مفاتيح الإعدادات غير المعروفة عند الحفظ، لذا لا يكون لإرسالها أي أثر. لكل إشارة حد رفض وحد مراجعة على مقياس من 0-100، حيث تعني الدرجة الأعلى أن المستند أكثر احتمالاً أن يكون أصلياً.
مثال:

الطرق حسب الدولة

تُفهرس methods حسب رمز الدولة ISO 3166-1 alpha-3. تحمل كل دولة ما يصل إلى ثلاثة كائنات طرق، وأي طريقة تتركها دون تحديد تأخذ قيمتها الافتراضية.
wallet.on_failure هو fallback_to_document أو decline أو retry. يُبقي retry (للمحفظة فقط، مع إيقاف التقاط المستند في الدولة) المستخدمَ الذي لم يُكمل تسجيل الدخول في خطوة المحفظة قادراً على المحاولة مرة أخرى. ولا تُرفض الجلسة بسبب ذلك، وتبقى مفتوحة حتى يُكمل المستخدم العملية أو تنتهي صلاحية الجلسة. تقبل مفاتيح id_lookup القيمتين fallback_to_document أو decline فقط. لإبقاء المستندات بعيدة عن الشاشة الأولى وعرضها فقط عندما لا تُفضي المحفظة أو عملية البحث إلى نتيجة، اضبط document.fallback_only. يستخدم المثال فنلندا، حيث تأتي Finnish Trust Network أولاً ويكون التقاط المستند هو البديل. تحتاج فنلندا أيضاً إلى تفعيل أنواع مستنداتها في documents_allowed (مثل جواز السفر وبطاقة الهوية)، حتى يكون لدى البديل مستندات يعرضها.
عمليتا البحث المذكورتان أعلاه بحالة available في الكتالوج الحالي، لذا يُحفظ هذا الإعداد كما هو مكتوب. تم حذف كتلة المحفظة من هذا المثال عن قصد: لا تُحفظ المحفظة إلا في دولة يُعلّمها الكتالوج بحالة available، ويُرفض wallet.enabled: true في أي دولة أخرى فيُسقط معه الحفظ كاملاً، بما في ذلك إعدادات البحث. حيث يُعلّم الكتالوج المحفظة بحالة available، أضفها إلى تلك الدولة:
التحقق الذي تطبّقه الواجهة البرمجية عند الحفظ:
  • يُرفض رمز الدولة غير المعروف، أو مفتاح غير معروف داخل دولة، أو مفتاح غير معروف داخل طريقة. لا يُتجاهل أي شيء بصمت.
  • تُرفض الدولة التي لا تكون فيها أي طريقة مفعّلة، لأن أحداً فيها لن يستطيع التحقق.
  • يمكن للمحفظة أو الاستعلام أن يعودا إلى التقاط المستند فقط عندما يكون التقاط المستند مفعّلاً في تلك الدولة. تؤدي fallback_to_document في دولة تكون فيها قيمة document.enabled هي false إلى الرفض وقت التشغيل، لأنه لا يوجد مسار للرجوع إليه.
  • يُرفض document.fallback_only: true بالرمز HTTP 400 ما لم تكن قيمة document.enabled هي true وتتضمن محفظة واحدة على الأقل أو استعلاماً واحداً على الأقل عن الهوية في تلك الدولة يعود إلى التقاط المستند.
يطبّق التنفيذ الحالي في بيئة الاختبار المفتاح id_lookup.response_fields على مخرجات المقارنة، والجنس عندما يكون اختيارياً، والصور الشخصية المحفوظة من السجل. وتبقى حقول الهوية المطلوبة جزءاً من سجل التحقق. هذا ليس ضماناً بأن كل حمولة وسيطة من المزوّد مستثناة من المعالجة. لم يُتحقق من الإطلاق الإنتاجي لهذا التغيير، فتأكد من السلوك في بيئتك المستهدفة قبل الاعتماد على اختيار الحقول لتلبية متطلبات الاحتفاظ بالبيانات.
اطّلع على كتالوج الإمكانات قبل كتابة methods، سواء عبر تبويب الدول في الكونسول أو باستخدام أداة MCP ‏didit_workflow_get_id_verification_methods_catalog. يرد السلوك والتغطية والفوترة في صفحة طرق التحقق من الهوية.

NFC / جواز السفر الإلكتروني

قيمة الميزة: NFC.

كشف الحيوية

قيمة الميزة: LIVENESS.

مطابقة الوجه

قيمة الميزة: FACE_MATCH.

تقدير العمر

قيمة الميزة: AGE_ESTIMATION.

التحقق من رقم الهاتف

قيمة الميزة: PHONE_VERIFICATION. التحقق من الهاتف معطّل إلى أن تُكمل المؤسسة أول عملية شحن للرصيد.
إثراء استخبارات الهاتف إضافة اختيارية. عندما تكون قيمة phone_enrichment_enabled هي true، يُثرى كل تحقق مكتمل من الهاتف باستخبارات الهاتف، ويُحتسب $0.05 عن كل طلب بالإضافة إلى تكلفة التحقق من الهاتف المعتادة. لا تُطبَّق الإجراءات القائمة على الدرجة إلا بعد توفر درجة الإثراء، أما إجراءات مؤشر الثقة ونوع الهاتف والنقل فتُطبَّق بمجرد تشغيل الإثراء.فحص البصمة الاجتماعية إضافة ثانية ومنفصلة. عندما تكون قيمة phone_social_enabled هي true، يُبلغ كل تحقق مكتمل من الهاتف أيضاً عن المنصات الإلكترونية المسجل فيها الرقم، أي منصات المراسلة ووسائل التواصل الاجتماعي والتجارة الإلكترونية والخدمات المهنية، ويُحتسب $0.05 عن كل طلب. يمكن تفعيلها مع phone_enrichment_enabled أو من دونها، فالإضافتان مسعّرتان ومحتسبتان بشكل مستقل. يُعدّ الاستعلام الذي لا يجد الرقم في أي من المنصات التي يغطيها إجابةً صالحة وقابلة للفوترة، ويُفعّل phone_no_social_presence_action. استخدم phone.social_profiles_registered (عدد المنصات المسجل فيها الرقم) للتفريع حسب النتيجة في مخطط سير العمل.

التحقق من البريد الإلكتروني

قيمة الميزة: EMAIL_VERIFICATION.
إثراء ذكاء البريد الإلكتروني إضافة اختيارية. عندما تكون قيمة email_enrichment_enabled هي true، تُثرى كل عملية تحقق مكتملة من البريد الإلكتروني بذكاء البريد الإلكتروني، وتُحتسب $0.05 عن كل طلب إضافةً إلى التكلفة القياسية للتحقق من البريد الإلكتروني. يسري الإجراء المعتمد على الدرجة بمجرد توفر درجة الإثراء، وتسري إجراءات الاختراق بمجرد تشغيل الإثراء.فحص البصمة الاجتماعية إضافة ثانية ومستقلة. عندما تكون قيمة email_social_enabled هي true، تُبلغ كل عملية تحقق من البريد الإلكتروني تكتمل أيضًا عن المنصات الإلكترونية التي يُسجَّل فيها العنوان، ومنها مزودو البريد الإلكتروني ووسائل التواصل الاجتماعي والخدمات المهنية والتجارة الإلكترونية والترفيه، وتُحتسب $0.05 عن كل طلب. يمكن تفعيله مع email_enrichment_enabled أو دونه، لأن الإضافتين مسعّرتان ومفوترتان بشكل مستقل. يُعدّ البحث الذي لا يجد العنوان في أي من المنصات التي يغطيها إجابةً صالحةً وقابلةً للفوترة، ويُفعّل email_no_social_presence_action. استخدم email.social_profiles_registered (عدد المنصات المسجَّل فيها العنوان) للتفريع حسب النتيجة في مخطط سير العمل.

التحقق من قواعد البيانات

قيمة الميزة: DATABASE_VALIDATION. مثال:
database_validation_countries هو ما يجعل هذه الخطوة تُنفّذ أي فحص. تُقبل ميزة DATABASE_VALIDATION المحفوظة من دونه، ثم لا تُنفّذ أي فحص على الإطلاق، لذا أرسل دائماً دولة واحدة على الأقل مع معرّف خدمة واحد على الأقل.
يُرفض معرّف الخدمة الذي لا تستطيع الخطوة تشغيله برمز 400 يذكره ويوضح السبب، ولا يُحفظ شيء. ويشمل ذلك معرّفاً غير موجود في الكتالوج، ومعرّفاً يتبع دولة أخرى، وخدمةً غير متاحة بعد، وخدمةً تُقدَّم فقط عبر endpoint المستقلة POST /v3/database-validation/. تُرفض بالطريقة نفسها الخدمة التي لا توفّر أي خطوة سابقة مدخلاتها، مع سرد المدخلات الناقصة. تُحذف الخدمة التي يحملها سير العمل المحفوظ ولم تعد قابلة للتشغيل عند حفظه مرة أخرى. على سبيل المثال، يقرأ سير العمل الأرجنتيني رقم DNI والجنس من التحقق من الهوية، ويطابقهما مع RENAPER من دون صورة سيلفي:
استخدم arg_renaper بدلاً من ذلك، بعد خطوة LIVENESS، لمطابقة صورة السيلفي أيضاً مع الصورة التي يحتفظ بها RENAPER. راجع RENAPER لمعرفة درجة مطابقة الوجه والحد المعتمد لها.

التحقق من الحساب البنكي

قيمة الميزة: BANK_VERIFICATION. يتحقق المستخدم من حساب بنكي، ثم تُقارَن هوية صاحب الحساب التي يبلّغ عنها البنك بالهوية التي أثبتتها خطوة سابقة في سير العمل. يتم ذلك بإحدى طريقتين: تسجيل الدخول إلى البنك (open_banking)، حيث يسجّل المستخدم الدخول لدى بنكه، أو فحص الحساب (account_lookup)، حيث يكتب المستخدم بيانات حسابه ويؤكد البنك الاسم المرتبط به. يحدد bank_method_order وmethods في كل دولة الطرق التي تقدمها الدولة وأيّها يأتي أولاً؛ راجع طرق التحقق من الحساب البنكي. تُنتج الخطوة أدلة، وهي درجة تطابق اسم صاحب الحساب والمقارنة التي أنتجتها ورموز الأسباب، ثم تحوّل مفاتيح bank_*_action هذه الأدلة إلى حالة. يحدد أمران ما إذا كانت العقدة تعمل أصلاً. bank_countries قائمة بيضاء، فالخريطة الفارغة لا تعرض أي بنك ولا تُجري أي فحص. ويحتاج صاحب الحساب إلى ما يُقارَن به: أضف قبل العقدة خطوة OCR أو DATABASE_VALIDATION أو QUESTIONNAIRE، أو أرسل expected_details عند إنشاء الجلسة، أو اربط الحقول بنفسك عبر bank_field_sources. وبدون أيّ من ذلك لا يمكن أن تكون الملكية إلا unknown، وهذا ما يحدد bank_reference_identity_missing_action كيفية التعامل معه.
ما زال التحقق من الحساب البنكي قيد الإطلاق، لذا لا تُقبل عقدة BANK_VERIFICATION إلا في حساب فعّلت فيه هذه الميزة. وفي غير ذلك يُرفض الحفظ ويوضح ذلك. والمسار الذي تُنفَّذ به الخطوة لا يُضبط هنا أيضاً: فهو زوج provider_key وfallback_to_native الذي تضبطه لك Marketplace في وحدة التحكم.

ربط الحساب

عندما لا يستطيع المستخدم التحقق

يستطيع المستخدم دائماً المتابعة دون بنك، ولا تترك الخطوة المستخدم عالقاً أبداً. راجع عندما لا يتمكن الشخص من التحقق من حسابه البنكي. ما يترتب على متابعة المستخدم للجلسة يحدده bank_unsupported_action أو bank_attempts_exhausted_action أو bank_skipped_action، بحسب سبب المتابعة، ما لم تكن محاولة قُيّمت قبله قد حسمت الخطوة بالفعل: راجع إجراءات الحكم.

مقارنة صاحب الحساب

فحص الحساب

تنطبق هذه المفاتيح على فحص الحساب وحده. يحتفظ تسجيل الدخول إلى البنك بتطابقاته القريبة وbank_max_attempts الخاص به.

البيانات المالية

يعمل bank_expected_currencies مع موافقة ownership الافتراضية وحدها. أما المفاتيح الثلاثة الأخرى فتقرأ بيانات مالية حقيقية، لذلك يحتاج كل منها إلى نطاق الموافقة المطابق له في bank_scopes، ويُرفض الحفظ بدونه.

ما يُخزَّن

إجراءات القرار

يقبل كل مفتاح هنا القيم DECLINE أو REVIEW أو NO_ACTION ما لم يكن مقيّدًا، ويعود إلى القيمة الافتراضية أدناه إذا حذفته أو أرسلت null. لا يُعتمد افتراضيًا أي شيء ليس دليلًا إيجابيًا على الملكية، ولا يُرفض الطلب إلا عند وجود دليل ثابت ضد المستخدم.

ضوابط إضافية

هذه المفاتيح اختيارية. يقبل كل مفتاح إجراء القيم DECLINE أو REVIEW أو NO_ACTION. مثال لكائن config، لحساب يكون فيه التحقق البنكي مفعّلاً والمسار الذي اخترته يغطي الدولة التي تدرجها:
bank_countries هو ما يجعل هذه الخطوة تعمل فعلاً، ويُتحقَّق منه مقابل المسار الذي تعمل عليه العقدة، لا مقابل قائمة عامة. تُرفض عند الحفظ أي دولة لا يستطيع ذلك المسار فيها إثبات ملكية الحساب، ويُذكر اسمها في الخطأ، لذا اقرأ الخطأ ولا تفترض أن الدولة قُبلت وستُتخطى وقت التشغيل.

AML

قيمة الميزة: AML. لفحص الأشخاص وفق KYC، استخدم الحقول التالية: للفحص الخاص بالشركات وفق KYB، استخدم الحقول التالية:

فحص كيان استخرجته خطوة Document AI

تقرأ خطوة AML عادةً الجهة التي تفحصها من خطوة OCR (شخص) أو من خطوة KYB_REGISTRY (شركة). أما سير العمل الذي تكون خطوة الاستخراج الوحيدة فيه هي DOCUMENT_AI، أي المستندات غير الموحدة مثل شهادة ضريبية أو عقد تأسيس، فلا يتوفر فيه أيٌّ من الخطوتين، لذا يجب أن يحدد مصدر كل مدخل من مدخلات الفحص. مثال: فحص الشركة المذكورة في acta constitutiva مكسيكية، من دون أي مستند هوية في سير العمل:
إذا لم تكن هناك خطوة OCR ولا خطوة KYB_REGISTRY قبلها، يجب أن تكون خطوة AML قادرة على تعبئة full_name، إذ لا يوجد بحث لدى المزود من دون اسم. سير العمل الذي لا يربط أي مدخل، أو الذي يربط مفتاح Document AI لا تستخرجه أي خطوة سابقة، يُرفض عند الحفظ بدلًا من أن يُحفظ ولا يفحص شيئًا. دقة AML تتبع مباشرةً عدد المعرّفات التي تقدمها: الفحص بالاسم فقط هو ما يُنتج حجمًا كبيرًا من الإيجابيات الكاذبة.

تحليل الجهاز وعنوان IP

قيمة الميزة: IP_ANALYSIS. مثال:
استخدم recovered_device_action بشكل منفصل عن duplicated_device_action عندما تريد مراقبة الأجهزة المستردة بثقة عالية قبل رفضها تلقائياً. هذا مفيد أثناء الإطلاق التدريجي، لأن مطابقات الأجهزة المستردة مصممة لكشف حلقات الاحتيال، لكن ينبغي معايرتها مع حركة المرور الخاصة بك.

التحقق من الموقع

قيمة الميزة: GEOLOCATION. يتحقق من موقع الشخص أثناء التحقق، استناداً إلى موقع الجهاز أو موقع عنوان IP للاتصال، مقارنةً بالمناطق المسموح بها والمناطق المحظورة وموقع عنوان IP وعنوان المستند. راجع التحقق من الموقع لمعرفة طريقة عمل الخطوة، وتقريرها لحقول القرار. ضعها بعد التحقق من الهوية أو إثبات العنوان إذا أردت قياس المسافة إلى عنوان المستند، لأن المسافة لا تُقاس إلا عند وجود عنوان مسجَّل. عندما يكون geolocation_position_source غير مضبوط، تحتاج المسافة إلى موقع عنوان IP إلى خطوة تحليل الجهاز وعنوان IP في سير العمل نفسه. جميع المفاتيح اختيارية: الخطوة ذات config فارغ تطلب من الجهاز موقعاً بدقة 250 متراً، لا يتجاوز عمره 120 ثانية، وتمنح الشخص 3 محاولات، ولا تطبّق أي قاعدة للمناطق. لكل نتيجة مفتاح إجراء خاص بها. ويأخذ مفتاح الإجراء الذي تتركه غير مضبوط القيمةَ الافتراضية لـgeolocation_preset الذي اخترته، أو القيمةَ الافتراضية لكل مفتاح المذكورة أدناه إذا لم تختر أي إعداد مسبق. يكون الإجراء الافتراضي للموقع غير المؤكد أو المرفوض هو REVIEW، وليس DECLINE أبداً، لأن رفض الإذن أو اتساع نصف القطر ليس دليلاً على الاحتيال. الإجراء الذي تحدده صراحةً يتقدّم دائماً على الإعداد المسبق. التحدي المُعاد تشغيله (LOCATION_REPLAY_DETECTED) والتحقق من سلامة الجهاز الفاشل (LOCATION_INTEGRITY_FAILED) يؤديان دائماً إلى الرفض، ولا يملكان مفتاح إجراء.

أشكال المناطق

لكل عنصر في geolocation_areas معرّف id (من 1 إلى 64 حرفاً من A-Z a-z 0-9 _ -، وفريد في القائمة)، وlabel اختياري (حتى 80 حرفاً)، وtype قيمته allowed أو blocked، وkind يحدد شكل المنطقة. تحتوي القائمة على 50 منطقة كحد أقصى، ويجب أن تتضمن منطقة allowed واحدة على الأقل عندما تكون is_geolocation_geofencing_enabled مساوية لـ true. لا يمكن إرسال geolocation_areas وgeolocation_geofencing_by_country معاً، وgeolocation_refusal_path: "end_session" يتطلب أن تكون geolocation_permission_denied_action مساوية لـ REVIEW أو DECLINE. ترفض API المنطقة التي لا يمكن أن تتطابق أبداً، مثل منطقة من دولة لا تتوفر لها حدود منشورة، ولا تحفظها. مثال:

إثبات العنوان

قيمة الميزة: PROOF_OF_ADDRESS.

الاستبيانات

قيمة الميزة: QUESTIONNAIRE.

سجل الشركات (KYB)

قيمة الميزة: KYB_REGISTRY. يربط kyb_registry_fields_config كل مفتاح حقل قابل للتهيئة بالكائن {"enabled": bool, "required": bool}. تعني enabled: false إخفاء الحقل، وتعني enabled: true, required: false عرضه كحقل اختياري، وتعني enabled: true, required: true جعله إلزاميًا عند الإرسال. تبقى company_name وcountry_code وregion دائمًا ظاهرة ومطلوبة، ولا يمكن تهيئتها. عندما يُحذف الكائن، أو يكون null أو {}، تُطبّق القيمة الافتراضية: يكون incorporation_date وحده مطلوبًا، وكل حقل آخر اختياري.
مفاتيح الحقول القابلة للتهيئة: registration_number، incorporation_date، legal_address، vat_number، alternative_names، tax_number، company_type، legal_entity_identifier، location_of_registration، nature_of_business، registered_capital_amount، registered_capital_currency، website، email، phone، control_scheme. انظر حقول نموذج السجل القابلة للتهيئة لمعرفة سلوك المستخدم النهائي، والتحقق من ضريبة القيمة المضافة والرقم الضريبي لمعرفة كيفية التحقق من vat_number وtax_number.

مستندات KYB

قيمة الميزة: KYB_DOCUMENTS.

الأشخاص الرئيسيون في KYB

قيمة الميزة: KYB_KEY_PEOPLE.

Document AI

قيمة الميزة: DOCUMENT_AI. يطلب من المستخدم مستنداً واحداً أو أكثر، ويستخرج الحقول المسمّاة التي تحددها باستخدام نموذج رؤية. يصبح كل حقل مُعدّ قيمة قابلة للتفرع document_ai.<key>، وتكون نتيجة الخطوة في document_ai.status. كل عنصر في document_ai_documents هو مستند: كل عنصر في fields الخاص بالمستند هو حقل: مثال:

التوقيع الإلكتروني

قيمة الميزة: SIGNATURE. تتيح للشخص المتحقَّق منه، أو للأشخاص الرئيسيين في الشركة، التوقيع على المستندات، بالمستوى البسيط (الافتراضي) أو المتقدم (AES). ضعها بعد الخطوات التي تتحقق من الموقِّع: التحقق من الهوية، والتحقق من البريد الإلكتروني أو رقم الهاتف للحصول على الرمز. راجع التوقيع الإلكتروني. تُوضع الحقول الموجودة في مستندات سير العمل في محرر القوالب في الواجهة. أما مستندات الجلسة، فأرسل حقولها في sign.documents[].fields، وأرسل قيم حقول api.<key> في sign.field_values. راجع إنشاء جلسة. مثال للمستندات المُرسلة مع كل جلسة:
آخر تعديل في ٧ نوفمبر ٢٠٢٦