سرویس های احراز هویت

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

<!--seo-open-->

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

<!--/seo-open-->

احراز هویت با کد ملی؛ این سرویس کد ملی، تاریخ تولد و نام را دریافت می‌کند و شباهت نام ارسال‌شده را با نام واقعی صاحب کد ملی برمی‌گرداند. نام را هم به صورت یک فیلد (fullName) و هم به صورت firstName و lastName جدا می‌توانید بفرستید.

Scope: facility:cc-nid-verification:get<br />

Grant type: client_credentials

نکته: پارامترهای query باید encode شده ارسال شوند. حداقل یکی از فیلدهای fullName، firstName یا lastName برای مشاهده شباهت ارسال شود.

get/facility/v2/clients/{clientId}/users/{nid}/cc/nidVerification

Request

  • Base URL: https://api.finnotech.ir
  • URL: https://api.finnotech.ir/facility/v2/clients/{clientId}/users/{nid}/cc/nidVerification
  • Auth: HTTP bearer

Path parameters

clientIdstring required
nidstring required

کد ملی که می‌خواهید صحت آن را بررسی کنید

Query parameters

trackIdstring
birthDatestring required

تاریخ تولد صاحب کد ملی به صورت yyyy/mm/dd

fullNamestring

نام و نام خانوادگی (یکی از fullName یا firstName/lastName اجباری است)

firstNamestring

نام کوچک صاحب کد ملی

lastNamestring

نام خانوادگی صاحب کد ملی

fatherNamestring

نام پدر صاحب کد ملی

gender'زن' | 'مرد'

جنسیت صاحب کد ملی — یکی از «زن» یا «مرد»

Response

Successful response

responseCodestring

کد پاسخ دریافتی

trackIdstring

کد پیگیری

statusstring

وضعیت فراخوانی — DONE یا FAILED

Example response

{
  "responseCode": "FN-FYKZ-20000400000",
  "trackId": "nid-inq-9602281200",
  "status": "DONE",
  "result": {
    "nationalCode": "0067408595",
    "birthDate": "1365/11/25",
    "status": "DONE",
    "fullName": "سعید غلامی فرد",
    "fullNameSimilarity": 100,
    "firstName": "سعید",
    "firstNameSimilarity": 100,
    "lastName": "غلامی فرد",
    "lastNameSimilarity": 100,
    "fatherName": "علی",
    "fatherNameSimilarity": 100,
    "deathStatus": "زنده",
    "gender": "مرد",
    "genderSimilarity": 100,
    "trackingCode": "123456"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.