مستندات فنی «دریافت تصویر کارت ملی»

اندپوینت و دسترسی دریافت تصویر کارت ملی

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

Scope: facility:national-card-image:get

Grant type: client_credentials

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

معرفی دریافت تصویر کارت ملی

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

ورودی و خروجی دریافت تصویر کارت ملی

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

فیلدهای مهم پاسخ: شماره پیگیری نامه، عکس کارت ملی با فرمت base64، پیغام خطا.

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

کاربرد فنی دریافت تصویر کارت ملی

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

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

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

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

عملیات مرتبط با دریافت تصویر کارت ملی

• استعلام کد ملی (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
• استعلام کد ملی (Authorization SMS) — GET /facility/v2/clients/{clientId}/users/{nid}/sms/nidInquiry
• تطبیق موبایل و کد ملی با پیامک — GET /facility/v2/clients/{clientId}/shahkar/smsSend