Capture API
Methods to start a session
| الطريقة | الوصف |
|---|---|
prepareSelfieCamera(_:config:) | يُعدّ كاميرا الصورة الشخصية |
prepareSelfieCamera(_:config:prepareInfo:) | يُعدّ كاميرا الصورة الشخصية مع بيانات PrepareInfo الوصفية |
prepareDocumentCamera(_:config:) | يُعدّ كاميرا المستند |
open(_:webAppToken:) | يفتح كاميرا الصورة الشخصية المُعدَّة، مع تمرير process.webAppToken الذي يُرجعه Create Process |
openDocument(_:delegate:) | يفتح كاميرا المستند المُعدَّة مع DocumentEnums |
Capture options / parameters
PrepareInfo — بيانات وصفية لتحديد جلسة المستخدم.
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
externalUserId | String | نعم | معرّف المستخدم داخل نظامك. يُشفَّر بـ SHA-256 قبل الإرسال. |
useCase | String | لا | معرّف السياق أو التدفق الجاري تنفيذه. يُرسَل كنص عادي. |
DocumentEnums — انظر Enums.
Result types and fields
SelfieResult — الكائن المُعاد عند نجاح التقاط الصورة الشخصية.
| الحقل | النوع | الوصف |
|---|---|---|
base64 | String | الصورة الملتقطة بتنسيق Base64 |
encrypted | String | JWT يُرسَل إلى الخادم الخلفي |
SuccessResult — الكائن المُعاد بواسطة onSuccess في تكامل Unico API.
| الحقل | النوع | الوصف |
|---|---|---|
processId | String | معرّف العملية المُستخدَم للاستعلام عن نتيجة التحقق عبر واجهة REST API |
DocumentResult — الكائن المُعاد عند نجاح التقاط المستند. نفس حقول SelfieResult.