Ehraz API · v1

مستندات فنی API احراز

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

Base URL https://ehraz.io/api/v1

هزینه درخواست و اعتبار دسترسی

شارژ کیف پول بدون مالیات انجام می‌شود. برای پاسخ قابل‌صورتحساب، تعرفه پایه سرویس و 10 درصد مالیاتِ بخش مشمول از کیف پول همان کسب‌وکار کسر می‌شود. اعتبار قدیمی که مالیات آن قبلاً پرداخت و تایید شده است، دوباره مشمول مالیات نمی‌شود.

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

کسب‌وکار جدید پس از تایید و پرداخت فعال‌سازی، یک سال جلالی دسترسی دارد. پس از پایان اعتبار، تمدید لازم است؛ سوابق و کلید موجود حذف نمی‌شوند. وضعیت و تاریخ اعتبار در پنل نمایش داده می‌شود.

شروع کار

اولین درخواست شما

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

۱تکمیل کسب‌وکاردامنه و اطلاعات کسب‌وکار را ثبت و فعال کنید.
۲دریافت توکنتوکن کامل فقط هنگام ساخت یا بازسازی نمایش داده می‌شود.
۳ارسال درخواستدرخواست را با HTTPS و هدر Authorization ارسال کنید.
امنیت

احراز هویت API

توکن را در هدر Authorization و با پیشوند Token ارسال کنید. توکن را در URL، کد سمت مرورگر یا مخزن عمومی قرار ندهید.

Authorization: Token YOUR_API_TOKEN
دسترسی

توکن و دامنه

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

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

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

پاسخ‌ها

کدهای پاسخ عمومی

برای تصمیم‌گیری برنامه‌ای، مقدار code و HTTP status را بررسی کنید.

0درخواست پردازش شده است؛ ساختار نتیجه را بررسی کنید.
1بدنه درخواست ناقص یا نامعتبر است.
2بدنه درخواست خالی است.
3دامنه یا سرویس موردنظر برای حساب معتبر نیست.
5دسترسی دامنه فعال نیست یا مجاز نیست.
6موجودی کیف پول کافی نیست.
7درخواست باید از طریق HTTPS ارسال شود.
9سرویس موقتا پاسخگو نیست.
401توکن نامعتبر، غیرفعال یا محدودیت IP؛ HTTP 401.
27 مسیر قابل استفاده

مرجع سرویس‌ها

پارامترها و نمونه‌ها مطابق قرارداد نسخه v1 نمایش داده شده‌اند.

حساب و کیف پول

موجودی کیف پول

دریافت موجودی کیف پول کاربر احراز شده.

فعال
GET /api/v1/account/wallet-balance

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

این مسیر پارامتر ورودی ندارد.

این مسیر فقط احراز هویت توکن نیاز دارد.
curl --request GET \
  --url 'https://ehraz.io/api/v1/account/wallet-balance' \
  --header 'Authorization: Token YOUR_API_TOKEN'

نمونه پاسخ موفق

{
  "code": "0",
  "wallet_balance": 100000
}
اطلاعات بانکی

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

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

فعال
POST /api/v1/convert/deposit-number-to-iban

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

bankالزامی

کد بانک

string
numberالزامی

شماره حساب

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/convert/deposit-number-to-iban' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "bank": "MELI",
  "number": "1234567890"
}'

نمونه پاسخ موفق

{
  "number": "1234567890",
  "ibanInfo": {
    "iban": "IR062960000000100324200001",
    "bank": "MELI",
    "depositNumber": "1234567890",
    "status": "ACTIVE",
    "owners": [
      {
        "firstName": "علی",
        "lastName": "محمدی"
      }
    ]
  }
}
اطلاعات بانکی

استعلام شبا

دریافت اطلاعات شبا.

فعال
POST /api/v1/info/iban-info

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

valueالزامی

شماره شبا

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/iban-info' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": "IR062960000000100324200001"
}'

نمونه پاسخ موفق

{
  "value": "IR062960000000100324200001",
  "ibanInfo": {
    "iban": "IR062960000000100324200001",
    "bank": "MELI",
    "depositNumber": "1234567890",
    "status": "ACTIVE",
    "owners": [
      {
        "firstName": "علی",
        "lastName": "محمدی"
      }
    ]
  }
}
اطلاعات بانکی

استعلام کارت

دریافت اطلاعات کارت بانکی.

فعال
POST /api/v1/info/card-info

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

numberالزامی

شماره کارت

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/card-info' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "number": "6037991234567890"
}'

