إنشاء عملية
تتعامل نقطة النهاية هذه مع ثلاثة منتجات تشترك في نفس المسار لكنها تختلف في معاملات الجسم والإمكانيات وحقول الاستجابة:
- التأهيل - يتحقق من هوية المستخدم عن طريق مقارنة وجهه مع قاعدة هويات Unico (مطلوب
subject.duiType+subject.code). - المعاملات - يتحقق من أنه نفس الشخص من عملية سابقة عن طريق مقارنة وجه بوجه (مطلوب
referenceProcessIdأو مصفوفةreferencesمع صورة سيلفي / معرّف عملية). - Cardholder Verification - يؤكد أن البطاقة تخص حاملها المُعلَن، دون أي التقاط لصورة سيلفي (مطلوب
subject.code+card). يمكن اختيارياً إعادة استخدام عملية تم التحقق منها مسبقاً عبرreferenceProcessIdلتشغيل بوابة إعادة الاستخدام؛ بدونها، تُعيد الاستجابة تلقائياً النتيجةunsure. انظر إمكانية Cardholder Verification.
يتم تحديد المنتج النشط بواسطة APIKEY المرسل في ترويسة الطلب.
للاطلاع على تدفق التكامل الكامل، انظر نظرة عامة على API.
نقطة النهاية
| البيئة | الرابط |
|---|---|
| الإنتاج | POST https://api.id.unico.app/processes/v1 |
| Sandbox | POST https://api.id.uat.unico.app/processes/v1 |
الطلب
الترويسات
| الترويسة | القيمة |
|---|---|
Authorization | Bearer <access_token> (انظر المصادقة) |
APIKEY | مفتاح API المخصص - يحدد المنتج النشط والإمكانيات المفعّلة. |
Content-Type | application/json |
معاملات الجسم
- التأهيل
- المعاملات
- Cardholder Verification
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
subject.duiType | integer | نعم | معرّف نوع الوثيقة. انظر قيم duiType أدناه. |
subject.code | string | نعم | قيمة المعرف كما هو محدد بواسطة subject.duiType. بدون نقاط أو شرطات. |
subject.name | string | لا | الاسم الكامل. |
subject.gender | string | لا | M أو F. |
subject.birthDate | string (ISO 8601) | لا | تاريخ الميلاد (YYYY-MM-DD). |
subject.email | string | لا | عنوان البريد الإلكتروني. |
subject.phone | string | لا | رقم هاتف E.164. |
subject.clientReference | string | مشروط | المعرّف الفريد للمستخدم في نظامك. مطلوب لقدرة حسابات متعددة. فريد في قاعدتك، بحد أقصى 256 حرفاً وبدون مسافات. |
useCase | string | لا | سياق العملية، مثلاً Onboarding. |
subsidiaryId | string | لا | معرف الفرع — مطلوب فقط إذا كانت هناك فروع متعددة. |
imageBase64 | string | نعم | صورة سيلفي ملتقطة بواسطة واجهتك الأمامية، بتنسيق base64. |
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
references | array | مشروط | مدخلات مرجعية لتدفقات التحقق 1:1. كل عنصر يحتوي على referenceType (REFERENCE_TYPE_IMAGE_BASE64 أو REFERENCE_TYPE_PROCESS_ID) وreferenceContent (صورة مشفرة بـ base64 أو UUID عملية). |
referenceProcessId | string | مشروط | مهمل. استخدم references بدلاً منه. معرّف عملية التأهيل المرجعية للمقارنة معها. إذا كان المرجع عملية by-Unico، استخدم authenticationInfo.authenticationId. |
imageBase64 | string | نعم | صورة سيلفي ملتقطة بواسطة واجهتك الأمامية، بتنسيق base64. |
subject | object | لا | حاوية معلومات المستخدم. |
subject.duiType | string | لا | نوع المعرف. القيم المحتملة: DUI_TYPE_BR_CPF، DUI_TYPE_MX_CURP، DUI_TYPE_US_SSN، DUI_TYPE_NG_NIN، DUI_TYPE_AR_DNI، DUI_TYPE_ID_NIK. |
subject.code | string | لا | قيمة المعرف كما هو محدد بواسطة subject.duiType. بدون نقاط أو شرطات. |
subject.name | string | لا | الاسم الكامل للمستخدم. |
subject.gender | string | لا | M أو F. |
subject.birthDate | string (ISO 8601) | لا | تاريخ الميلاد (YYYY-MM-DD). |
subject.email | string | لا | عنوان البريد الإلكتروني. |
subject.phone | string | لا | رقم هاتف E.164. |
useCase | string | لا | سياق العملية، مثلاً Transactional. |
subsidiaryId | string | لا | معرّف الفرع - مطلوب فقط إذا كانت هناك فروع متعددة. |
معلومة
لهذا المنتج، لا يمكن التنسيق مع درجة المخاطر. يتم دائماً إرجاع النتيجة بشكل متزامن في استجابة POST.
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
subject.duiType | integer | نعم | معرّف نوع الوثيقة. انظر قيم duiType أدناه. حالياً DUI_TYPE_BR_CPF فقط. |
subject.code | string | نعم | CPF حامل البطاقة الجاري التحقق منه. بدون نقاط أو شرطات. |
card.bin | string | مشروط | أول 6 أو 8 أرقام من البطاقة (BIN). مطلوب مع card.last4. |
card.last4 | string | مشروط | آخر 4 أرقام من البطاقة. مطلوب مع card.bin. |
card.name | string |