خانه / مستندات API

احراز هویت آنبورد

سرویس احراز هویت کامل هوش سامان.

https://v2.hooshsaman.com/api/services/authenticate/get_link

Request Headers
Parameter Type Description
Authorization API-Key API-Key در داشبورد حساب شما در سایت موجود است.
Request Body
Field Type Description
* mobile string شماره موبایل
مانند: 09123456789
* national_code string کد ملی ده رقمی
callback_url string آدرسی که نتیجه احراز هویت به آن ارسال میشود.
مانند: https://api.sample.com
redirect_url string آدرسی که میخواهید بعد از پایان احراز هویت به آنجا ری‌دایرکت شود.
domain string نام شرکت متقاضی
مانند: هوش سامان
(از این فیلد در صفحه قوانین و مقررات استفاده میشود.)
url string آدرس اینترنتی شرکت متقاضی
مانند: https://hooshsaman.com
(از این فیلد در صفحه قوانین و مقررات استفاده میشود.)
* دو فیلد شماره موبایل و کد ملی اختیاری هستند. و با ارسال هر دو یا فقط شماره موبایل و یا هیچ کدام، سه حالت متفاوت ایجاد میشود:
شماره موبایل و کد ملی وارد شوند:

در این صورت فرض گرفته میشود که شماره موبایل و کد ملی کاربر در سایت مبدا بررسی و تایید شده‌اند. لذا هوش سامان کد ملی و شماره موبایل را بررسی نکرده و مستقیما کاربر را به مرحله وارد کردن تاریخ تولد هدایت میکند.

فقط شماره موبایل:

در این صورت کاربر به صفحه تایید کد ارسالی به شماره موبایلش هدایت میشود.

هیچ کدام:

در این صورت کاربر از مرحله وارد کردن شماره موبایل احراز هویت را آغاز میکند.

Response Body
Field Type Description
link string لینک احراز هویت تولید شده
token string توکن جهت استعلام نتیجه احراز هویت
Request Example
{
    "mobile":"0912...",
    "national_code":"00...",
    "callback_url":"https://...",
    "redirect_url":"https://...",
    "domain":"هوش سامان",
    "url":"https://hooshsaman.com"
}
Response Example
{
    "link": "https://v2.hooshsaman.com/services/authenticate/client/uRyjUKOd67",
    "token": "uRyjUKOd67"
}

استعلام نتیجه احراز هویت آنبورد

https://v2.hooshsaman.com/api/services/authenticate/get_result/{token} *

* توکن را در مرحله قبل دریافت کرده‌اید.
Request Headers
Parameter Type Description
Authorization API-Key API-Key در داشبورد حساب شما در سایت موجود است.
Response Body
Field Type Description
status number 1: موفقیت عملیات / 0: عدم موفقیت
message.step string بیانگر اینکه کاربر آیا تمام مراحل احراز هویت را پشت سر گذاشته است و یا اگر خیر، در کدام مرحله است.
message.link string آدرس URL احراز هویت کاربر
message.token string توکن URL احراز هویت
message.ip string IP دستگاه کاربر
message.first_name string نام کاربر
message.last_name string نام خانوادگی
message.full_name string نام و نام خانوادگی
message.father_name string نام پدر
message.mobile string شماره موبایل
message.sms_code string کد پیامک ارسالی به کاربر
message.national_code string کد ملی
message.card_number string شماره کارت بانکی
message.bank_name string نام بانک
message.deposit_number string شماره حساب
message.iban string شماره شبا
message.birth_date string تاریخ تولد به میلادی
message.persian_birth_date string تاریخ تولد به شمسی
message.mobile_status string موفقیت یا عدم موفقیت مرحله شماره موبایل
message.national_code_status string موفقیت یا عدم موفقیت مرحله تطابق کد ملی با شماره موبایل
message.birth_date_status string موفقیت یا عدم موفقیت مرحله تطابق کد ملی با تاریخ تولد
message.card_number_status string موفقیت یا عدم موفقیت مرحله شماره کارت بانکی
message.iban_status string موفقیت یا عدم موفقیت مرحله دریافت اطلاعات شماره کارت بانکی
message.face_authenticate_status string موفقیت یا عدم موفقیت مرحله تشخیص چهره
message.status string موفقیت یا عدم موفقیت احراز هویت
message.spoofing number 0: جعلی بودن ویدیو / 1: واقعی بودن ویدیو
(بیانگر نتیجه تست تشخیص زنده بودن)
message.call_back string آدرس URL جهت کالبک (ارسال نتیجه به آن)
message.redirect_url string آدرس URL جهت ری‌دایرکت به آن پس از اتمام فرایند
message.created_at string تاریخ و ساعت اقدام به شروع فرایند احراز هویت
message.updated_at string تاریخ و ساعت پایان فرایند احراز هویت
message.auth_token string این توکن در داشبورد شما موجود است.
(جهت امنیت بیشتر، باید این توکن با توکن موجود در داشبورد شما یکی باشد.)
Response Example
{
    "status": 1,
    "message": {
        "step": "Face authentication step completed",
        "link": "https://v2.hooshsaman.comservices/authenticate/client/nAP2b8K0e5",
        "token": "nAP2b8K0e5",
        "ip": "5.106.217.104",
        "first_name": "حيدر",
        "last_name": "دراني نژاد",
        "full_name": "دراني نژاد حيدر",
        "father_name": "مهدي",
        "mobile": "09123456789",
        "sms_code": "2718",
        "national_code": "2981112223",
        "card_number": "5041721008597578",
        "bank_name": "RESALAT",
        "deposit_number": "1000000000",
        "iban": "IR900000000000000000000000",
        "birth_date": "1999-12-09",
        "persian_birth_date": "1378/09/18",
        "mobile_status": "success",
        "national_code_status": "success",
        "birth_date_status": "success",
        "card_number_status": "success",
        "iban_status": "success",
        "face_authenticate_status": "success",
        "status": "success",
        "spoofing": 1,
        "call_back": "https://...",
        "redirect_url": "https://...",
        "created_at": "2024-04-14 11:18:20",
        "updated_at": "2024-04-14 11:19:50",
        "auth_token": "U78wxVk80UO4UI25hZ6plLlBA"
    }
}

