مستندات فنی «استعلام اتباع خارجی»

اندپوینت و دسترسی استعلام اتباع خارجی

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

Scope: kyc:foreigner-id-inquiry:get

Grant type: client_credentials

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

معرفی استعلام اتباع خارجی

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

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

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

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

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

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

کاربرد فنی استعلام اتباع خارجی

سرویس «استعلام اتباع خارجی» (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