مستندات وب سرویس

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

با استفاده از سرویس استعلام اطلاعات هویتی، می‌توانید اطلاعات هویتی فرد مورد نظر را دریافت کنید.

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	national_identity_inquiry
user_token	true	string	توکن کاربر
national_code	true	string	کد ملی

نمونه JSON ارسالی برای این پایانه

{
    "service": "national_identity_inquiry",
    "user_token": "your_user_token_here",
    "national_code": "00XXXXXXX8"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	مشخصات هویتی

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

با استفاده از سرویس شاهکار می‌توان مالکیت شماره موبایل و کد ملی ارسالی را با هم تطابق داد.

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	shahkar
user_token	true	string	توکن کاربر
mobile	true	string	شماره موبایل
national_code	true	string	کد ملی

نمونه JSON ارسالی برای این پایانه

{
    "service": "shahkar",
    "user_token": "your_user_token_here",
    "mobile": "093XXXXXXX2",
    "national_code": "00XXXXXXX8"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	نشان‌دهنده تطابق و عدم تطابق شماره موبایل و کد ملی

نمونه JSON دریافتی از این پایانه

{
    "response_body": {
        "data": {
            "matched": true
        },
        "message": "موفق"
    },
    "status_code": 200
}

OCR کارت ملی

با استفاده از سرویس OCR کارت ملی، می‌توان اطلاعات جلو و پشت کارت ملی را از روی عکس آن دریافت کرد.

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	national_card_ocr
user_token	true	string	توکن کاربر
national_card_back	true	string	عکس پشت کارت ملی
national_card_front	true	string	عکس جلو کارت ملی

نمونه JSON ارسالی برای این پایانه

"curl --location 'https://estelamyar.com/services/national_card_ocr' \
--form 'service=national_card_ocr' \
--form 'user_token=your_user_token_here' \
--form 'national_card_back=@/path/to/file' \
--form 'national_card_front=@/Users/mohammad/Documents/fatemi.jpg"

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	مشخصات صاحب کارت ملی

تطابق شماره کارت و کد ملی

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

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	check_card_with_national_code
user_token	true	string	توکن کاربر
national_code	true	string	کد ملی
birth_date	true	string	تاریخ تولد
card_number	true	string	شماره کارت

نمونه JSON ارسالی برای این پایانه

{
    "service": "check_card_with_national_code",
    "user_token": "your_user_token_here",
    "national_code": "1285XXX561",
    "birth_date": "1377/07/19",
    "card_number": "6362XXXXXXX11"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	نشان‌دهنده تطابق و عدم تطابق کد ملی و شماره کارت

تطابق شبا با کد ملی

با استفاده از این سرویس می‌توانید تطابق شماره شبا و کد ملی را بررسی کنید.

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	check_iban_with_national_code
user_token	true	string	توکن کاربر
national_code	true	string	کد ملی
iban	true	string	شماره شبا

نمونه JSON ارسالی برای این پایانه

{
    "service": "check_iban_with_national_code",
    "user_token": "your_user_token_here",
    "national_code": "00XXXXXXX8",
    "iban": "IR123456789012345678901234"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	نشان‌دهنده تطابق و عدم تطابق کد ملی و شماره شبا

تبدیل کارت به شبا

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

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	card_to_iban
user_token	true	string	توکن کاربر
card_number	true	string	شماره کارت

نمونه JSON ارسالی برای این پایانه

{
    "service": "card_to_iban",
    "user_token": "your_user_token_here",
    "card_number": "6362XXXXXXX11"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	شماره شبا

تبدیل کارت به حساب

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

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	card_to_account
user_token	true	string	توکن کاربر
card_number	true	string	شماره کارت

نمونه JSON ارسالی برای این پایانه

{
    "service": "card_to_account",
    "user_token": "your_user_token_here",
    "card_number": "6362XXXXXXX11"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	شماره حساب

استعلام شبا

با استفاده از این سرویس می‌توانید وضعیت شماره شبا را بررسی کنید.

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	iban
user_token	true	string	توکن کاربر
iban	true	string	شماره شبا

نمونه JSON ارسالی برای این پایانه

{
    "service": "iban",
    "user_token": "your_user_token_here",
    "iban": "IR123456789012345678901234"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	جزئیات وضعیت شبا

استعلام کارت

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

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	card_inquiry
user_token	true	string	توکن کاربر
card_number	true	string	شماره کارت

نمونه JSON ارسالی برای این پایانه

{
    "service": "card_inquiry",
    "user_token": "your_user_token_here",
    "card_number": "6362XXXXXXX11"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	جزئیات کارت

تطابق کارت و نام صاحب کارت

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

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	check_card_with_name
user_token	true	string	توکن کاربر
card_number	true	string	شماره کارت
name	true	string	نام صاحب کارت

نمونه JSON ارسالی برای این پایانه

{
    "service": "check_card_with_name",
    "user_token": "your_user_token_here",
    "card_number": "6362XXXXXXX11",
    "name": "محمد"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	نشان‌دهنده تطابق یا عدم تطابق

تطابق شبا و نام صاحب شبا

با استفاده از این سرویس می‌توانید تطابق شماره شبا و نام صاحب آن را بررسی کنید.

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	check_iban_with_name
user_token	true	string	توکن کاربر
iban	true	string	شماره شبا
name	true	string	نام صاحب شبا

نمونه JSON ارسالی برای این پایانه

{
    "service": "check_iban_with_name",
    "user_token": "your_user_token_here",
    "iban": "IR123456789012345678901234",
    "name": "محمد"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	نشان‌دهنده تطابق یا عدم تطابق

استعلام کد پستی

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

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	postal_code_inquiry
user_token	true	string	توکن کاربر
postal_code	true	string	کد پستی

نمونه JSON ارسالی برای این پایانه

{
    "service": "postal_code_inquiry",
    "user_token": "your_user_token_here",
    "postal_code": "1234567890"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	جزئیات کد پستی

تبدیل حساب به شبا

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

POST

https://estelamyar.com/services/

پارامترهای درخواست

پارامتر	ضروری	نوع	جزئیات
service	true	string	account_to_iban
user_token	true	string	توکن کاربر
bank_account	true	string	شماره حساب

نمونه JSON ارسالی برای این پایانه

{
    "service": "account_to_iban",
    "user_token": "your_user_token_here",
    "bank_account": "123456789012345"
}

پارامترهای پاسخ

پارامتر	نوع	جزئیات
message	string	پیغام حاوی نتیجه درخواست
result	int	نتیجه درخواست
data	object	شماره شبا