شاهکار (استعلام تطابق شماره ملی با شماره موبایل)

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

https://v2.hooshsaman.com/api/services/authenticate/shahkar

Request Headers
Parameter Type Description
Authorization API-Key API-Key در داشبورد حساب شما در سایت موجود است.
Request Body
Field Type Description
mobile string شماره موبایل
national_code string کد ملی ده رقمی
Response Body
Field Type Description
result bulean true: مطابقت / false: عدم مطابقت
Request Example
{
    "mobile":"09123456789",
    "national_code":"2980001112"
}
Response Example
{
    "result": true
}

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

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

https://v2.hooshsaman.com/api/services/authenticate/national_code_birthdate

Request Headers
Parameter Type Description
Authorization API-Key API-Key در داشبورد حساب شما در سایت موجود است.
Request Body
Field Type Description
national_code string کد ملی ده رقمی
birth_date string تاریخ تولد مانند 1378/09/18
Response Body
Field Type Description
status number اگر کد ملی و تاریخ تولد مطابقت داشته باشند 1 خواهد بود وگرنه 0
result.client_name string نام
result.client_last_name string نام خانوادگی
result.client_father_name string نام پدر
result.persian_birth_date string تاریخ تولد به شمسی
Request Example
{
    "national_code":"2981110594",
    "birth_date":"1378/09/18"
}
Response Example
{
    "status": 1,
    "result": {
        "client_name": "حيدر",
        "client_last_name": "دراني نژاد",
        "client_father_name": "مهدي",
        "persian_birth_date": "1378/09/18"
    }
}

استعلام اطلاعات کارت بانکی

این سرویس با اخذ شماره کارت بانکی، اطلاعات کامل حساب بانکی را برمیگرداند.

https://v2.hooshsaman.com/api/services/authenticate/bank_card

Request Headers
Parameter Type Description
Authorization API-Key API-Key در داشبورد حساب شما در سایت موجود است.
Request Body
Field Type Description
card_number string شماره 16 رقمی کارت بانکی
Response Body
Field Type Description
status number 1: استعلام موفق / 0: استعلام ناموفق
result.iban string شماره شبا
result.status string وضعیت فعال یا غیرفعال بودن کارت
result.deposit_number string شماره حساب
result.bank string نام بانک
result.owner string نام صاحب کارت
result.type string نوع کارت بانکی
result.card_number string شماره کارت
message string "valid card": کارت بانکی معتبر / "invalid card": کارت نامعتبر
Request Example
{
    "card_number":"5041721008597578"
}
Response Example
{
    "status": 1,
    "result": {
        "iban": "IR900000000000000000000000",
        "status": "ACTIVE",
        "deposit_number": "1234567890",
        "bank": "RESALAT",
        "owner": "حيدر دراني نژاد",
        "type": "DEBIT",
        "card_number": "5041721008597578"
    },
    "message": "valid card"
}

سرویس تشخیص مطابقت عکس و ویدیو

این سرویس واقعی یا جعلی بودن ویدیو را بررسی میکند و میزان مشابهت شخص داخل ویدیو با فرد داخل عکس.

https://v2.hooshsaman.com/api/services/authenticate/image_video

Request Headers
Parameter Type Description
Authorization API-Key API-Key در داشبورد حساب شما در سایت موجود است.
Request Body
Field Type Description
* image_url / image_file string / file URL عکس / فایل عکس
video_url / video_file string / file URL ویدیو / فایل ویدیو
national_code string کد ملی

* عکس و ویدیو میتوانند بصورت فایل یا بصورت URL ارسال شوند.

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

Response Body
Field Type Description
status number 1: مطابقت / 0: عدم مطابقت
message string پیغام نتیجه
is_valid_nid_card bulean اگر تصویر ارسالی تصویر کارت ملی باشد و ویدیوی ارسالی با عکس صاحب کارت ملی مطابق تشخیص داده شود، true و در غیر این صورت false خواهد بود.
liveness number میزان زنده بودن (عددی بین صفر و یک) *
similarity number میزان مشابهت عکس و ویدیو (عددی بین صفر و یک) *

* تایید یا عدم تایید نتیجه این فیلدها بستگی به تصمیم سرویس‌گیرنده دارد. پیشنهاد ما تایید عدد بالای 0.6 است.

Request Example
{
    "image_url":"url..."
    "video_url":"url..."
    "national_code":"0080082920"
}

یا

{
    "image_file":"file"
    "video_file":"file"
    "national_code":"0080082920"
}
Response Example
{
    "status": 1,
    "message": "success",
    "is_valid_nid_card": true,
    "liveness": 0.99...,
    "similarity": 0.86...
}