اندپوینت و دسترسی احراز هویت با کد ملی با پیامک
این صفحه مستندات فنی فراخوانی GET /facility/v2/clients/{clientId}/users/{nid}/sms/nidVerification است.
Scope: facility:sms-nid-verification:get
Grant type: authorization_sms
دستهبندی OpenAPI: استعلام و تبدیل بانکی. شناسه عملیات: facilityNidVerificationSms.
معرفی احراز هویت با کد ملی با پیامک
سرویس «احراز هویت با کد ملی با پیامک» (National ID / KYC / SMS/OTP) در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب)؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودیها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام میشود. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.
ورودی و خروجی احراز هویت با کد ملی با پیامک
ورودیهای اصلی: شناسه کلاینت، کد ملی، تاریخ تولد.
پارامترهای اختیاری متداول: کد پیگیری، نام کامل، نام، نام خانوادگی، نام پدر، جنسیت.
فیلدهای مهم پاسخ: کد ملی، تاریخ تولد، وضعیت، نام کامل، میزان شباهت نام کامل، نام، میزان شباهت نام، نام خانوادگی.
جزئیات نوع داده، الزامی بودن و نمونه JSON در مشخصات Elements همین صفحه آمده است.
کاربرد فنی احراز هویت با کد ملی با پیامک
سرویس «احراز هویت با کد ملی با پیامک» (National ID / KYC / SMS/OTP) در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب)؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودیها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorizationsms) انجام میشود.…
پس از دریافت توکن مناسب (مطابق Grant type)، درخواست را به مسیر بالا بفرستید و پاسخ را بر اساس اسکیمای اعلامشده پردازش کنید. راهنمای گرفتن توکن در راهنمای شروع آمده است.
در صورت خطای احراز هویت یا Scope ناکافی، ابتدا اعتبار توکن و سطح دسترسی کلاینت را بررسی کنید؛ سپس پارامترهای الزامی مسیر و بدنه را با اسکیمای همین صفحه تطبیق دهید.
برای توضیح کسبوکاری، موارد استفاده و پیشنیازها به صفحه سرویس «احراز هویت با کد ملی با پیامک» مراجعه کنید.
عملیات مرتبط با احراز هویت با کد ملی با پیامک
- تبدیل شماره کارت به شماره حساب —
GET /facility/v2/clients/{clientId}/cardToDeposit - تبدیل شماره کارت به شماره حساب —
GET /facility/v2/clients/{clientId}/cardToDeposit - تبدیل کارت به شبا —
GET /facility/v2/clients/{clientId}/cardToIban - تبدیل کارت به شبا —
GET /facility/v2/clients/{clientId}/cardToIban - استعلام حساب —
GET /facility/v2/clients/{clientId}/depositInfo