نمونه پاسخ موفق

{
  "number": "6037991234567890",
  "cardInfo": {
    "bank": "MELI",
    "ownerName": "علی محمدی",
    "depositNumber": "1234567890"
  }
}
اطلاعات بانکی

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

تبدیل شماره کارت به شماره حساب.

فعال
POST /api/v1/convert/card-to-deposit-number

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

numberالزامی

شماره کارت

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/convert/card-to-deposit-number' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "number": "6037991234567890"
}'

نمونه پاسخ موفق

{
  "number": "6037991234567890",
  "depositInfo": {
    "bank": "MELI",
    "depositNumber": "1234567890"
  }
}
اطلاعات بانکی

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

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

فعال
POST /api/v1/convert/card-to-iban

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

numberالزامی

شماره کارت

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/convert/card-to-iban' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "number": "6037991234567890"
}'

نمونه پاسخ موفق

{
  "number": "6037991234567890",
  "ibanInfo": {
    "iban": "IR062960000000100324200001",
    "bank": "MELI",
    "depositNumber": "1234567890",
    "status": "ACTIVE",
    "owners": [
      {
        "firstName": "علی",
        "lastName": "محمدی"
      }
    ]
  }
}
اطلاعات بانکی

همخوانی کدملی با شبا

بررسی تطابق کد ملی و تاریخ تولد با شبا.

فعال
POST /api/v1/match/iban-with-national

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

ibanالزامی

شماره شبا

string
nationalCodeالزامی

کد ملی

string
birthDateالزامی

تاریخ تولد با فرمت YYYYmmDD

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/match/iban-with-national' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "iban": "IR062960000000100324200001",
  "nationalCode": "0012345678",
  "birthDate": "13680101"
}'

نمونه پاسخ موفق

{
  "matched": true
}

نمونه پاسخ ناموفق

{
  "matched": false
}
اطلاعات بانکی

همخوانی نام با شبا

بررسی تطابق نام و نام خانوادگی با شبا.

فعال
POST /api/v1/match/iban-with-name

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

ibanالزامی

شماره شبا

string
nameالزامی

نام و نام خانوادگی

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/match/iban-with-name' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "iban": "IR062960000000100324200001",
  "name": "علی محمدی"
}'

نمونه پاسخ موفق

{
  "matched": true
}

نمونه پاسخ ناموفق

{
  "matched": false
}
اطلاعات بانکی

همخوانی نام با کارت

بررسی تطابق نام و نام خانوادگی با شماره کارت.

فعال
POST /api/v1/match/card-with-name

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

cardNumberالزامی

شماره کارت

string
nameالزامی

نام و نام خانوادگی

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/match/card-with-name' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "cardNumber": "6037991234567890",
  "name": "علی محمدی"
}'

نمونه پاسخ موفق

{
  "matched": true
}

نمونه پاسخ ناموفق

{
  "matched": false
}
اطلاعات بانکی

همخوانی نام با حساب

بررسی تطابق نام و نام خانوادگی با شماره حساب.

فعال
POST /api/v1/match/deposit-number-with-name

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

bankالزامی

کد بانک

string
depositNumberالزامی

شماره حساب

string
nameالزامی

نام و نام خانوادگی

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/match/deposit-number-with-name' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "bank": "MELI",
  "depositNumber": "1234567890",
  "name": "علی محمدی"
}'

نمونه پاسخ موفق

{
  "matched": true
}

نمونه پاسخ ناموفق

{
  "matched": false
}
اطلاعات بانکی

همخوانی کدملی با کارت

بررسی تطابق کد ملی و تاریخ تولد با کارت.

فعال
POST /api/v1/match/card-with-national

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

cardNumberالزامی

شماره کارت

string
nationalCodeالزامی

کد ملی

string
birthDateالزامی

تاریخ تولد با فرمت YYYYmmDD

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/match/card-with-national' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "cardNumber": "6037991234567890",
  "nationalCode": "0012345678",
  "birthDate": "13680101"
}'

نمونه پاسخ موفق

{
  "matched": true
}

نمونه پاسخ ناموفق

{
  "matched": false
}
اطلاعات بانکی

تطبیق شبا و شناسه ملی حقوقی

بررسی تعلق شبا به شخص حقوقی.

فعال
POST /api/v1/match/iban-with-legal-national

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

ibanالزامی

شماره شبا

string
legalNationalCodeالزامی

