مرجع api / commercial/companies/{nid}/active-status/
وضعیت فعال شرکت
بررسی وجود و فعال بودن یک شرکت بر اساس شناسه ملی.
commercial/companies/{national_id}/active-status/وضعیت فعال بودن یک شرکت را بررسی می‌کند: آیا در سامانه ثبت‌شده، آیا منحل شده، و آیا داده‌ها به‌روزرسانی شده‌اند. سریع‌ترین راه برای اعتبارسنجی یک شناسه ملی شرکتی پیش از فراخوانی‌های پولی‌تر.
هدرها
X-API-KEYstringبلهکلید api شما. هزینه از کیف‌پول دارنده همین کلید کسر می‌شود.
پارامترهای کوئری
national_idstringبلهشناسه ملی شرکت (۱۱ رقم). به عنوان path parameter ارسال می‌شود.
idempotency_keystringبلهUUID یکتا برای هر نیت کاربر. در صورت تلاش مجدد همان درخواست، از همان کلید استفاده کنید — سرور نتیجه تراکنش قبلی را برمی‌گرداند و کیف‌پول دو بار کسر نمی‌شود.
نمونه درخواست
curl -X GET 'https://www.saravar.com/api/commercial/companies/12345678901/active-status/?idempotency_key=550e8400-e29b-41d4-a716-446655440000' \-H 'X-API-KEY: <YOUR_API_KEY>'
پاسخ
debit_transaction_idinteger | nullبلهشناسه تراکنش کسر اعتبار. در داشبورد قابل ردگیری است.
total_chargedintegerبلهمبلغ کسر شده بر حسب IRR.
data.national_idstringبلهشناسه ملی شرکت.
data.is_activebooleanبلهآیا شرکت فعال است (منحل نشده).
data.dissolution_datestring | nullبلهتاریخ انحلال (در صورت وجود) به فرمت ISO.
data.has_syncedbooleanبلهآیا داده‌ها از منبع رسمی همگام‌سازی شده‌اند.
نکات قیمت‌گذاری و رفتار
- هزینه به ازای هر فراخوانی موفق محاسبه می‌شود. خطاها هرگز هزینه‌بر نیستند.
- حداقل کارمزد به ازای هر فراخوانی موفق اعمال می‌شود. مقدار دقیق در صفحه قیمت‌گذاری اعلام شده است.
خطاها
400کد وضعیت401کد وضعیت403کد وضعیت404کد وضعیت429کد وضعیت