مرجع api / commercial/companies/role-check/
اعتبارسنجی نقش
بررسی اینکه آیا شخصی هم‌اکنون نقش مشخصی را در شرکت دارد.
POST
commercial/companies/role-check/اعتبارسنجی این که آیا شخصی هم‌اکنون نقش مشخصی را در یک شرکت دارد یا خیر. اگر role_type ارسال نشود، صرفاً وجود هر نقش فعال بررسی می‌شود. این endpoint با persons/role-check/ معادل است.
نیازمند اعتبار20 درخواست در دقیقه
هدرها
X-API-KEYstringبلهکلید api شما.
Content-Typestringبلهdefault:
application/jsonباید application/json باشد.
بدنه درخواست
company_national_idstringبلهشناسه ملی شرکت (۱۱ رقم).
person_national_idstringبلهشناسه ملی شخص (۱۰ رقم).
role_typestringنوع نقش برای بررسی. مقادیر مجاز: ceo، chairman، vice_chairman، inspector، alternative_inspector، liquidator، board_member، signing_authority. در صورت عدم ارسال، وجود هر نقش فعال بررسی می‌شود.
idempotency_keystringبلهUUID یکتا.
نمونه درخواست
curl -X POST 'https://www.saravar.com/api/commercial/companies/role-check/' \-H 'X-API-KEY: <YOUR_API_KEY>' \-H 'Content-Type: application/json' \-d '{"company_national_id": "12345678901","person_national_id": "1234567890","role_type": "ceo","idempotency_key": "550e8400-e29b-41d4-a716-446655440000"}'
پاسخ
debit_transaction_idinteger | nullبلهشناسه تراکنش کسر اعتبار.
total_chargedintegerبلهمبلغ کسر شده بر حسب IRR.
data.is_validbooleanبلهآیا نقش معتبر و فعال است.
data.role_typestring | nullبلهنوع نقش تأیید شده (در صورت is_valid=true).
data.role_namestring | nullبلهنام فارسی نقش.
data.date_assignedstring | nullبلهتاریخ شروع نقش.
data.expire_datestring | nullبلهتاریخ پایان نقش (در صورت وجود).
نکات قیمت‌گذاری و رفتار
- یک واحد به ازای هر فراخوانی موفق محاسبه می‌شود — صرف‌نظر از اینکه نتیجه is_valid=true یا false باشد.
- حداقل کارمزد به ازای هر فراخوانی موفق اعمال می‌شود.
خطاها
400کد وضعیتعلتپارامتر اجباری مفقود، role_type نامعتبر، یا insufficient_credits.
اقدام پیشنهادیبدنه را بررسی کنید و در صورت نیاز کیف‌پول را شارژ کنید.
401کد وضعیتعلتکلید api نامعتبر است.
اقدام پیشنهادیکلید فعال بسازید.
403کد وضعیتعلتاحراز هویت ملی تکمیل نشده.
اقدام پیشنهادیاحراز هویت را تکمیل کنید.
404کد وضعیتعلتشرکت یا شخص یافت نشد.
اقدام پیشنهادیشناسه‌های ملی را بررسی کنید.
429کد وضعیتعلتاز سقف نرخ عبور کرده‌اید.
اقدام پیشنهادیbackoff اعمال کنید.