تایید هویت کاربر به کمک تشخیص چهره
خدمت‌دهنده
بازارچه پادیوم
مقدمه
در وب سرویس تایید و احراز هویت کاربر به کمک فناوری تشخیص چهره، باید کسب‌وکارها سه فیلد اطلاعاتی کد ملی، شماره سریال کارت ملی و عکس یا ویدیو را از کاربر دریافت کنند و به کمک این وب سرویس هویت کاربر را تایید کنند. این سرویس پس از دریافت اطلاعات، از ثبت احوال تصویر کارت ملی فرد را استعلام کرده و سپس مشخص میکند که چهره صاحب کد ملی با صاحب ویدیو و یا تصویر چقدر تطابق دارد.
پیش از شروع
- URL فراخوانی سرویسها:
Production Server: https://api.pod.ir/srv/sc/nzh/doServiceCall
Sandbox Server:https://sandbox.pod.ir/srv/sc/nzh/doServiceCall
- تمامی درخواستها با متد POST ارسال میشوند.
- فیلدهای زیر درHeader تمامی درخواستها ثابت است:
| پارامتر | توضیحات |
| _token_ | توکن کسبوکاری دریافتی از پنل |
| _token_issuer_ | مقدار ثابت "1" |
- فیلدهای زیر در بدنه‌ی تمامی درخواستها ثابت است (با فرمت x-www-form-urlencoded):
| پارامتر | توضیحات |
| scProductId | شناسه‌ی سرویس مدنظر |
| scApiKey | راهنمای دریافت این پارامتر در این لینک موجود است. |
- علاوه بر موارد بالا که ثابت هستند، اگر سرویس نیاز به پارامتر دیگری داشته باشد در داکیومنت مربوطه ذکر شده است.
- خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.
نکته: پس از درخواست سرویس به پادیوم، همکاران ما درخواستهای ارسالی را بررسی می‌کنند. در صورت عدم دریافت تایید کرد بر روی درخواست ارسالی ظرف یک روز کاری،به همکاران ما از طریق شماره تلفن (021-89518989) و یا در گروه واتس‌اپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.
تایید هویت کاربر با تشخیص چهره (غیرپادی)
شناسه سرویس: 362160
( سندباکس: ندارد)
توسط این سرویس می توان تشخیص چهره کاربر را از طریق عکس یا ویدئوی ارسالی از کاربر انجام داد. در ابتدا باید به کمک این سرویس مقادیر ارسالی مدل مقایسه تشخیص چهره (عکس / ویدئو) را مشخص کنید.
توجه: فایل های آپلود شده در این سرویس باید در بستر پاد اسپیس باشد.
توجه: کد ملی و شماره سریال کارت ملی هر 2 اجباری می باشند و در صورت خالی فرستادن هر یک از این 2 پارامتر با خطا روبه رو خواهید شد. همچنین برای دریافت عکس ثبت احوالی کاربر و ادامه فرآیند مقایسه تصویر ارسالی کاربر با تصویر ثبت احوالی این پارامترها الزامی میباشد.
نتیجه تشخیص چهره کاربر (status) چند حالت مختلف دارد که شامل:
POD_AWAIT : قرار گرفتن درخواست در صف تشخیص چهره جهت بررسی تصویر
MAGE_COMPARE_AWAIT : منتظر دریافت تصویر از ثبت احوال و مقایسه تصویر ارسالی کاربر با تصویر موجود در ثبت احوال
IMAGE_COMPARE_OK : تطابق تصویر ارسالی کاربر با تصویر موجود در ثبت احوال
IMAGE_SABTEAHVAL_FAILED: عدم تطابق تصویر ارسالی کاربر با تصویر موجود در ثبت احوال
| توضیحات | مقدار | نام پارامتر | |
| ورودی | |||
| Header | |||
| توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
| این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
| این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
| Body | |||
| شناسه سرویس | 362160 | scProductId | |
| کلید فراخوانی سرویس |
| scApiKey | |
| شرح دلخواه پارامتر comparisonType: که شامل دو نوع مختلف image / video از مدل مقایسه می باشد که مشخص میکند نوع پردازش تصویر با تصویر میباشد یا تصویر با ویدئو (اجباری) image: در این حالت پردازش سرویس به صورت عکس با عکس انجام خواهد شد، یعنی کاربر باید آدرس تصویری از خود را که قبلا در پاد اسپیس آپلود کرده را برای مقایسه در پارامتر imageUrl ارسال نماید. video: در این حالت پردازش سرویس به صورت عکس با ویدئو انجام خواهد شد، یعنی کاربر باید آدرس ویدئوی کوتاهی از خود را که قبلا در پاد اسپیس آپلود کرده را برای مقایسه در پارامتر videoUrl ارسال نماید. | [ image / video ]
| comparisonType
| |
| الزامی - پارامتر nationalcode: در این پارامتر کد ملی کاربری که می خواهید مقایسه برای او انجام شود را وارد نمایید. (این مقدار توسط سامانه ثبت احوال صحت سنجی خواهد شد) |
| nationalcode | |
| الزامی - پارامتر nationalcodeSerial: در این پارامتر سریال پشت کارت ملی کاربری که می خواهید مقایسه برای او انجام شود را وارد نمایید. (این مقدار نیز توسط سامانه ثبت احوال صحت سنجی خواهد شد) |
| nationalcodeSerial | |
| الزامی - پارامتر imageUrl: در صورتی که فیلد comparisonType از نوع image مقدار دهی شده باشد، در این فیلد باید مسیر عکس آپلود شده ثبت شود. ( در صورت ارسال image به عنوان مقدار پارامتر comparisonType در هدر سرویس، ارسال پارامتر imageUrl اجباری می باشد) |
| imageUrl | |
| الزامی - پارامتر videoUrl: در صورتی که فیلد comparisonType از نوع video مقدار دهی شده باشد، در این فیلد باید مسیر ویدئو آپلود شده ثبت شود. (در صورت ارسال video به عنوان مقدار پارامتر comparisonType در هدر سرویس، ارسال پارامتر videoUrl اجباری می باشد) |
| videoUrl | |
| پارامتر callbackUrl: آدرس دلخواه مورد نظر جهت دریافت پاسخ سرویس تشخیص چهره (اختیاری) |
| callbackUrl | |
| خروجی | |||
| در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
| جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
| نتیجه ی نهایی سرویس | string | result.result | |
| شناسه جهت استعلام وضعیت نهایی پردازش | true/false | trackerId | |
| نتیجه تشخیص چهره کاربر (status) چند حالت مختلف دارد که شامل: POD_AWAIT : قرار گرفتن درخواست در صف تشخیص چهره جهت بررسی تصویر MAGE_COMPARE_AWAIT : منتظر دریافت تصویر از ثبت احوال و مقایسه تصویر ارسالی کاربر با تصویر موجود در ثبت احوال IMAGE_COMPARE_OK : تطابق تصویر ارسالی کاربر با تصویر موجود در ثبت احوال IMAGE_SABTEAHVAL_FAILED: عدم تطابق تصویر ارسالی کاربر با تصویر موجود در ثبت احوال |
| status | |
| نمونه درخواست | |||
| http | |||
| نمونه پاسخ | |||
| json | |||
استعلام احراز هویت ثبت شده
شناسه سرویس: 362272
(سندباکس: ندارد)
توسط این سرویس می توان نتیجه پردازش احراز هویت را استعلام نمود
| توضیحات | مقدار | نام پارامتر | |
| ورودی | |||
| Header | |||
| توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
| این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
| این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
| Body | |||
| شناسه سرویس | 362272 | scProductId | |
| کلید فراخوانی سرویس |
| scApiKey | |
| شناسه استعلام دریافتی از سرویس 362160 |
| trackerId | |
| خروجی | |||
| در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
| جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
| نتیجه ی نهایی سرویس | string | result.result | |
| شناسه جهت استعلام وضعیت نهایی پردازش | true/false | trackerId | |
| نتیجه تشخیص چهره کاربر (status) چند حالت مختلف دارد که شامل: POD_AWAIT : قرار گرفتن درخواست در صف تشخیص چهره جهت بررسی تصویر MAGE_COMPARE_AWAIT : منتظر دریافت تصویر از ثبت احوال و مقایسه تصویر ارسالی کاربر با تصویر موجود در ثبت احوال IMAGE_COMPARE_OK : تطابق تصویر ارسالی کاربر با تصویر موجود در ثبت احوال IMAGE_SABTEAHVAL_FAILED: عدم تطابق تصویر ارسالی کاربر با تصویر موجود در ثبت احوال |
| status | |
| نمونه درخواست | |||
| http
| |||
| نمونه پاسخ | |||
| json
| |||
| خطاهای معمول در پلتفرم | |||
| کد خطا | توضیح | ||
| 21 | توکن کسبوکاری وارد نشده است | ||
| 227 | تایم اوت سرویس اصلی | ||
| 378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است | ||
| 999 | به علت خطای داخلی ، سرویس قادر به پاسخگویی نیست . | ||
| 400 | Bad Request - nationalcode الزامی می باشد. | ||
| 400 | Bad Request - nationalcodeSerial الزامی می باشد. | ||
| 400 | Bad Request - .پارامتر ارسالی اشتباه می باشد: nationalcode | ||
| 400 | Bad Request - https://xxxxxxx.pod.ir نامعتبر می باشد. | ||
| 400 | Bad Request - کاربر گرامی درخواست قبلی شما با شناسه پیگیری xxxxxxx در مرحله دریافت تصویر از ثبت احوال می باشد و تا زمان دریافت نتیجه نهایی امکان ارسال درخواست جدیدی ندارید.
| ||
| 400 | Bad Request - imageUrl الزامی می باشد. | ||
| 400 | Bad Request - videoUrl الزامی می باشد. | ||
| 401 | Unauthorized - توکن نامعتبر | ||
| 403 | Forbidden - نقش های مجاز : nationalcard_image_verifier | ||
