مستندات API شخص حقوقی

راهنمای اتصال سرویس

شخص حقوقی

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

GET/api/v1/rmto/person/legal

X-API-Keyدسترسی مورد نیاز: persons:readپارامترها در Queryمصرف سهمیه طبق شرایط اشتراک

ورودی‌های درخواست

پارامترها را با نام دقیق در query string ارسال کنید. نوع داده و الزامی بودن هر فیلد را پیش از ارسال بررسی کنید.

nationalCodestringالزامی

شناسه ملی شخصیت حقوقی

نمونه: 14001234567

پارامترها در query ارسال می‌شوند. هر مقدار الزامی، حداکثر ۱۲۸ کاراکتر و بدون کاراکتر کنترلی است؛ نام فیلدها و حروف آن‌ها را مطابق قرارداد نگه دارید.
شناسه ملی شخص حقوقی باید رشته‌ای شامل ۱۰ تا ۱۴ رقم لاتین باشد.
هر فیلد حداکثر ۱۲۸ نویسه و بدون نویسه کنترلی است؛ ورودی نامعتبر پیش از ارسال به راهداری رد می‌شود.

نمونه درخواستسمت سرور

# Use your test key. Example inputs are synthetic; no automatic retry.
# Set BARBAN_API_KEY privately before running this example.
curl --request GET 'https://api.bar-ban.ir/api/v1/rmto/person/legal?nationalCode=14001234567' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-person-legal-001" \
  --header "Accept: application/json"

مقادیر نمونه‌اند. کپی کد هیچ درخواستی ارسال نمی‌کند.

کلید آزمایشی بدون فراخوانی راهداری پاسخ می‌دهد؛ کسر سهمیه به تنظیمات خریداری‌شده پلن بستگی دارد.

قرارداد با WSDL نسخه V03 در 2026-10-20 تطبیق داده شده است؛ موفقیت استعلام عملیاتی نیازمند مجوز و حساب معتبر راهداری است.

ساختار پاسخ

JSON

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

نمونه آموزشی پاسخ

{
  "requestId": "example-person-legal-001",
  "sandbox": true,
  "found": true,
  "data": {
    "sandbox": true,
    "service": "person-legal",
    "message": "احراز هویت و ساختار درخواست معتبر است؛ راهداری فراخوانی نشد."
  },
  "error": null
}

فیلدهای داده پاسخ ۷ فیلد

فیلد	نوع و مقدار تهی	توضیح
`ErrorDesc`	`string`می‌تواند null باشد	شرح خطا
`FullAddress`	`string`می‌تواند null باشد	نشانی کامل
`IsSuccessful`	`boolean`غیرتهی	نتیجه موفق
`LastName`	`string`می‌تواند null باشد	نام خانوادگی
`Name`	`string`می‌تواند null باشد	نام
`SuccessfulDesc`	`string`می‌تواند null باشد	توضیح تأیید
`WarningDesc`	`string`می‌تواند null باشد	هشدار

پاسخ نامنتظره گرفتید؟راهنمای پاسخ‌ها و خطاها آماده اتصال هستید؟مرور نکات محیط عملیاتی