مستندات فنی «احراز هویت با کد ملی»

اندپوینت و دسترسی احراز هویت با کد ملی

این صفحه مستندات فنی فراخوانی GET /facility/v2/clients/{clientId}/users/{nid}/cc/nidVerification است.

Scope: facility:cc-nid-verification:get

Grant type: client_credentials

دسته‌بندی OpenAPI: احراز هویت و شناخت مشتری. شناسه عملیات: facilityNidVerificationCc.

معرفی احراز هویت با کد ملی

سرویس «احراز هویت با کد ملی» (National ID / KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

ورودی و خروجی احراز هویت با کد ملی

ورودی‌های اصلی: شناسه کلاینت، کد ملی، تاریخ تولد.

پارامترهای اختیاری متداول: کد پیگیری، نام کامل، نام، نام خانوادگی، نام پدر، جنسیت.

فیلدهای مهم پاسخ: کد ملی، تاریخ تولد، وضعیت، نام کامل، میزان شباهت نام کامل، نام، میزان شباهت نام، نام خانوادگی.

جزئیات نوع داده، الزامی بودن و نمونه JSON در مشخصات Elements همین صفحه آمده است.

کاربرد فنی احراز هویت با کد ملی

سرویس «احراز هویت با کد ملی» (National ID / KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

پس از دریافت توکن مناسب (مطابق Grant type)، درخواست را به مسیر بالا بفرستید و پاسخ را بر اساس اسکیمای اعلام‌شده پردازش کنید. راهنمای گرفتن توکن در راهنمای شروع آمده است.

در صورت خطای احراز هویت یا Scope ناکافی، ابتدا اعتبار توکن و سطح دسترسی کلاینت را بررسی کنید؛ سپس پارامترهای الزامی مسیر و بدنه را با اسکیمای همین صفحه تطبیق دهید.

برای توضیح کسب‌وکاری، موارد استفاده و پیش‌نیازها به صفحه سرویس «احراز هویت با کد ملی» مراجعه کنید.

عملیات مرتبط با احراز هویت با کد ملی

• دریافت تصویر کارت ملی — GET /facility/v2/clients/{clientId}/nationalCardImage
• دریافت تصویر کارت ملی — GET /facility/v2/clients/{clientId}/nationalCardImage
• استعلام کد ملی (Client Credential) — GET /facility/v2/clients/{clientId}/users/{nid}/cc/nidInquiry
• استعلام کد ملی (Client Credential) — GET /facility/v2/clients/{clientId}/users/{nid}/cc/nidInquiry
• استعلام کد ملی (Authorization SMS) — GET /facility/v2/clients/{clientId}/users/{nid}/sms/nidInquiry