شناسه ملی حقوقی ۱۱ رقمی

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/match/iban-with-legal-national' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "iban": "IR062960000000100324200001",
  "legalNationalCode": "14001234567"
}'
هویتی

همخوانی موبایل با کدملی

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

فعال
POST /api/v1/match/national-with-mobile

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

nationalCodeالزامی

کد ملی

string
mobileNumberالزامی

شماره موبایل

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/match/national-with-mobile' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "0012345678",
  "mobileNumber": "09123456789"
}'

نمونه پاسخ موفق

{
  "matched": true
}

نمونه پاسخ ناموفق

{
  "matched": false
}
هویتی

ثبت احوال کامل

استعلام کامل ثبت احوال.

غیرفعال
POST /api/v1/info/identity-info

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

nationalCodeالزامی

کد ملی

string
birthDateالزامی

تاریخ تولد با فرمت YYYYmmDD

string
طبق وضعیت محصول، این سرویس در نسخه v1 به صورت غیرفعال نمایش داده می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/identity-info' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "0012345678",
  "birthDate": "13680101"
}'

نمونه پاسخ موفق

{
  "nationalCode": "0012345678",
  "birthDate": "13680101",
  "identityInfo": {
    "firstName": "علی",
    "lastName": "محمدی",
    "fatherName": "حسین",
    "alive": true
  }
}
هویتی

ثبت احوال مقایسه ای

استعلام مقایسه‌ای ثبت احوال بر اساس اطلاعات هویتی.

فعال
POST /api/v1/info/identity-similarity

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

nationalCodeالزامی

کد ملی

string
birthDateالزامی

تاریخ تولد با فرمت YYYYmmDD

string
firstNameالزامی

نام

string
lastNameالزامی

نام خانوادگی

string
fullNameالزامی

نام و نام خانوادگی کامل

string
fatherNameالزامی

نام پدر

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/identity-similarity' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "0012345678",
  "birthDate": "13680101",
  "firstName": "علی",
  "lastName": "محمدی",
  "fullName": "علی محمدی",
  "fatherName": "حسین"
}'

نمونه پاسخ موفق

{
  "firstNameSimilarityPercentage": 100,
  "lastNameSimilarityPercentage": 100,
  "fullNameSimilarityPercentage": 100,
  "fatherNameSimilarityPercentage": 100
}

نمونه پاسخ ناموفق

{
  "firstNameSimilarityPercentage": 0,
  "lastNameSimilarityPercentage": 0,
  "fullNameSimilarityPercentage": 0,
  "fatherNameSimilarityPercentage": 0
}
هویتی

همخوانی کدملی با حساب

بررسی تطابق کد ملی و تاریخ تولد با شماره حساب.

فعال
POST /api/v1/match/deposit-number-with-national

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

bankالزامی

کد بانک

string
depositNumberالزامی

شماره حساب

string
nationalCodeالزامی

کد ملی

string
birthDateالزامی

تاریخ تولد با فرمت YYYYmmDD

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/match/deposit-number-with-national' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "bank": "MELI",
  "depositNumber": "1234567890",
  "nationalCode": "0012345678",
  "birthDate": "13680101"
}'

نمونه پاسخ موفق

{
  "matched": true
}

نمونه پاسخ ناموفق

{
  "matched": false
}
هویتی

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

استعلام اطلاعات هویتی اتباع خارجی با شناسه فراگیر.

فعال
POST /api/v1/info/foreigner-identity-info

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

fidaالزامی

شناسه فراگیر یا شماره اختصاصی اتباع

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/foreigner-identity-info' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "fida": "0123456789"
}'

نمونه پاسخ موفق

{
  "fida": "0123456789",
  "foreignerIdentityInfo": {
    "fida": "0123456789",
    "firstName": "علی",
    "lastName": "محمدی"
  }
}
هویتی

استعلام وضعیت نظام وظیفه

استعلام وضعیت خدمت نظام وظیفه بر اساس کد ملی.

غیرفعال
POST /api/v1/info/military-service-status

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

nationalCodeالزامی

کد ملی

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/military-service-status' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "0012345678"
}'

نمونه پاسخ موفق

{
  "nationalCode": "0012345678",
  "militaryServiceQualificationInfo": {
    "qualified": true,
    "description": "نتیجه نمونه"
  }
}

نمونه پاسخ ناموفق

{
  "nationalCode": "0012345678",
  "militaryServiceQualificationInfo": {
    "qualified": false
  }
}
هویتی

استعلام وضعیت ثنا

بررسی وضعیت صدور ثنا بر اساس کد ملی و شماره موبایل.

