مستندات فنی «استعلام اطلاعات هویتی»

اندپوینت و دسترسی استعلام اطلاعات هویتی

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

Scope: kyc:identification-inquiry:get

Grant type: client_credentials

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

معرفی استعلام اطلاعات هویتی

سرویس استعلام اطلاعات هویتی فینوتک یک API برای احراز هویت و فرآیندهای KYC است که به کسب‌وکارها امکان می‌دهد اطلاعات هویتی فرد را از طریق API دریافت و بررسی کنند.

ورودی و خروجی استعلام اطلاعات هویتی

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

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

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

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

کاربرد فنی استعلام اطلاعات هویتی

این سرویس برای کسب‌وکارهایی طراحی شده است که در فرآیند KYC نیاز دارند اطلاعات هویتی مشتری را از طریق API دریافت و بررسی کنند. از این سرویس می‌توان در فرآیندهایی مانند ثبت‌نام کاربران، احراز هویت مشتریان و اعتبارسنجی اطلاعات هویتی استفاده کرد.

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

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

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

عملیات مرتبط با استعلام اطلاعات هویتی

• استعلام کد ملی (Client Credential) — GET /facility/v2/clients/{clientId}/users/{nid}/cc/nidInquiry
• دریافت تصویر کارت ملی — GET /facility/v2/clients/{clientId}/nationalCardImage
• تطبیق شاهکار موبایل و کد ملی — GET /facility/v2/clients/{clientId}/shahkar/verify
• استعلام وضعیت حیات — GET /kyc/v2/clients/{clientId}/deathStatusInquiry
• خواندن اطلاعات کارت ملی با OCR — POST /kyc/v2/clients/{clientId}/ocr