مستندات سرویس Customize PWA احراز هویت آنلاین
e-KYC Customize PWA Documents
فهرست مطالب
نسخه 1.0.0 - 02/21/2024
بخش اول: فراخوانی PWA
این بخش مربوط به هدایت کاربر به سرویس احراز هویت آنلاین یوآیدی می‌باشد.
۱. مقدمه
تمام مواردی که در مستندات ذکر شده است مربوط به راه اندازی PWA یوآیدی می‌باشد.
۲. روند احراز هویت در وب اپلیکیشن یوآیدی
همانطور که میدانید یوآیدی یک سیستم احراز هویت آنلاین می‌باشد و اطلاعات دریافتی شما از این سرویس توسط شخص کاربر ارائه شده است که صحت این اطلاعات و عواقب آن برعهده‌ی کاربر می‌باشد.
برای استفاده از وب اپلیکیشن لازم است پارامترهای مورد نیاز را از طریق URL به وب اپلیکیشن یوآیدی، هنگام اجرا کردن به آن انتقال دهید.
۳. فراخوانی PWA احراز هویت یوآیدی
برای استفاده از سرویس PWA یوآیدی لینک وب اپلیکیشن را با پارامترهای مشخص در اپلیکیشن خود ایجاد کنید.
۱.۳. ایجاد URL
آدرس زیر را با استفاده از پارامترها ایجاد و توسط کلاینت کاربر فراخوانی نمائید:
https://ca-bff.u-id.net/?mobile_number=MOBILE_NUMBER&business_id=UID_BUSINESS_ID&business_meta_data=METADATA
۲.۳. پارامترها
| Field | Type | Kind | Description |
| business_id | string | Required | شناسه کسب‌و‌کار یا BusinessID (توسط یوآیدی در اختیار شما قرار می‌گیرد) |
| mobile_number | string | Optional | تلفن همراه کاربر با فرمت ۰۹xxxxxxxxx – در صورتی که این پارامتر مقدار داشته باشد، فیلد تلفن همراه در گام اول احراز هویت به صورت Auto-fill و غیرقابل ویرایش تکمیل می‌شود.* |
| business_meta_data | string | Optional | مقدار اختیاری کسب و کار جهت رصد کاربر |
۴. خاتمه فرآیند احراز هویت و بازگشت به وبسایت پذیرنده
پس از خاتمه فرآیند احراز هویت آنلاین کاربر، یوآیدی کاربر را به آدرسی که قبلا توسط پذیرنده اعلام شده است هدایت می‌کند.
۱.۴. نمونه لینک برگشت به وب سایت پذیرنده (Redirect)
شامل آدرسی است که قبلا توسط پذیرنده به یوآیدی اعلام شده است و پس از خاتمه فرآیند احراز هویت در یوآیدی، به این آدرس ریدایرکت انجام می‌گیرد. به عنوان مثال:
Get - https://UID_BUSINESS_DOMAIN.COM/UID-LANDING?status=<STATUS>&business_meta_data=<METADATA>
۲.۴. پارامترها
| Field | Type | Kind | Description |
| status | ENUM | Int | Required | RESULT_STATUS_UNDEFINED = 0; RESULT_STATUS_SUCCESS = 1; RESULT_STATUS_CAMERA_NOT_SUPPORTED = 2; RESULT_STATUS_PERMISSIONS_NOT_GRANTED = 3; RESULT_STATUS_UNKNOWN_ERROR = 4; RESULT_STATUS_INVALID_PARAMETERS = 5; RESULT_STATUS_PAYMENT_FAILED = 6; RESULT_STATUS_USER_CANCELED_PROCESS = 7; |
| business_meta_data | string | Optional | مقدار اختیاری کسب و کار جهت رصد کاربر |
۵. تعیین نتیجه احراز و فراخوانی کال‌بک پذیرنده توسط UID
بعد از بررسی احراز هویت کاربر، نتیجه با فراخوانی آدرس Callback توسط یوآیدی به پذیرنده ارسال می‌شود.
POST - BUSINESS_CALLBACK_URL
Content-Type: application/json;charset=UTF-8
{
firstName: <FIRST_NAME>
lastName: <LAST_NAME>
fatherName: <FATHER_NAME>
gender: <GENDER>
birthDate: <BIRTH_DATE>
nationalId: <NATIONAL_ID>
bankCardNumber: <BANK_CARD_NUMBER>
iban: <IBAN>
mobileNumber: <MOBILE_NUMBER>
metaData: <METADATA>
finalAuthenticationResult: <RESULT>
finalAuthenticationResultReason: <REASON>
}
۱.۵. توضیح پاسخ های دریافتی
| Field | Type | Description |
| firstName | string | نام کاربر |
| lastName | string | نام خانوادگی کاربر |
| fatherName | string | نام پدر کاربر |
| gender | enum \ string | GENDER_UNDEFINED |
| birthDate | string | تاریخ تولد کاربر |
| nationalId | string | کد ملی کاربر |
| bankCardNumber | string | شماره کارت کاربر |
| iban | string | شماره شبا کاربر |
| mobileNumber | string | شماره موبایل کاربر |
| metaData | string | مقدار ارسال شده توسط کسب و کار در ابتدای فرآیند جهت رصد کاربر |
| finalAuthenticationResult | enum \ string | FINAL_AUTHENTICATION_RESULT_UNDEFINED |
| finalAuthenticationResultReason | enum \ string | FINAL_AUTHENTICATION_RESULT_REASON_UNDEFINED |