غیرفعال
POST /api/v1/info/sana-status

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

nationalCodeالزامی

کد ملی

string
mobileNumberالزامی

شماره موبایل

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/sana-status' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "0012345678",
  "mobileNumber": "09123456789"
}'

نمونه پاسخ موفق

{
  "nationalCode": "0012345678",
  "registered": true
}

نمونه پاسخ ناموفق

{
  "nationalCode": "0012345678",
  "registered": false
}
خدماتی

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

استعلام اطلاعات آدرس از کد پستی.

فعال
POST /api/v1/info/address-info

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

codeالزامی

کد پستی

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/address-info' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "1234567890"
}'

نمونه پاسخ موفق

{
  "code": "0",
  "MessageFromCore": {
    "code": "1234567890",
    "addressInfo": {
      "postalCode": "1234567890",
      "address": "تهران، خیابان نمونه، پلاک ۱",
      "city": "تهران"
    }
  }
}
خدماتی

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

دریافت مختصات جغرافیایی مرتبط با کد پستی.

فعال
POST /api/v1/info/postal-coordinates

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

codeالزامی

کد پستی

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/postal-coordinates' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "1234567890"
}'

نمونه پاسخ موفق

{
  "code": "0",
  "MessageFromCore": {
    "code": "1234567890",
    "wgsInfo": {
      "postalCode": "1234567890",
      "latitude": 35.7,
      "longitude": 51.4
    }
  }
}
خدماتی

استعلام اطلاعات صنفی

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

فعال
POST /api/v1/info/corporation-identity-info

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

codeالزامی

شناسه صنفی ۱۰ رقمی

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/corporation-identity-info' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "0123456789"
}'

نمونه پاسخ موفق

{
  "code": "0",
  "MessageFromCore": {
    "code": "0123456789",
    "corporationIdentityInfo": {
      "code": "0123456789",
      "address": "نشانی نمونه",
      "licenses": []
    }
  }
}
اشخاص حقوقی

اطلاعات حقوقی شرکت

اطلاعات حقوقی شرکت بر اساس شناسه ملی حقوقی؛ هر خدمت تعرفه مستقل دارد.

فعال
POST /api/v1/legal/company-info

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

nationalCodeالزامی

شناسه ملی حقوقی ۱۱ رقمی

string
خروجی فقط مربوط به همین خدمت است؛ پرچم انتخاب اطلاعات اضافی قابل ارسال نیست.
curl --request POST \
  --url 'https://ehraz.io/api/v1/legal/company-info' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "14001234567"
}'
اشخاص حقوقی

مجوزهای شرکت

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

فعال
POST /api/v1/legal/certificates

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

nationalCodeالزامی

شناسه ملی حقوقی ۱۱ رقمی

string
خروجی فقط مربوط به همین خدمت است؛ پرچم انتخاب اطلاعات اضافی قابل ارسال نیست.
curl --request POST \
  --url 'https://ehraz.io/api/v1/legal/certificates' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "14001234567"
}'
اشخاص حقوقی

شرکت‌های مادر

شرکت‌های مادر بر اساس شناسه ملی حقوقی؛ هر خدمت تعرفه مستقل دارد.

فعال
POST /api/v1/legal/parents

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

nationalCodeالزامی

شناسه ملی حقوقی ۱۱ رقمی

string
خروجی فقط مربوط به همین خدمت است؛ پرچم انتخاب اطلاعات اضافی قابل ارسال نیست.
curl --request POST \
  --url 'https://ehraz.io/api/v1/legal/parents' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "14001234567"
}'
اشخاص حقوقی

شرکت‌های زیرمجموعه

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

فعال
POST /api/v1/legal/children

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

nationalCodeالزامی

شناسه ملی حقوقی ۱۱ رقمی

string
خروجی فقط مربوط به همین خدمت است؛ پرچم انتخاب اطلاعات اضافی قابل ارسال نیست.
curl --request POST \
  --url 'https://ehraz.io/api/v1/legal/children' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "14001234567"
}'
اشخاص حقوقی

مدیرعامل شرکت

مدیرعامل شرکت بر اساس شناسه ملی حقوقی؛ هر خدمت تعرفه مستقل دارد.

فعال
POST /api/v1/legal/ceo

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

nationalCodeالزامی

شناسه ملی حقوقی ۱۱ رقمی

string
خروجی فقط مربوط به همین خدمت است؛ پرچم انتخاب اطلاعات اضافی قابل ارسال نیست.
curl --request POST \
  --url 'https://ehraz.io/api/v1/legal/ceo' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "14001234567"
}'
اشخاص حقوقی

