مستندات فنی «استعلام کد ملی (Client Credential)»

اندپوینت و دسترسی استعلام کد ملی (Client Credential)

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

Scope: facility:cc-nid-inquiry:get

Grant type: client_credentials

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

معرفی استعلام کد ملی (Client Credential)

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

ورودی و خروجی استعلام کد ملی (Client Credential)

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

پارامترهای اختیاری متداول: کد پیگیری.

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

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

کاربرد فنی استعلام کد ملی (Client Credential)

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

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

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

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

عملیات مرتبط با استعلام کد ملی (Client Credential)

• دریافت تصویر کارت ملی — GET /facility/v2/clients/{clientId}/nationalCardImage
• دریافت تصویر کارت ملی — GET /facility/v2/clients/{clientId}/nationalCardImage
• استعلام کد ملی (Authorization SMS) — GET /facility/v2/clients/{clientId}/users/{nid}/sms/nidInquiry
• استعلام کد ملی (Authorization SMS) — GET /facility/v2/clients/{clientId}/users/{nid}/sms/nidInquiry
• تطبیق موبایل و کد ملی با پیامک — GET /facility/v2/clients/{clientId}/shahkar/smsSend