اعضای شرکت

اعضای شرکت بر اساس شناسه ملی حقوقی؛ هر خدمت تعرفه مستقل دارد.

فعال
POST /api/v1/legal/members

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

nationalCodeالزامی

شناسه ملی حقوقی ۱۱ رقمی

string
خروجی فقط مربوط به همین خدمت است؛ پرچم انتخاب اطلاعات اضافی قابل ارسال نیست.
curl --request POST \
  --url 'https://ehraz.io/api/v1/legal/members' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "14001234567"
}'
اشخاص حقوقی

امضاداران شرکت

امضاداران شرکت بر اساس شناسه ملی حقوقی؛ هر خدمت تعرفه مستقل دارد.

فعال
POST /api/v1/legal/sign-holders

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

nationalCodeالزامی

شناسه ملی حقوقی ۱۱ رقمی

string
خروجی فقط مربوط به همین خدمت است؛ پرچم انتخاب اطلاعات اضافی قابل ارسال نیست.
curl --request POST \
  --url 'https://ehraz.io/api/v1/legal/sign-holders' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "14001234567"
}'
اشخاص حقوقی

روزنامه رسمی / آگهی‌های شرکت

روزنامه رسمی / آگهی‌های شرکت بر اساس شناسه ملی حقوقی؛ هر خدمت تعرفه مستقل دارد.

فعال
POST /api/v1/legal/official-gazette

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

nationalCodeالزامی

شناسه ملی حقوقی ۱۱ رقمی

string
فقط آگهی‌های موجود با مشخصات روزنامه برگردانده می‌شود؛ فایل PDF یا پوشش کامل بایگانی تضمین نمی‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/legal/official-gazette' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "14001234567"
}'
چک

استعلام چک صیادی

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

غیرفعال
POST /api/v1/info/cheque-info

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

nationalCodeالزامی

کد ملی

string
sayadIdالزامی

شناسه صیادی

string
holderاختیاری

دریافت اطلاعات دارنده؛ پیش‌فرض false

boolean
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/info/cheque-info' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "0012345678",
  "sayadId": "1234567890123456",
  "holder": false
}'

نمونه پاسخ موفق

{
  "nationalCode": "0012345678",
  "chequeInfo": {
    "sayadId": "1234567890123456",
    "amount": 10000000,
    "dueDate": "14051201"
  }
}
چک

درخواست رمز استعلام چک برگشتی

مرحله اول: ارسال رمز تایید به صاحب شماره همراه برای استعلام چک برگشتی.

غیرفعال
POST /api/v1/cheque/bounced/otp

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

nationalCodeالزامی

کد ملی

string
mobileNumberالزامی

شماره همراه صاحب کد ملی

string
با رضایت صاحب اطلاعات درخواست دهید. referenceCode را برای مرحله بعد نگه دارید. هر مرحله تعرفه مستقل دارد.
curl --request POST \
  --url 'https://ehraz.io/api/v1/cheque/bounced/otp' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "0012345678",
  "mobileNumber": "09123456789"
}'

نمونه پاسخ موفق

{
  "nationalCode": "0012345678",
  "mobileNumber": "09123456789",
  "referenceCode": "EXAMPLE-REFERENCE"
}
چک

تعداد چک‌های برگشتی

مرحله دوم: دریافت تعداد چک برگشتی پس از تایید رمز پیامکی.

غیرفعال
POST /api/v1/cheque/bounced/count

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

nationalCodeالزامی

همان کد ملی مرحله اول

string
mobileNumberالزامی

همان شماره همراه مرحله اول

string
otpCodeالزامی

رمز پیامکی صاحب اطلاعات

string
referenceCodeالزامی

شناسه مرحله درخواست رمز

string
همه سرویس‌های فعال سامانه برای حساب شما در دسترس است و هزینه فقط هنگام استفاده از کیف پول کسر می‌شود.
curl --request POST \
  --url 'https://ehraz.io/api/v1/cheque/bounced/count' \
  --header 'Authorization: Token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nationalCode": "0012345678",
  "mobileNumber": "09123456789",
  "otpCode": "123456",
  "referenceCode": "EXAMPLE-REFERENCE"
}'

نمونه پاسخ موفق

{
  "nationalCode": "0012345678",
  "mobileNumber": "09123456789",
  "referenceCode": "EXAMPLE-REFERENCE",
  "count": 0
}