hesabix/arc
Watch
1
0
Fork
You've already forked arc
 1
Code Issues 2 Pull requests Projects Releases 25 Packages Wiki Activity Actions
arc/zohal.json
Babak Alizadeh 0764deeaa1 change file permissions
2026-04-14 19:34:55 +03:30

8649 lines
No EOL
353 KiB
JSON
Executable file
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"openapi": "3.0.3",
"info": {
"title": "مستندات پیاده‌سازی زحل",
"description": "به راهنمای وب‌سرویس‌های **زحل** خوش آمدید. این مستندات با هدف سهولت در استفاده شما از سرویس‌های زحل تهیه شده‌اند. در صورت وجود هرگونه پرسش، می‌توانید با تیم فنی زحل در ارتباط باشید. همکاران ما در کوتاه‌ترین زمان ممکن پاسخگوی شما خواهند بود.\n\n### **نکات مهم پیش از پیاده‌سازی:**\n\n1. تمامی درخواست‌های شما از طریق بخش **توسعه‌دهندگان → فراخوانی‌ها** قابل مشاهده است.\n \n2. وب‌سرویس‌های زحل **RESTful** بوده و تمامی درخواست‌ها و پاسخ‌ها در قالب **JSON** مبادله می‌شوند.\n \n3. مقادیر بازگشتی در فیلد result به شرح زیر است:\n \n - 1 : درخواست موفق\n \n - 4 : درخواست نامعتبر\n \n - 5 : خطای داخلی سرور زحل\n \n - 6 : خطاهای مربوط به ورودی نادرست\n\n \n\n```\nدر صورت دریافت خطا، با بررسی پارامترهای ارسالی می‌توانید علت بروز مشکل را شناسایی کنید.\n\n ```\n\n1. زحل تنها به درخواست‌هایی پاسخ می‌دهد که از **IPهای اعلام‌شده توسط شما** ارسال شوند.\n \n2. در صورت دریافت خطا از سمت زحل، لطفاً پس از بررسی مقادیر ارسالی، خطا را همراه با مقادیر درخواست و پاسخ دریافتی برای ما ارسال کنید. ما از احتمال بروز خطا آگاه هستیم و در سریع‌ترین زمان ممکن جهت رفع آن اقدام خواهیم کرد.\n \n3. تیم فنی زحل از طریق **بخش پشتیبانی پنل کاربری** و همچنین شماره تماس **+982191030739** آماده پاسخگویی به سوالات شماست.\n \n\n| Result | **Status Code** | **توضیحات** | **متن خطا** |\n| --- | --- | --- | --- |\n| 6 | 503 | سرویس مورد نظر در حال حاضر در دسترس نیست | SERVICE_UNAVAILABLE |\n| 5 | 500 | نا موفق | INTERNAL_ERROR |\n| 6 | 404 | سرویس مورد نظر یافت نشد | SERVICE_NOT_FOUND |\n\n📅 **آخرین به‌روزرسانی:** ۳۰ مرداد ۱۴۰۴",
"version": "1.0.0",
"contact": {}
},
"servers": [
{
"url": "https://service.zohal.io/api/v0"
}
],
"paths": {
"/services/inquiry/card_inquiry": {
"post": {
"tags": [
"بانکی"
],
"summary": "استعلام نام صاحب کارت",
"description": "وب سرویس استعلام کارت بانکی با دریافت ورودی card_number، اطلاعات صاحب کارت را بازیابی می‌کند. در خروجی JSON، فیلد data شامل نام دارنده کارت (name) است. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای سامانه‌های مالی، پرداخت آنلاین و کسب‌وکارها کاربرد دارد و امکان شناسایی سریع و امن مالک کارت را فراهم می‌کند.",
"operationId": "",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"card_number": {
"type": "string",
"example": "6362XXXXXXX11"
}
}
},
"examples": {
"استعلام نام صاحب کارت": {
"value": {
"card_number": "6362XXXXXXX11"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success / Card Not Found / Card Not Active / Card Number Not Valid / Card Expired / Account Not Active / Card Lost",
"headers": {
"Allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "154"
}
},
"Cross-Origin-Opener-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 08 Nov 2025 10:18:47 GMT"
}
},
"Referrer-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Server": {
"schema": {
"type": "string",
"example": "WSGIServer/0.2 CPython/3.11.7"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "TimerPanel_utime;dur=84.96700000000601;desc=\"User CPU time\", TimerPanel_stime;dur=16.711999999998284;desc=\"System CPU time\", TimerPanel_total;dur=101.6790000000043;desc=\"Total CPU time\", TimerPanel_total_time;dur=1872.67804899966;desc=\"Elapsed time\", SQLPanel_sql_time;dur=6.213278997165617;desc=\"SQL 4 queries\", CachePanel_total_time;dur=0.9308869994129054;desc=\"Cache 2 Calls\""
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept, origin, Cookie"
}
},
"X-Content-Type-Options": {
"schema": {
"type": "string",
"example": "nosniff"
}
},
"X-Frame-Options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "نام صاحب کارت "
}
}
},
"error_code": {
"type": "string",
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Account Not Active": {
"value": {
"response_body": {
"data": {},
"error_code": "ACCOUNT_NOT_ACTIVE",
"message": "حساب متصل به کارت فعال نیست"
},
"result": 1
}
},
"Card Expired": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_EXPIRED",
"message": "کارت منقضی شده است"
},
"result": 1
}
},
"Card Lost": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_LOST",
"message": "کارت گم شده است"
},
"result": 1
}
},
"Card Not Active": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_NOT_ACTIVE",
"message": "کارت غیر فعال است"
},
"result": 1
}
},
"Card Not Found": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_NOT_FOUND",
"message": "کارت وارد شده در سيستم بانکي وجود ندارد"
},
"result": 1
}
},
"Card Number Not Valid": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_NUMBER_NOT_VALID",
"message": "شماره کارت نامعتبر است"
},
"result": 1
}
},
"Success": {
"value": {
"response_body": {
"data": {
"name": "نام صاحب کارت "
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/card_to_iban": {
"post": {
"tags": [
"بانکی"
],
"summary": "تبدیل کارت به شبا",
"description": "وب سرویس تبدیل کارت به شبا (Card to IBAN) برای استخراج اطلاعات بانکی از روی شماره کارت طراحی شده است. این سرویس با دریافت تنها یک ورودی یعنی شماره کارت بانکی، پس از استعلام از شبکه بانکی، در خروجی JSON اطلاعاتی شامل نام صاحب کارت، شماره شبای متناظر (IBAN) و نام بانک صادرکننده را بازمی‌گرداند. در صورت موفقیت، مقدار result برابر با ۱ بوده و پیام وضعیت نیز “موفق” نمایش داده می‌شود. این وب سرویس به ویژه در سامانه‌های مالی، حسابداری و پرداخت آنلاین کاربرد دارد و به کسب‌وکارها امکان می‌دهد تا بدون خطا و به‌صورت خودکار، شماره کارت را به شماره شبا تبدیل کرده و فرآیندهای بانکی مانند انتقال وجه یا شناسایی حساب مقصد را با دقت و امنیت بالا انجام دهند.",
"operationId": "1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"card_number": {
"type": "string",
"example": "6362XXXXXXX11"
}
}
},
"examples": {
"تبدیل کارت به شبا": {
"value": {
"card_number": "6362XXXXXXX11"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 14:45:33 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=7263"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "de6d2567c3f87f6c8fb22aa2bce30119"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"IBAN": {
"type": "string",
"example": "IRXXXXXXXXXXX"
},
"bank_name": {
"type": "string",
"example": "آینده"
},
"name": {
"type": "string",
"example": "نام صاحب کارت"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"IBAN": "IRXXXXXXXXXXX",
"bank_name": "آینده",
"name": "نام صاحب کارت"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/account_to_iban": {
"post": {
"tags": [
"بانکی"
],
"summary": "تبدیل حساب به شبا",
"description": "وب سرویس تبدیل شماره حساب به شماره شبا (IBAN) با دریافت دو ورودی bank_account و bank_code، شماره حساب بانکی را به شماره شبا متناظر تبدیل می‌کند. در خروجی JSON، فیلد IBAN شماره شبا مربوط به حساب را ارائه می‌دهد. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای سامانه‌های مالی، حسابداری و پرداخت آنلاین کاربرد دارد و امکان انجام تراکنش‌ها و بررسی صحت شماره حساب‌ها را به صورت امن و خودکار فراهم می‌کند.",
"operationId": "2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bank_account": {
"type": "string",
"example": "4600000XXX660"
},
"bank_code": {
"type": "string",
"example": "062"
}
}
},
"examples": {
"تبدیل حساب به شبا": {
"value": {
"bank_account": "4600000XXX660",
"bank_code": "062"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success / Account Not Active",
"headers": {
"Allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "154"
}
},
"Cross-Origin-Opener-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 08 Nov 2025 10:18:47 GMT"
}
},
"Referrer-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Server": {
"schema": {
"type": "string",
"example": "WSGIServer/0.2 CPython/3.11.7"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "TimerPanel_utime;dur=84.96700000000601;desc=\"User CPU time\", TimerPanel_stime;dur=16.711999999998284;desc=\"System CPU time\", TimerPanel_total;dur=101.6790000000043;desc=\"Total CPU time\", TimerPanel_total_time;dur=1872.67804899966;desc=\"Elapsed time\", SQLPanel_sql_time;dur=6.213278997165617;desc=\"SQL 4 queries\", CachePanel_total_time;dur=0.9308869994129054;desc=\"Cache 2 Calls\""
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept, origin, Cookie"
}
},
"X-Content-Type-Options": {
"schema": {
"type": "string",
"example": "nosniff"
}
},
"X-Frame-Options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"IBAN": {
"type": "string",
"example": "IR700620000000XXX295898001"
}
}
},
"error_code": {
"type": "string",
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Account Not Active": {
"value": {
"response_body": {
"data": {},
"error_code": "ACCOUNT_NOT_ACTIVE",
"message": "حساب متصل به کارت فعال نیست"
},
"result": 1
}
},
"Success": {
"value": {
"response_body": {
"data": {
"IBAN": "IR700620000000XXX295898001"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/check_card_with_name": {
"post": {
"tags": [
"بانکی"
],
"summary": "تطابق کارت و نام صاحب کارت",
"description": "وب سرویس بررسی تطابق کارت بانکی با نام صاحب کارت با دریافت دو ورودی card_number و name، صحت اطلاعات مالک کارت را بررسی می‌کند. در خروجی JSON، فیلد data شامل نام صاحب کارت (name) است و نشان‌دهنده مطابقت یا عدم مطابقت اطلاعات وارد شده می‌باشد. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس به کسب‌وکارها و سامانه‌های مالی امکان می‌دهد تا صحت اطلاعات کارت و نام مالک را به صورت سریع و امن تأیید کرده و از بروز خطا یا سوءاستفاده جلوگیری کنند.",
"operationId": "3",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"card_number": {
"type": "string",
"example": "63621XXX33007361"
},
"name": {
"type": "string",
"example": "محمد صادقی"
}
}
},
"examples": {
"تطابق کارت و نام صاحب کارت": {
"value": {
"card_number": "63621XXX33007361",
"name": "محمد صادقی"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success / Card Expired / Account Not Active / Card Lost",
"headers": {
"Allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "154"
}
},
"Cross-Origin-Opener-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 08 Nov 2025 10:18:47 GMT"
}
},
"Referrer-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Server": {
"schema": {
"type": "string",
"example": "WSGIServer/0.2 CPython/3.11.7"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "TimerPanel_utime;dur=84.96700000000601;desc=\"User CPU time\", TimerPanel_stime;dur=16.711999999998284;desc=\"System CPU time\", TimerPanel_total;dur=101.6790000000043;desc=\"Total CPU time\", TimerPanel_total_time;dur=1872.67804899966;desc=\"Elapsed time\", SQLPanel_sql_time;dur=6.213278997165617;desc=\"SQL 4 queries\", CachePanel_total_time;dur=0.9308869994129054;desc=\"Cache 2 Calls\""
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept, origin, Cookie"
}
},
"X-Content-Type-Options": {
"schema": {
"type": "string",
"example": "nosniff"
}
},
"X-Frame-Options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "نام صاحب کارت"
}
}
},
"error_code": {
"type": "string",
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Account Not Active": {
"value": {
"response_body": {
"data": {},
"error_code": "ACCOUNT_NOT_ACTIVE",
"message": "حساب متصل به کارت فعال نیست"
},
"result": 1
}
},
"Card Expired": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_EXPIRED",
"message": "کارت منقضی شده است"
},
"result": 1
}
},
"Card Lost": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_LOST",
"message": "کارت گم شده است"
},
"result": 1
}
},
"Success": {
"value": {
"response_body": {
"data": {
"name": "نام صاحب کارت"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/check_iban_with_name": {
"post": {
"tags": [
"بانکی"
],
"summary": "تطابق شبا و نام صاحب شبا",
"description": "وب سرویس بررسی تطابق شماره شبا (IBAN) با نام صاحب حساب با دریافت دو ورودی name و IBAN، صحت مالکیت حساب بانکی را احراز می‌کند. در خروجی JSON، فیلدی به نام matched وجود دارد که در صورت تطابق حساب با نام فرد مقدار آن true خواهد بود. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای سامانه‌های مالی، پرداخت آنلاین و کسب‌وکارها اهمیت دارد و امکان بررسی سریع و امن صحت اطلاعات حساب و جلوگیری از استفاده غیرمجاز یا تقلب را فراهم می‌کند.",
"operationId": "4",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"IBAN": {
"type": "string",
"example": "IR700620000000XXX295898001"
},
"name": {
"type": "string",
"example": "صادق بارانی"
}
}
},
"examples": {
"تطابق شبا و نام صاحب شبا": {
"value": {
"IBAN": "IR700620000000XXX295898001",
"name": "صادق بارانی"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 14:39:23 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=800"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "89c65c303e378dd90ce37e128de470ba"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"matched": {
"type": "boolean",
"example": true
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"matched": true
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/card_to_account": {
"post": {
"tags": [
"بانکی"
],
"summary": "تبدیل کارت به حساب",
"description": "وب سرویس تبدیل شماره کارت به شماره حساب بانکی با دریافت ورودی card_number، اطلاعات حساب مربوط به کارت را ارائه می‌دهد. خروجی JSON شامل نام صاحب کارت (name)، نام بانک (bank_name) و شماره حساب متناظر (bank_account) است. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای سامانه‌های مالی، پرداخت آنلاین و کسب‌وکارها کاربرد دارد و امکان بررسی سریع و امن شماره کارت و اطلاعات حساب مرتبط را فراهم می‌کند.",
"operationId": "5",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"card_number": {
"type": "string",
"example": "636XXX1100119421"
}
}
},
"examples": {
"تبدیل کارت به حساب": {
"value": {
"card_number": "636XXX1100119421"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success / Card Not Found / Card Not Active / Card Number Not Valid / Card Expired / Account Not Active / Card Lost",
"headers": {
"Allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "154"
}
},
"Cross-Origin-Opener-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 08 Nov 2025 10:18:47 GMT"
}
},
"Referrer-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Server": {
"schema": {
"type": "string",
"example": "WSGIServer/0.2 CPython/3.11.7"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "TimerPanel_utime;dur=84.96700000000601;desc=\"User CPU time\", TimerPanel_stime;dur=16.711999999998284;desc=\"System CPU time\", TimerPanel_total;dur=101.6790000000043;desc=\"Total CPU time\", TimerPanel_total_time;dur=1872.67804899966;desc=\"Elapsed time\", SQLPanel_sql_time;dur=6.213278997165617;desc=\"SQL 4 queries\", CachePanel_total_time;dur=0.9308869994129054;desc=\"Cache 2 Calls\""
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept, origin, Cookie"
}
},
"X-Content-Type-Options": {
"schema": {
"type": "string",
"example": "nosniff"
}
},
"X-Frame-Options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"bank_account": {
"type": "string",
"example": "شماره حساب"
},
"bank_name": {
"type": "string",
"example": "نام بانک"
},
"name": {
"type": "string",
"example": "نام صاحب کارت "
}
}
},
"error_code": {
"type": "string",
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Account Not Active": {
"value": {
"response_body": {
"data": {},
"error_code": "ACCOUNT_NOT_ACTIVE",
"message": "حساب متصل به کارت فعال نیست"
},
"result": 1
}
},
"Card Expired": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_EXPIRED",
"message": "کارت منقضی شده است"
},
"result": 1
}
},
"Card Lost": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_LOST",
"message": "کارت گم شده است"
},
"result": 1
}
},
"Card Not Active": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_NOT_ACTIVE",
"message": "کارت غیر فعال است"
},
"result": 1
}
},
"Card Not Found": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_NOT_FOUND",
"message": "کارت وارد شده در سيستم بانکي وجود ندارد"
},
"result": 1
}
},
"Card Number Not Valid": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_NUMBER_NOT_VALID",
"message": "شماره کارت نامعتبر است"
},
"result": 1
}
},
"Success": {
"value": {
"response_body": {
"data": {
"bank_account": "شماره حساب",
"bank_name": "نام بانک",
"name": "نام صاحب کارت "
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/iban": {
"post": {
"tags": [
"بانکی"
],
"summary": "استعلام شبا",
"description": "وب‌سرویس استعلام IBAN با دریافت تنها ورودی iban، شماره شبای ورودی را در شبکه بانکی بررسی کرده و خروجی JSON حاوی اطلاعات حساب را بازمی‌گرداند؛ در فیلد data نام صاحب حساب (name)، نام بانک صادرکننده (bank_name) و یک بولین نشان‌دهنده قابلیت انتقال وجه به آن حساب (is_transferable) قرار دارد، و در سطح بالاتر فیلدهای message (پیام وضعیت)، error_code (در صورت خطا) و result (وضعیت کلی، معمولاً ۱ برای موفقیت) موجود است. این سرویس برای اعتبارسنجی مقصد انتقال و اتوماسیون فرایندهای پرداخت و تسویه در سامانه‌های مالی و پرداخت آنلاین کاربرد دارد.",
"operationId": "6",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"iban": {
"type": "string",
"example": "IR96056061182xxxxxxxxxxxx1"
}
}
},
"examples": {
"استعلام شبا": {
"value": {
"iban": "IR96056061182xxxxxxxxxxxx1"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success / IBAN Not Valid / IBAN Not Found",
"headers": {
"Allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "138"
}
},
"Cross-Origin-Opener-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 08 Nov 2025 10:39:20 GMT"
}
},
"Referrer-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Server": {
"schema": {
"type": "string",
"example": "WSGIServer/0.2 CPython/3.11.7"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "TimerPanel_utime;dur=95.37900000000121;desc=\"User CPU time\", TimerPanel_stime;dur=21.99099999999987;desc=\"System CPU time\", TimerPanel_total;dur=117.37000000000108;desc=\"Total CPU time\", TimerPanel_total_time;dur=1816.3158499992278;desc=\"Elapsed time\", SQLPanel_sql_time;dur=7.908539999334607;desc=\"SQL 4 queries\", CachePanel_total_time;dur=1.2866879987996072;desc=\"Cache 2 Calls\""
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept, origin, Cookie"
}
},
"X-Content-Type-Options": {
"schema": {
"type": "string",
"example": "nosniff"
}
},
"X-Frame-Options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"bank_name": {
"type": "string",
"example": "آينده"
},
"is_transferable": {
"type": "boolean",
"example": true
},
"name": {
"type": "string",
"example": "خیریه‌ تو‌انبخشی‌ بچه‌ ‌های‌ ‌آسمان‌ کامر‌ان‌"
}
}
},
"error_code": {
"type": "string",
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"IBAN Not Found": {
"value": {
"response_body": {
"data": {},
"error_code": "IBAN_NOT_FOUND",
"message": "کد شبای ورودی یافت نشد"
},
"result": 1
}
},
"IBAN Not Valid": {
"value": {
"response_body": {
"data": {},
"error_code": "IBAN_NOT_VALID",
"message": "شماره شبای وارد شده معتبر نیست"
},
"result": 1
}
},
"Success": {
"value": {
"response_body": {
"data": {
"bank_name": "آينده",
"is_transferable": true,
"name": "خیریه‌ تو‌انبخشی‌ بچه‌ ‌های‌ ‌آسمان‌ کامر‌ان‌"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/check_sayad_inquiry": {
"post": {
"tags": [
"بانکی"
],
"summary": "استعلام چک صیادی",
"description": "وب سرویس استعلام چک‌های صیادی (Sayad) با دریافت ورودی sayad_id، اطلاعات جامع مربوط به چک صیادی را ارائه می‌دهد. در خروجی JSON، فیلد data شامل شماره شبا صاحب چک (iban)، نام صادرکننده (name)، شناسه صیادی (sayad_id)، شماره سریال و سری چک، نوع چک (check_type)، تاریخ صدور (issue_date)، کد شعبه (branch_code)، تاریخ سررسید (expiration_date) و وضعیت چک‌های برگشتی مرتبط (returned_cheques) است. فیلدهای message و error_code وضعیت پردازش را مشخص می‌کنند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای سامانه‌های بانکی، پرداخت و مدیریت ریسک مالی اهمیت دارد و امکان بررسی سریع و امن صحت و وضعیت چک‌های صیادی را فراهم می‌کند.",
"operationId": "7",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sayad_id": {
"type": "string",
"example": "12XXXXXXXXX000000"
}
}
},
"examples": {
"استعلام چک صیادی": {
"value": {
"sayad_id": "12XXXXXXXXX000000"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"branch_code": {
"type": "string",
"example": "56XXX48"
},
"check_type": {
"type": "string",
"example": "BANS"
},
"expiration_date": {
"nullable": true,
"example": null
},
"iban": {
"type": "string",
"example": "IR02XXX00XXXXX0049XXXXX001"
},
"issue_date": {
"type": "string",
"example": "1370/1/1"
},
"name": {
"type": "string",
"example": "نام صادرکننده چک"
},
"returned_cheques": {
"type": "string",
"example": ""
},
"sayad_id": {
"type": "string",
"example": "12XXXXXXXXX000000"
},
"serial_no": {
"type": "string",
"example": "95XXX1"
},
"series_no": {
"type": "string",
"example": "4XXX4"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"branch_code": "56XXX48",
"check_type": "BANS",
"expiration_date": null,
"iban": "IR02XXX00XXXXX0049XXXXX001",
"issue_date": "1370/1/1",
"name": "نام صادرکننده چک",
"returned_cheques": "",
"sayad_id": "12XXXXXXXXX000000",
"serial_no": "95XXX1",
"series_no": "4XXX4"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/bounced_cheque": {
"post": {
"tags": [
"بانکی"
],
"summary": "استعلام چک برگشتی",
"description": "وب سرویس استعلام چک برگشتی با دریافت ورودی‌های national_code و nationality_type، امکان بررسی تعداد چک‌های برگشتی متعلق به فرد را فراهم می‌کند. در خروجی JSON، فیلد data شامل count است که تعداد چک‌های برگشتی ثبت شده را نشان می‌دهد. فیلدهای message و error_code وضعیت پردازش را مشخص می‌کنند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای بانک‌ها، سامانه‌های مالی و کسب‌وکارها اهمیت دارد و امکان بررسی سریع و امن سابقه مالی افراد و مدیریت ریسک پرداخت‌ها را فراهم می‌کند.",
"operationId": "8",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"national_code": {
"type": "string",
"example": "00XXXXXXX1"
},
"nationality_type": {
"type": "number",
"example": 1
}
}
},
"examples": {
"استعلام چک برگشتی": {
"value": {
"national_code": "00XXXXXXX1",
"nationality_type": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 03 Sep 2025 11:55:59 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=1106"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "e95c63f0a1fafc529ea7e786c1a6d4aa"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "5700"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"count": {
"type": "number",
"example": 0
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"count": 0
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/biometric/media/": {
"post": {
"tags": [
"احراز هویت ویدیویی"
],
"summary": "آپلود مدیا بایومتریک",
"description": "اولین قدم وب‌سرویس احراز هویت بیومتریک زحل این امکان را می‌دهد که با یک درخواست ساده‌ی POST و ارسال فیلد type=selfie_video، یک ویدئوی سلفی برای فرایندهای احراز هویت ثبت کنید. درخواست با توکن اختصاصی انجام می‌شود و در پاسخ، سرویس یک UUID یکتا برای مدیای بارگذاری‌شده همراه با نوع فایل و وضعیت عملیات (result=1) برمی‌گرداند تا در مراحل بعدی احراز هویت استفاده شود.",
"operationId": "9",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"type": {
"type": "string",
"example": "selfie_video"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200 Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Mon, 22 Sep 2025 10:02:41 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=700"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "22fb55480775908e8340af26ad5b726b"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2063"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "<UUID>"
},
"type": {
"type": "string",
"example": "selfie_video"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"200 Success": {
"value": {
"response_body": {
"id": "<UUID>",
"type": "selfie_video"
},
"result": 1
}
}
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/services/biometric/session/liveness/": {
"post": {
"tags": [
"احراز هویت ویدیویی"
],
"summary": "ثبت درخواست بررسی Liveness",
"description": "این درخواست یک جلسه Liveness را برای احراز هویت بیومتریک آغاز می‌کند. در فراخوانی بالا، شما UUID مربوط به ویدئوی سلفی را همراه با اطلاعات هویتی کاربر و یک ‌callback URL به سرویس ارسال می‌کنید. پس از ثبت موفق، وب‌سرویس یک session_id یکتا برمی‌گرداند و وضعیت اولیه را در حالت pending قرار می‌دهد تا نتیجه پردازش در ادامه از طریق وبهوک اعلام شود. نتیجه نهایی درخواست با مقدار result=1 مشخص می‌کند که جلسه با موفقیت ایجاد شده است.",
"operationId": "liveness",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"birth_date": {
"type": "string",
"example": "1300/01/01"
},
"callback_url": {
"type": "string",
"example": "https://webhook.site/d822407d-e1ce-4cea-bb27-f37bc526dab7"
},
"media": {
"type": "object",
"properties": {
"selfie_video": {
"type": "string",
"example": "a271d113-10f1-4633-8180-890e6cef84cc"
}
}
},
"national_card_serial": {
"type": "string",
"example": "1G34567890"
},
"national_code": {
"type": "string",
"example": "1111111111"
}
}
},
"examples": {
"ثبت درخواست بررسی Liveness": {
"value": {
"birth_date": "1300/01/01",
"callback_url": "https://webhook.site/d822407d-e1ce-4cea-bb27-f37bc526dab7",
"media": {
"selfie_video": "a271d113-10f1-4633-8180-890e6cef84cc"
},
"national_card_serial": "1G34567890",
"national_code": "1111111111"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200 Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Mon, 22 Sep 2025 10:04:49 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=277"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "ee903312b4af53d273081fd02e54f7c5"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2063"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"session_id": {
"type": "string",
"example": "<UUID>"
},
"status": {
"type": "string",
"example": "pending"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"200 Success": {
"value": {
"response_body": {
"session_id": "<UUID>",
"status": "pending"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/biometric/session/{id}/result": {
"get": {
"tags": [
"احراز هویت ویدیویی"
],
"summary": "دریافت نتیجه",
"description": "این فراخوانی برای دریافت نتیجه نهایی جلسه Liveness استفاده می‌شود. با ارسال یک درخواست ساده GET و ارائه‌ی session_id، سرویس وضعیت فعلی پردازش را برمی‌گرداند؛ شامل زمان اتمام (completed_at)، نتیجه نهایی (result)، علت احتمالی رد شدن (reason)، نوع جلسه (type) و وضعیت کنونی (status). این پاسخ مشخص می‌کند که فرآیند احراز هویت بیومتریک در چه مرحله‌ای است و آیا کاربر با موفقیت تأیید شده یا نیاز به تکرار دارد.",
"operationId": "10",
"responses": {
"200": {
"description": "Success / Face Not Match ID / Video Not Live / Video Bad Light / Video Bad Quality / Person Too Far Away / More Than One Person / No Person Detected / Unknown / Undefined",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Mon, 22 Sep 2025 10:05:23 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=46"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Cache": {
"schema": {
"type": "string",
"example": "BYPASS"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "e44016c3b28da5bb0e2fe9b79d6085af"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2063"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "GET, HEAD, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"completed_at": {
"nullable": true,
"example": null
},
"reason": {
"type": "string",
"example": "ACCEPT"
},
"result": {
"type": "string",
"example": "matched"
},
"status": {
"type": "string",
"example": "completed"
},
"type": {
"type": "string",
"example": "liveness"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Face Not Match ID": {
"value": {
"response_body": {
"completed_at": null,
"reason": "REJECT_FACE_NOT_MATCH_ID",
"result": "rejected",
"status": "completed",
"type": "liveness"
},
"result": 1
}
},
"More Than One Person": {
"value": {
"response_body": {
"completed_at": null,
"reason": "REJECT_MORE_THAN_ONE_PERSON",
"result": "rejected",
"status": "completed",
"type": "liveness"
},
"result": 1
}
},
"No Person Detected": {
"value": {
"response_body": {
"completed_at": null,
"reason": "REJECT_NO_PERSON_DETECTED",
"result": "rejected",
"status": "completed",
"type": "liveness"
},
"result": 1
}
},
"Person Too Far Away": {
"value": {
"response_body": {
"completed_at": null,
"reason": "REJECT_PERSON_TOO_FAR_AWAY",
"result": "rejected",
"status": "completed",
"type": "liveness"
},
"result": 1
}
},
"Success": {
"value": {
"response_body": {
"completed_at": null,
"reason": "ACCEPT",
"result": "matched",
"status": "completed",
"type": "liveness"
},
"result": 1
}
},
"Undefined": {
"value": {
"response_body": {
"completed_at": null,
"reason": "UNDEFINED",
"result": "",
"status": "completed",
"type": "liveness"
},
"result": 1
}
},
"Unknown": {
"value": {
"response_body": {
"completed_at": null,
"reason": "UNKNOWN",
"result": "rejected",
"status": "completed",
"type": "liveness"
},
"result": 1
}
},
"Video Bad Light": {
"value": {
"response_body": {
"completed_at": null,
"reason": "REJECT_VIDEO_BAD_LIGHT",
"result": "rejected",
"status": "completed",
"type": "liveness"
},
"result": 1
}
},
"Video Bad Quality": {
"value": {
"response_body": {
"completed_at": null,
"reason": "REJECT_VIDEO_BAD_QUALITY",
"result": "rejected",
"status": "completed",
"type": "liveness"
},
"result": 1
}
},
"Video Not Live": {
"value": {
"response_body": {
"completed_at": null,
"reason": "REJECT_VIDEO_NOT_LIVE",
"result": "rejected",
"status": "completed",
"type": "liveness"
},
"result": 1
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "UUID"
}
}
]
},
"/services/inquiry/shahkar": {
"post": {
"tags": [
"احراز هویت"
],
"summary": "شاهکار (تطابق کد ملی و موبایل)",
"description": "وب سرویس شاهکار با دریافت دو ورودی اصلی یعنی شماره موبایل و کد ملی، وظیفه دارد این اطلاعات را در پایگاه داده ملی تطبیق دهد و نتیجه را به صورت خروجی JSON بازگرداند. در پاسخ این سرویس، فیلدی با نام matched وجود دارد که در صورت مطابقت شماره تلفن همراه با کد ملی مقدار آن true خواهد بود. همچنین در خروجی پیام وضعیت درخواست (مانند “موفق”) و در صورت وجود مشکل، کد خطا نمایش داده می‌شود. این مکانیزم ساده و دقیق به سیستم‌ها و اپلیکیشن‌ها کمک می‌کند تا از صحت اطلاعات کاربر اطمینان حاصل کرده و امنیت فرآیندهایی مانند ثبت‌نام، احراز هویت و پرداخت آنلاین را تضمین کنند.",
"operationId": "11",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string",
"example": "09121xxxxx8"
},
"national_code": {
"type": "string",
"example": "0021xxxxx2"
}
}
},
"examples": {
"شاهکار (تطابق کد ملی و موبایل)": {
"value": {
"mobile": "09121xxxxx8",
"national_code": "0021xxxxx2"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200 Matched / 200 Not Matched",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 23 Aug 2025 10:57:00 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=618"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "b26a4f173f3625b5b0645237ab30d23c"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "6120"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"matched": {
"type": "boolean",
"example": true
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"200 Matched": {
"value": {
"response_body": {
"data": {
"matched": true
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
},
"200 Not Matched": {
"value": {
"response_body": {
"data": {
"matched": false
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
},
"400": {
"description": "400 Invalid National Code",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "113"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 23 Aug 2025 10:48:53 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=206"
}
},
"X-Cache": {
"schema": {
"type": "string",
"example": "BYPASS"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "7de084128a4f34c462004fb6f2838245"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "6120"
}
},
"allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"error_code": {
"type": "string",
"example": "invalid"
},
"message": {
"type": "string",
"example": "national_code: National code is wrong"
}
}
},
"result": {
"type": "number",
"example": 6
}
}
},
"examples": {
"400 Invalid National Code": {
"value": {
"response_body": {
"data": {},
"error_code": "invalid",
"message": "national_code: National code is wrong"
},
"result": 6
}
}
}
}
}
}
}
}
},
"/services/inquiry/check_iban_with_national_code": {
"post": {
"tags": [
"احراز هویت"
],
"summary": "تطابق کد ملی و شماره شبا",
"description": "وب سرویس بررسی تطابق شماره شبا (IBAN) با کد ملی با دریافت سه ورودی شامل کد ملی، تاریخ تولد و شماره شبا، صحت مالکیت حساب بانکی را احراز می‌کند. در خروجی JSON، فیلدی به نام matched وجود دارد که در صورت تطابق حساب با مشخصات فرد مقدار آن true خواهد بود. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای سامانه‌های مالی، پرداخت آنلاین و کسب‌وکارها اهمیت دارد، زیرا امکان بررسی سریع و امن صحت اطلاعات حساب بانکی و جلوگیری از استفاده غیرمجاز یا تقلب را فراهم می‌کند.",
"operationId": "12",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"IBAN": {
"type": "string",
"example": "IR70XXX0000000303795898001"
},
"birth_date": {
"type": "string",
"example": "1377/07/19"
},
"national_code": {
"type": "string",
"example": "1285XXX561"
}
}
},
"examples": {
"تطابق کد ملی و شماره شبا": {
"value": {
"IBAN": "IR70XXX0000000303795898001",
"birth_date": "1377/07/19",
"national_code": "1285XXX561"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success / Iban Not Valid / Iban Not Found",
"headers": {
"Allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "138"
}
},
"Cross-Origin-Opener-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 08 Nov 2025 10:39:20 GMT"
}
},
"Referrer-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Server": {
"schema": {
"type": "string",
"example": "WSGIServer/0.2 CPython/3.11.7"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "TimerPanel_utime;dur=95.37900000000121;desc=\"User CPU time\", TimerPanel_stime;dur=21.99099999999987;desc=\"System CPU time\", TimerPanel_total;dur=117.37000000000108;desc=\"Total CPU time\", TimerPanel_total_time;dur=1816.3158499992278;desc=\"Elapsed time\", SQLPanel_sql_time;dur=7.908539999334607;desc=\"SQL 4 queries\", CachePanel_total_time;dur=1.2866879987996072;desc=\"Cache 2 Calls\""
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept, origin, Cookie"
}
},
"X-Content-Type-Options": {
"schema": {
"type": "string",
"example": "nosniff"
}
},
"X-Frame-Options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"matched": {
"type": "boolean",
"example": true
}
}
},
"error_code": {
"type": "string",
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Iban Not Found": {
"value": {
"response_body": {
"data": {},
"error_code": "IBAN_NOT_VALID",
"message": "شماره شبای وارد شده معتبر نیست"
},
"result": 1
}
},
"Iban Not Valid": {
"value": {
"response_body": {
"data": {},
"error_code": "IBAN_NOT_VALID",
"message": "شماره شبای وارد شده معتبر نیست"
},
"result": 1
}
},
"Success": {
"value": {
"response_body": {
"data": {
"matched": true
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/check_card_with_national_code": {
"post": {
"tags": [
"احراز هویت"
],
"summary": "تطابق شماره کارت و کد ملی",
"description": "وب سرویس بررسی تطابق کارت بانکی با کد ملی با دریافت سه ورودی شامل کد ملی، تاریخ تولد و شماره کارت بانکی، صحت مالکیت کارت را احراز می‌کند. در خروجی JSON، فیلدی به نام matched وجود دارد که در صورت تطابق کارت با مشخصات فرد مقدار آن true خواهد بود. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای کسب‌وکارها، سامانه‌های مالی و پرداخت آنلاین اهمیت دارد، زیرا امکان بررسی سریع و امن صحت اطلاعات کارت و جلوگیری از تقلب یا استفاده غیرمجاز را فراهم می‌کند.",
"operationId": "13",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"birth_date": {
"type": "string",
"example": "1377/07/19"
},
"card_number": {
"type": "string",
"example": "6362XXXXXXX11"
},
"national_code": {
"type": "string",
"example": "1285XXX561"
}
}
},
"examples": {
"تطابق شماره کارت و کد ملی": {
"value": {
"birth_date": "1377/07/19",
"card_number": "6362XXXXXXX11",
"national_code": "1285XXX561"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success / Card Not Found",
"headers": {
"Allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "154"
}
},
"Cross-Origin-Opener-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 08 Nov 2025 10:45:45 GMT"
}
},
"Referrer-Policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"Server": {
"schema": {
"type": "string",
"example": "WSGIServer/0.2 CPython/3.11.7"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "TimerPanel_utime;dur=108.27700000000107;desc=\"User CPU time\", TimerPanel_stime;dur=20.270999999999262;desc=\"System CPU time\", TimerPanel_total;dur=128.54800000000034;desc=\"Total CPU time\", TimerPanel_total_time;dur=2268.3430980032426;desc=\"Elapsed time\", SQLPanel_sql_time;dur=7.524435000959784;desc=\"SQL 5 queries\", CachePanel_total_time;dur=0.8858869987307116;desc=\"Cache 2 Calls\""
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept, origin, Cookie"
}
},
"X-Content-Type-Options": {
"schema": {
"type": "string",
"example": "nosniff"
}
},
"X-Frame-Options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"matched": {
"type": "boolean",
"example": true
}
}
},
"error_code": {
"type": "string",
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Card Not Found": {
"value": {
"response_body": {
"data": {},
"error_code": "CARD_NOT_FOUND",
"message": "کارت وارد شده در سيستم بانکي وجود ندارد"
},
"result": 1
}
},
"Success": {
"value": {
"response_body": {
"data": {
"matched": true
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/postal_code_inquiry": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام کد پستی",
"description": "وب سرویس استعلام کد پستی با دریافت ورودی postal_code، اطلاعات کامل آدرس مرتبط با آن کد پستی را بازمی‌گرداند. در خروجی JSON، فیلدی به نام address شامل استان، شهر، خیابان اصلی و فرعی، شماره ساختمان، طبقه، واحد یا سمت طبقه، منطقه و توضیحات تکمیلی است. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result برابر ۱ نشان‌دهنده موفقیت درخواست است. این سرویس به کسب‌وکارها و سامانه‌های دولتی و خصوصی امکان می‌دهد تا صحت و جزئیات آدرس‌ها را به صورت دقیق و خودکار بررسی کرده و فرآیندهای ثبت‌نام، ارسال مرسوله و خدمات آنلاین را بهینه کنند.",
"operationId": "14",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postal_code": {
"type": "string",
"example": "13xxxxxx53"
}
}
},
"examples": {
"استعلام کد پستی": {
"value": {
"postal_code": "13xxxxxx53"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success / 400 Not Found",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 13:18:39 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=4479"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "12cb5368723421208374d04535e3a280"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"building_name": {
"type": "string",
"example": "-"
},
"description": {
"type": "string",
"example": "-"
},
"district": {
"type": "string",
"example": "انقلاب-فلسطین"
},
"floor": {
"type": "string",
"example": "-1"
},
"number": {
"type": "number",
"example": 1302
},
"province": {
"type": "string",
"example": "تهران"
},
"side_floor": {
"type": "string",
"example": "4"
},
"street": {
"type": "string",
"example": "خیابان 12 فروردین"
},
"street2": {
"type": "string",
"example": "خیابان انقلاب اسلامی"
},
"town": {
"type": "string",
"example": "تهران"
}
}
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"address": {
"building_name": "-",
"description": "-",
"district": "انقلاب-فلسطین",
"floor": "-1",
"number": 1302,
"province": "تهران",
"side_floor": "4",
"street": "خیابان 12 فروردین",
"street2": "خیابان انقلاب اسلامی",
"town": "تهران"
}
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/vehicle_inquiry/total_violations": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام خلافی خودرو",
"description": "وب سرویس استعلام تخلفات خودرو با دریافت ورودی‌هایی شامل شماره موبایل مالک، کد ملی، شماره پلاک و کد منطقه، امکان بررسی مجموع تخلفات ثبت شده برای یک وسیله نقلیه را فراهم می‌کند. خروجی JSON این سرویس شامل اطلاعات پلاک خودرو، شناسه مدارک مالک، تعداد صفحات گزارش تخلفات، شناسه پرداخت، وضعیت پرداخت، مبلغ قابل پرداخت (inquire_price) و هشدار (warning_price) و شماره پیگیری اجرایی (ejr_inquire_no) است. فیلد message وضعیت درخواست و error_code در صورت بروز خطا نمایش داده می‌شود و result عدد ۱ نشان‌دهنده موفقیت عملیات است. این سرویس برای سامانه‌های پرداخت جریمه، اطلاع‌رسانی به مالکین و اتوماسیون مدیریت تخلفات راهنمایی و رانندگی کاربرد دارد و امکان مشاهده سریع وضعیت مالی و تخلفات خودرو را به صورت امن فراهم می‌کند.",
"operationId": "15",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string",
"example": "092XXXXXXXX"
},
"national_code": {
"type": "string",
"example": "002XXXXXX1"
},
"plate_number": {
"type": "string",
"example": "11 ب 111"
},
"region_code": {
"type": "string",
"example": "11"
}
}
},
"examples": {
"استعلام خلافی خودرو": {
"value": {
"mobile": "092XXXXXXXX",
"national_code": "002XXXXXX1",
"plate_number": "11 ب 111",
"region_code": "11"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200 Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 13:18:39 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=4479"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "12cb5368723421208374d04535e3a280"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ejr_inquire_no": {
"type": "string",
"example": "9XXXXXXXX0"
},
"inquire_price": {
"type": "string",
"example": "10000000"
},
"page_count": {
"type": "number",
"example": 0
},
"paper_id": {
"type": "string",
"example": "1XXXXXXXXX196"
},
"payment_id": {
"type": "string",
"example": "6XXXXXXX15"
},
"plate": {
"type": "string",
"example": " شخصي ايران۱۱ ــ ۱۱۱ب۱۱"
},
"price_status": {
"type": "string",
"example": "1"
},
"warning_price": {
"type": "string",
"example": "10000000"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"200 Success": {
"value": {
"response_body": {
"data": {
"ejr_inquire_no": "9XXXXXXXX0",
"inquire_price": "10000000",
"page_count": 0,
"paper_id": "1XXXXXXXXX196",
"payment_id": "6XXXXXXX15",
"plate": " شخصي ايران۱۱ ــ ۱۱۱ب۱۱",
"price_status": "1",
"warning_price": "10000000"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/vehicle_inquiry/violations_details": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام خلافی خودرو با جزئیات",
"description": "وب سرویس جزئیات تخلفات خودرو با دریافت ورودی‌هایی شامل شماره موبایل مالک، کد ملی، شماره پلاک و کد منطقه، تمامی تخلفات ثبت شده برای یک وسیله نقلیه را به صورت دقیق ارائه می‌دهد. در خروجی JSON، فیلدی به نام warnings لیستی از تخلفات شامل شناسه هشدار (warning_id)، شناسه مدرک (paper_id)، شماره سریال، مبلغ نهایی (final_price)، نوع تخلف (violation_type و violation_type_id)، مکان تخلف، تاریخ و زمان وقوع، قابلیت رسیدگی و نوع تحویل اعلان تخلف را نمایش می‌دهد. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result برابر با ۱ موفقیت عملیات را تأیید می‌کند. این سرویس به سامانه‌های مدیریت تخلفات، اطلاع‌رسانی به مالکین و اتوماسیون پرداخت جریمه‌ها امکان می‌دهد تا اطلاعات دقیق و جزئی تخلفات را به صورت امن و قابل پیگیری دریافت کنند.",
"operationId": "16",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string",
"example": "092XXXXXXXX"
},
"national_code": {
"type": "string",
"example": "002XXXXXX1"
},
"plate_number": {
"type": "string",
"example": "11 ب 111"
},
"region_code": {
"type": "string",
"example": "11"
}
}
},
"examples": {
"استعلام خلافی خودرو با جزئیات": {
"value": {
"mobile": "092XXXXXXXX",
"national_code": "002XXXXXX1",
"plate_number": "11 ب 111",
"region_code": "11"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200 Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 13:18:39 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=4479"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "12cb5368723421208374d04535e3a280"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"final_price": {
"type": "string",
"example": "200000"
},
"has_image": {
"type": "boolean",
"example": false
},
"investigation_ability": {
"type": "boolean",
"example": false
},
"paper_id": {
"type": "string",
"example": "56XXXXXXXXX99"
},
"payment_id": {
"type": "string",
"example": "11111111"
},
"serial_no": {
"type": "string",
"example": "0XXXXXXXXXX6"
},
"violation_delivery_type": {
"type": "object",
"properties": {
"violation_delivery_type": {
"type": "string",
"example": "تسليمي"
}
}
},
"violation_occure_date": {
"type": "string",
"example": "1399/01/25 - 13:06"
},
"violation_occure_time": {
"type": "string",
"example": "13:06"
},
"violation_type": {
"type": "object",
"properties": {
"violation_type": {
"type": "string",
"example": "همراه نداشتن گواهي يا برچسب معتبر معاينه فني"
},
"violation_type_id": {
"type": "string",
"example": "2163"
}
}
},
"violatoin_address": {
"type": "string",
"example": "تهران بزرگراه يادگار"
},
"warning_id": {
"type": "string",
"example": "1111111111"
}
}
},
"example": [
{
"final_price": "200000",
"has_image": false,
"investigation_ability": false,
"paper_id": "56XXXXXXXXX99",
"payment_id": "11111111",
"serial_no": "0XXXXXXXXXX6",
"violation_delivery_type": {
"violation_delivery_type": "تسليمي"
},
"violation_occure_date": "1399/01/25 - 13:06",
"violation_occure_time": "13:06",
"violation_type": {
"violation_type": "همراه نداشتن گواهي يا برچسب معتبر معاينه فني",
"violation_type_id": "2163"
},
"violatoin_address": "تهران بزرگراه يادگار",
"warning_id": "1111111111"
},
{
"final_price": "300000",
"has_image": false,
"investigation_ability": false,
"paper_id": "56XXXXXXXXX98",
"payment_id": "11111111",
"serial_no": "0XXXXXXXXXX6",
"violation_delivery_type": {
"violation_delivery_type": "تسليمي"
},
"violation_occure_date": "1399/01/25 - 13:06",
"violation_occure_time": "13:06",
"violation_type": {
"violation_type": "باز گذاشتن درب صندوق عقب وسيله نقليه در حال حركت، ",
"violation_type_id": "2156"
},
"violatoin_address": "تهران بزرگراه يادگار",
"warning_id": "1111111111"
}
]
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"200 Success": {
"value": {
"response_body": {
"data": {
"warnings": [
{
"final_price": "200000",
"has_image": false,
"investigation_ability": false,
"paper_id": "56XXXXXXXXX99",
"payment_id": "11111111",
"serial_no": "0XXXXXXXXXX6",
"violation_delivery_type": {
"violation_delivery_type": "تسليمي"
},
"violation_occure_date": "1399/01/25 - 13:06",
"violation_occure_time": "13:06",
"violation_type": {
"violation_type": "همراه نداشتن گواهي يا برچسب معتبر معاينه فني",
"violation_type_id": "2163"
},
"violatoin_address": "تهران بزرگراه يادگار",
"warning_id": "1111111111"
},
{
"final_price": "300000",
"has_image": false,
"investigation_ability": false,
"paper_id": "56XXXXXXXXX98",
"payment_id": "11111111",
"serial_no": "0XXXXXXXXXX6",
"violation_delivery_type": {
"violation_delivery_type": "تسليمي"
},
"violation_occure_date": "1399/01/25 - 13:06",
"violation_occure_time": "13:06",
"violation_type": {
"violation_type": "باز گذاشتن درب صندوق عقب وسيله نقليه در حال حركت، ",
"violation_type_id": "2156"
},
"violatoin_address": "تهران بزرگراه يادگار",
"warning_id": "1111111111"
}
]
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/enamad_inquiry": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام Enamad",
"description": "وب سرویس استعلام نماد اعتماد الکترونیکی (Enamad) با دریافت ورودی website، اطلاعات مربوط به وضعیت نماد اعتماد یک وب‌سایت را بررسی می‌کند. خروجی JSON شامل شناسه نماد (id)، نام شرکت، دامنه وب‌سایت، وضعیت انقضا (expired)، پیام وضعیت، نام برند (nameper)، حوزه فعالیت (srv_text)، شهر و استان، سطح لوگو (logolevel) و تاریخ صدور و انقضای نماد است. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس به کسب‌وکارها و کاربران کمک می‌کند تا از اعتبار و صحت نماد اعتماد وب‌سایت‌ها مطمئن شوند و تصمیمات آگاهانه برای خرید یا همکاری آنلاین بگیرند.",
"operationId": "enamad",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"website": {
"type": "string",
"example": "zohal.io"
}
}
},
"examples": {
"استعلام Enamad": {
"value": {
"website": "zohal.io"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 12:07:55 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=998"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "be664d836b73f31801077c306a4f0edb"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"approve_date": {
"type": "string",
"example": "1389/12/19"
},
"city_name": {
"type": "string",
"example": "تهران"
},
"domain": {
"type": "string",
"example": "digikala.com"
},
"expired": {
"type": "boolean",
"example": false
},
"expiry_date": {
"type": "string",
"example": "1404/12/03"
},
"id": {
"type": "number",
"example": 19077
},
"logolevel": {
"type": "number",
"example": 4
},
"message": {
"type": "string",
"example": "نماد دارد."
},
"name": {
"type": "string",
"example": "نو آوران فن آوازه "
},
"nameper": {
"type": "string",
"example": "دیجی کالا"
},
"srv_text": {
"type": "string",
"example": "جمع سپاری مالی- هدیه محور,فروشگاه بزرگ چندمنظوره,فروش طلا و جواهر,"
},
"state_name": {
"type": "string",
"example": "تهران"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"approve_date": "1389/12/19",
"city_name": "تهران",
"domain": "digikala.com",
"expired": false,
"expiry_date": "1404/12/03",
"id": 19077,
"logolevel": 4,
"message": "نماد دارد.",
"name": "نو آوران فن آوازه ",
"nameper": "دیجی کالا",
"srv_text": "جمع سپاری مالی- هدیه محور,فروشگاه بزرگ چندمنظوره,فروش طلا و جواهر,",
"state_name": "تهران"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/persian_to_finglish": {
"post": {
"tags": [
"خدماتی"
],
"summary": "تبدیل نام فارسی به فینگلیش",
"description": "وب سرویس تبدیل متن فارسی به فینگلیش با دریافت ورودی persian_text، متن فارسی را به معادل فینگلیش آن تبدیل می‌کند. در خروجی JSON، فیلد finglish_text شامل متن تبدیل‌شده است. فیلدهای message و error_code وضعیت پردازش را نشان می‌دهند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای سامانه‌های پیام‌رسان، ثبت‌نام آنلاین و هر سیستمی که نیاز به نمایش یا ذخیره متن فارسی به صورت فینگلیش دارد، کاربرد دارد و امکان پردازش سریع و دقیق متن‌ها را فراهم می‌کند.",
"operationId": "17",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"persian_text": {
"type": "string",
"example": "حمید"
}
}
},
"examples": {
"تبدیل نام فارسی به فینگلیش": {
"value": {
"persian_text": "حمید"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 12:38:41 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=887"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "2d54245e946942cef83b58da9afcdb3a"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"finglish_text": {
"type": "string",
"example": "mohammad naderi"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"finglish_text": "mohammad naderi"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/national_card_ocr": {
"post": {
"tags": [
"خدماتی"
],
"summary": "OCR کارت ملی",
"description": "وب سرویس OCR کارت ملی با دریافت تصویر کارت ملی (پشت و رو) امکان استخراج اطلاعات هویتی را به صورت خودکار فراهم می‌کند. این سرویس با پردازش تصویر جلوی کارت، داده‌هایی شامل نام، نام خانوادگی، نام پدر، کد ملی، تاریخ تولد، تاریخ انقضاء کارت، عکس صاحب کارت (به صورت Base64)، شهر و استان را شناسایی و در خروجی JSON بازمی‌گرداند. در صورتی که کارت پشت نیز ارسال شود، اطلاعات آن نیز قابل استخراج است. فیلدهای message و error وضعیت پردازش را نشان می‌دهند و result عدد ۱ بیانگر موفقیت عملیات است. این وب سرویس برای اتوماسیون ثبت‌نام، احراز هویت دیجیتال و کاهش خطاهای انسانی در جمع‌آوری اطلاعات کارت ملی کاربرد دارد.",
"operationId": "ocr",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"national_card_back": {
"type": "string",
"format": "binary"
},
"national_card_front": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Front / Back",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "10948"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 14:08:06 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=145"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "aae1b8361957370c40f03cc837fa2451"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"back": {
"type": "object",
"nullable": true,
"example": null
},
"front": {
"type": "object",
"properties": {
"birth_date": {
"type": "string",
"example": "1369/07/11"
},
"city": {
"type": "string",
"example": "قم"
},
"expiration_date": {
"type": "string",
"example": "1353/07/15"
},
"face_photo": {
"type": "string",
"example": "عکس صاحب کارت ملی به فرمت base64"
},
"father_name": {
"type": "string",
"example": "عبداله"
},
"first_name": {
"type": "string",
"example": "عين الله"
},
"last_name": {
"type": "string",
"example": "متقی زاده"
},
"national_code": {
"type": "string",
"example": "0370362063"
},
"province": {
"type": "string",
"example": "قم"
},
"result": {
"type": "boolean",
"example": true
}
},
"nullable": true
}
}
},
"error": {
"nullable": true,
"example": null
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Back": {
"value": {
"response_body": {
"data": {
"back": {
"national_code": "111XXXXX11",
"serial_card": "1a11111111"
},
"front": null
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
},
"Front": {
"value": {
"response_body": {
"data": {
"back": null,
"front": {
"birth_date": "1369/07/11",
"city": "قم",
"expiration_date": "1353/07/15",
"face_photo": "عکس صاحب کارت ملی به فرمت base64",
"father_name": "عبداله",
"first_name": "عين الله",
"last_name": "متقی زاده",
"national_code": "0370362063",
"province": "قم",
"result": true
}
},
"error": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/api/v0/services/inquiry/voice_otp": {
"post": {
"tags": [
"خدماتی"
],
"summary": "OTP صوتی",
"description": "وب‌سرویس تأیید کد پیامکی با دریافت ورودی‌های mobile و code، امکان اعتبارسنجی و تأیید کد ارسال‌شده به شماره تلفن همراه کاربر را فراهم می‌کند. در خروجی JSON، فیلد data شامل پیام تأیید ثبت موفق درخواست است و فیلدهای message و error_code وضعیت پردازش را مشخص می‌کنند. مقدار result با \nعدد ۱ نشان‌دهنده موفقیت عملیات است. این سرویس برای فرآیندهای ورود امن، \nثبت‌نام کاربران، و تأیید شماره موبایل در سامانه‌های احراز هویت و خدمات \nدیجیتال کاربرد دارد و امنیت و اطمینان ارتباط کاربران را تضمین می‌کند.",
"operationId": "otp",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "89129"
},
"mobile": {
"type": "string",
"example": "0922XXXXX42"
}
}
},
"examples": {
"OTP صوتی": {
"value": {
"code": "89129",
"mobile": "0922XXXXX42"
}
}
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/services/inquiry/bill/rightel": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام قبض رایتل",
"description": "استعلام قبض رایتل",
"operationId": "18",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string",
"example": "09201234567"
}
}
},
"examples": {
"استعلام قبض رایتل": {
"value": {
"mobile": "09201234567"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"final_term": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1000
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"payment_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
},
"mid_term": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1000
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"payment_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"final_term": {
"amount": 1000,
"bill_id": "xxxxxxxxxx",
"payment_id": "xxxxxxxxxx"
},
"mid_term": {
"amount": 1000,
"bill_id": "xxxxxxxxxx",
"payment_id": "xxxxxxxxxx"
}
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/bill/mci": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام قبض همراه اول",
"description": "استعلام قبض همراه اول",
"operationId": "19",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string",
"example": "09121234567"
}
}
},
"examples": {
"استعلام قبض همراه اول": {
"value": {
"mobile": "09121234567"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"final_term": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1000
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"payment_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
},
"mid_term": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1000
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"payment_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"final_term": {
"amount": 1000,
"bill_id": "xxxxxxxxxx",
"payment_id": "xxxxxxxxxx"
},
"mid_term": {
"amount": 1000,
"bill_id": "xxxxxxxxxx",
"payment_id": "xxxxxxxxxx"
}
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/bill/irancell": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام قبض ایرانسل",
"description": "استعلام قبض ایرانسل",
"operationId": "20",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string",
"example": "09381234567"
}
}
},
"examples": {
"استعلام قبض ایرانسل": {
"value": {
"mobile": "09381234567"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"final_term": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1000
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"payment_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
},
"mid_term": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1000
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"payment_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"final_term": {
"amount": 1000,
"bill_id": "xxxxxxxxxx",
"payment_id": "xxxxxxxxxx"
},
"mid_term": {
"amount": 1000,
"bill_id": "xxxxxxxxxx",
"payment_id": "xxxxxxxxxx"
}
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/bill/fixed_line": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام قبض تلفن ثابت",
"description": "استعلام قبض تلفن ثابت",
"operationId": "21",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string",
"example": "09381234567"
}
}
},
"examples": {
"استعلام قبض تلفن ثابت": {
"value": {
"mobile": "09381234567"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"final_term": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1000
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"payment_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
},
"mid_term": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1000
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"payment_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"final_term": {
"amount": 1000,
"bill_id": "xxxxxxxxxx",
"payment_id": "xxxxxxxxxx"
},
"mid_term": {
"amount": 1000,
"bill_id": "xxxxxxxxxx",
"payment_id": "xxxxxxxxxx"
}
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/bill/gas": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام قبض گاز",
"description": "استعلام قبض گاز",
"operationId": "22",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
},
"examples": {
"استعلام قبض گاز": {
"value": {
"bill_id": "xxxxxxxxxx"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"address": {
"type": "string",
"example": "تهران"
},
"amount": {
"type": "number",
"example": 100000
},
"bill_id": {
"type": "string",
"example": "123456789"
},
"consumption_type": {
"type": "string",
"example": " خانگي بدون چیلر"
},
"current_reading_date": {
"type": "string",
"example": "1304/09/11"
},
"full_name": {
"type": "string",
"example": "نام مالک"
},
"payment_date": {
"type": "string",
"example": "1304/09/21"
},
"payment_id": {
"type": "string",
"example": "1234567890"
},
"previous_reading_date": {
"type": "string",
"example": "1304/06/12"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"address": "تهران",
"amount": 100000,
"bill_id": "123456789",
"consumption_type": " خانگي بدون چیلر",
"current_reading_date": "1304/09/11",
"full_name": "نام مالک",
"payment_date": "1304/09/21",
"payment_id": "1234567890",
"previous_reading_date": "1304/06/12"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/bill/water": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام قبض آب",
"description": "استعلام قبض آب",
"operationId": "23",
"parameters": [
{
"name": "",
"in": "header",
"schema": {
"type": "string",
"example": ""
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
},
"examples": {
"استعلام قبض آب": {
"value": {
"bill_id": "xxxxxxxxxx"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"account_type": {
"type": "string",
"example": "مسکونی"
},
"address": {
"type": "string",
"example": "آدرس کامل واحد استعلام شده"
},
"amount": {
"type": "number",
"example": 0
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxxxx"
},
"current_date": {
"type": "string",
"example": "14xx/xx/xx"
},
"full_name": {
"type": "string",
"example": "نام مالک"
},
"payment_date": {
"type": "string",
"example": "14xx/xx/xxx"
},
"payment_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"previous_date": {
"type": "string",
"example": "14xx/xx/xx"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"account_type": "مسکونی",
"address": "آدرس کامل واحد استعلام شده",
"amount": 0,
"bill_id": "xxxxxxxxxxxx",
"current_date": "14xx/xx/xx",
"full_name": "نام مالک",
"payment_date": "14xx/xx/xxx",
"payment_id": "xxxxxxxxxx",
"previous_date": "14xx/xx/xx"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/bill/electricity": {
"post": {
"tags": [
"خدماتی"
],
"summary": "استعلام قبض برق",
"description": "استعلام قبض برق",
"operationId": "24",
"parameters": [
{
"name": "",
"in": "header",
"schema": {
"type": "string",
"example": ""
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bill_id": {
"type": "string",
"example": "xxxxxxxxxx"
}
}
},
"examples": {
"استعلام قبض برق": {
"value": {
"bill_id": "xxxxxxxxxx"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"account_type": {
"type": "string",
"example": "خانگی"
},
"address": {
"type": "string",
"example": "آدرس کامل واحد استعلام شده"
},
"amount": {
"type": "number",
"example": 0
},
"bill_id": {
"type": "string",
"example": "xxxxxxxxxxxx"
},
"current_date": {
"type": "string",
"example": "14xx/xx/xx"
},
"full_name": {
"type": "string",
"example": "نام مالک"
},
"payment_date": {
"type": "string",
"example": "14xx/xx/xx"
},
"payment_id": {
"type": "string",
"example": "x"
},
"previous_date": {
"type": "string",
"example": "14xx/xx/xx"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"account_type": "خانگی",
"address": "آدرس کامل واحد استعلام شده",
"amount": 0,
"bill_id": "xxxxxxxxxxxx",
"current_date": "14xx/xx/xx",
"full_name": "نام مالک",
"payment_date": "14xx/xx/xx",
"payment_id": "x",
"previous_date": "14xx/xx/xx"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/company_inquiry/board_members": {
"post": {
"tags": [
"شرکت"
],
"summary": "استعلام اعضای هیئت‌مدیره شرکت",
"description": "وب سرویس استعلام اعضای هیأت مدیره شرکت‌ها با دریافت ورودی national_id (شناسه ملی شرکت)، فهرست اعضای هیأت مدیره و بازرسین شرکت را ارائه می‌دهد. در خروجی JSON، فیلدی به نام board_members شامل نام هر عضو، سمت (position)، تاریخ شروع مسئولیت (start_date) و مدت فعالیت (duration) است. همچنین فیلد company_title نام شرکت را نشان می‌دهد. فیلدهای message و error_code وضعیت پردازش را مشخص می‌کنند و result برابر ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای تحلیل ساختار مدیریتی شرکت‌ها، بررسی اعتبار و تصمیم‌گیری‌های تجاری و حقوقی کاربرد دارد و امکان دسترسی به اطلاعات رسمی اعضای هیأت مدیره را به صورت سریع و امن فراهم می‌کند.",
"operationId": "25",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"national_id": {
"type": "string",
"example": "1400XXXXXX0"
}
}
},
"examples": {
"استعلام اعضای هیئت‌مدیره شرکت": {
"value": {
"national_id": "1400XXXXXX0"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200 Success / No Data Found For Company",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 12:07:55 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=998"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "be664d836b73f31801077c306a4f0edb"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"board_members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"duration": {
"type": "string",
"example": "G:تا پایان سال مالی"
},
"name": {
"type": "string",
"example": "نام بازرس اصلی"
},
"position": {
"type": "string",
"example": "بازرس اصلی"
},
"start_date": {
"type": "string",
"example": "1403/07/07"
}
}
},
"example": [
{
"duration": "G:تا پایان سال مالی",
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1403/07/07"
},
{
"duration": "G:تا پایان سال مالی",
"name": "نام بازرس علی البدل",
"position": "بازرس علی البدل",
"start_date": "1403/07/07"
},
{
"duration": "G:تا تاریخ 07/07/1405",
"name": "نام رییس هیأت مدیره",
"position": "رییس هیأت مدیره",
"start_date": "1403/07/07"
},
{
"duration": "G:تا تاریخ 07/07/1405",
"name": "نایب رییس هیأت مدیره",
"position": "نایب رییس هیأت مدیره",
"start_date": "1403/07/07"
},
{
"duration": "G:تا تاریخ 07/07/1405",
"name": "نام مدیرعامل و عضو هیأت مدیره",
"position": "مدیر عامل و عضو هیأت مدیره",
"start_date": "1403/07/07"
}
]
},
"company_title": {
"type": "string",
"example": "نام شرکت"
}
}
},
"error_code": {
"type": "string",
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"200 Success": {
"value": {
"response_body": {
"data": {
"board_members": [
{
"duration": "G:تا پایان سال مالی",
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1403/07/07"
},
{
"duration": "G:تا پایان سال مالی",
"name": "نام بازرس علی البدل",
"position": "بازرس علی البدل",
"start_date": "1403/07/07"
},
{
"duration": "G:تا تاریخ 07/07/1405",
"name": "نام رییس هیأت مدیره",
"position": "رییس هیأت مدیره",
"start_date": "1403/07/07"
},
{
"duration": "G:تا تاریخ 07/07/1405",
"name": "نایب رییس هیأت مدیره",
"position": "نایب رییس هیأت مدیره",
"start_date": "1403/07/07"
},
{
"duration": "G:تا تاریخ 07/07/1405",
"name": "نام مدیرعامل و عضو هیأت مدیره",
"position": "مدیر عامل و عضو هیأت مدیره",
"start_date": "1403/07/07"
}
],
"company_title": "نام شرکت"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
},
"No Data Found For Company": {
"value": {
"response_body": {
"data": {},
"error_code": "NO_DATA_FOUND_FOR_COMPANY",
"message": "برای این شناسه ملی هیچ روزنامه ای پیدا نشد"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/company_inquiry": {
"post": {
"tags": [
"شرکت"
],
"summary": "استعلام اطلاعات شرکت",
"description": "وب سرویس استعلام اطلاعات شرکت‌ها با دریافت ورودی national_id (شناسه ملی شرکت)، اطلاعات جامع شرکت را از پایگاه داده‌های رسمی بازمی‌گرداند. خروجی JSON شامل نام شرکت، نوع شرکت (مانند سهامی خاص)، تاریخ ایجاد و شماره ثبت، آدرس کامل، کد پستی، شماره تلفن و فکس، ایمیل و تاریخ پایان فعالیت در صورت وجود است. فیلد message وضعیت درخواست و error_code در صورت بروز خطا نمایش داده می‌شود و result عدد ۱ بیانگر موفقیت عملیات است. این سرویس برای بررسی اعتبار شرکت‌ها، اتوماسیون ثبت‌نام، قراردادها و خدمات مالی و تجاری کاربرد دارد و امکان دسترسی سریع به اطلاعات رسمی شرکت‌ها را فراهم می‌کند.",
"operationId": "26",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"national_id": {
"type": "string",
"example": "14XXXXXXX40"
}
}
},
"examples": {
"استعلام اطلاعات شرکت": {
"value": {
"national_id": "14XXXXXXX40"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200 Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sun, 09 Mar 2025 13:16:26 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=30938"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "2b7b650cb28e822ee46f6d78f78d181b"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2067"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"activity_end_date": {
"type": "string",
"example": ""
},
"address": {
"type": "string",
"example": "استان تهران، شهرستان تهران، بخش مرکزی، شهر تهران، انقلاب-فلسطین، خیابان 12 فروردین، خیابان انقلاب اسلامی، پلاک 1500، طبقه 1، واحد 1"
},
"company_type": {
"type": "string",
"example": "شرکت سهامی خاص"
},
"created_at": {
"type": "string",
"example": "1400/01/01-12:00"
},
"email_address": {
"type": "string",
"example": ""
},
"fax_number": {
"type": "string",
"example": ""
},
"issuance_date": {
"type": "string",
"example": "1400/01/01"
},
"name": {
"type": "string",
"example": "راهکار نوین هیوا"
},
"national_id": {
"type": "string",
"example": "1400XXXXXX0"
},
"phone_number": {
"nullable": true,
"example": null
},
"postal_code": {
"type": "string",
"example": "131XXXXXX3"
},
"register_date": {
"type": "string",
"example": "1400/01/01"
},
"register_number": {
"type": "string",
"example": "43XXX0"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"200 Success": {
"value": {
"response_body": {
"data": {
"activity_end_date": "",
"address": "استان تهران، شهرستان تهران، بخش مرکزی، شهر تهران، انقلاب-فلسطین، خیابان 12 فروردین، خیابان انقلاب اسلامی، پلاک 1500، طبقه 1، واحد 1",
"company_type": "شرکت سهامی خاص",
"created_at": "1400/01/01-12:00",
"email_address": "",
"fax_number": "",
"issuance_date": "1400/01/01",
"name": "راهکار نوین هیوا",
"national_id": "1400XXXXXX0",
"phone_number": null,
"postal_code": "131XXXXXX3",
"register_date": "1400/01/01",
"register_number": "43XXX0"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
},
"400": {
"description": "400 Invalid National ID",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Length": {
"schema": {
"type": "string",
"example": "113"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Sat, 23 Aug 2025 10:48:53 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=206"
}
},
"X-Cache": {
"schema": {
"type": "string",
"example": "BYPASS"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "7de084128a4f34c462004fb6f2838245"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "6120"
}
},
"allow": {
"schema": {
"type": "string",
"example": "OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"error_code": {
"type": "string",
"example": "NATIONAL_ID_INVALID"
},
"message": {
"type": "string",
"example": "شناسه ملی اشتباه است."
}
}
},
"result": {
"type": "number",
"example": 6
}
}
},
"examples": {
"400 Invalid National ID": {
"value": {
"response_body": {
"data": {},
"error_code": "NATIONAL_ID_INVALID",
"message": "شناسه ملی اشتباه است."
},
"result": 6
}
}
}
}
}
}
}
}
},
"/services/inquiry/company_inquiry/board_members/history": {
"post": {
"tags": [
"شرکت"
],
"summary": "استعلام تاریخچه اعضای هیئت‌مدیره شرکت",
"description": "وب سرویس تاریخچه اعضای هیأت مدیره شرکت‌ها با دریافت ورودی national_id (شناسه ملی شرکت)، سوابق مدیریتی اعضای هیأت مدیره و بازرسین شرکت را ارائه می‌دهد. در خروجی JSON، فیلد board_members شامل اطلاعات هر عضو مانند سمت (position)، نام (name)، تاریخ شروع (start_date)، مدت فعالیت (duration) و تاریخ پایان مسئولیت (end_date) است. همچنین نام شرکت در فیلد company_title نمایش داده می‌شود. فیلدهای message و error_code وضعیت پردازش را مشخص می‌کنند و result عدد ۱ موفقیت عملیات را تأیید می‌کند. این سرویس برای بررسی تغییرات مدیریتی، تحلیل ساختار تصمیم‌گیری شرکت و مستندسازی سوابق قانونی اعضای هیأت مدیره کاربرد دارد و امکان دسترسی سریع و امن به اطلاعات تاریخی مدیریتی را فراهم می‌کند.",
"operationId": "27",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"national_id": {
"type": "string",
"example": "1400XXXXXX0"
}
}
},
"examples": {
"استعلام تاریخچه اعضای هیئت‌مدیره شرکت": {
"value": {
"national_id": "1400XXXXXX0"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success / 200 No Data Found",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Wed, 19 Jun 2024 12:07:55 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=998"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "be664d836b73f31801077c306a4f0edb"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "2062"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "Accept, origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"board_members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"duration": {
"type": "string",
"example": "2 سال"
},
"end_date": {
"type": "string",
"nullable": true,
"example": "1399/01/01"
},
"name": {
"type": "string",
"example": "نام مدیر عامل"
},
"position": {
"type": "string",
"example": "مدیر عامل"
},
"start_date": {
"type": "string",
"example": "1397/01/01"
}
}
},
"example": [
{
"duration": "2 سال",
"end_date": "1399/01/01",
"name": "نام مدیر عامل",
"position": "مدیر عامل",
"start_date": "1397/01/01"
},
{
"duration": "2 سال",
"end_date": "1399/01/01",
"name": "نام رییس هییت مدیره",
"position": "رییس هییت مدیره",
"start_date": "1397/01/01"
},
{
"duration": "2 سال",
"end_date": "1399/01/01",
"name": "نام نایب رییس هییت مدیره",
"position": "نایب رییس هییت مدیره",
"start_date": "1397/01/01"
},
{
"duration": "1 سال مالی",
"end_date": "1398/01/01",
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1397/01/01"
},
{
"duration": "1 سال مالی",
"end_date": "1398/01/01",
"name": "نام بازرس علی البدل",
"position": "بازرس علی‌البدل",
"start_date": "1397/01/01"
},
{
"duration": "1 سال",
"end_date": "1400/01/01",
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1399/01/01"
},
{
"duration": "1 سال",
"end_date": "1400/01/01",
"name": "نام بازرس علی البدل",
"position": "بازرس علی‌البدل",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1401/01/01",
"name": "نام رییس هییت مدیره",
"position": "رییس هییت مدیره",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1401/01/01",
"name": "نام مدیرعامل",
"position": "مدیر عامل و عضو هییت مدیره",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1401/01/01",
"name": "نام نایب رییس هییت مدیره",
"position": "نایب رییس هییت مدیره",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1401/01/01",
"name": "نام عضو هییت مدیره",
"position": "عضو هییت مدیره",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1402/01/01",
"name": "نام رییس هییت مدیره",
"position": "رییس هییت مدیره",
"start_date": "1400/01/01"
},
{
"duration": "2 سال",
"end_date": "1402/01/01",
"name": "نام نایب رییس هییت مدیره",
"position": "نایب رییس هییت مدیره",
"start_date": "1400/01/01"
},
{
"duration": "2 سال",
"end_date": "1402/01/01",
"name": "نام مدیرعامل",
"position": "مدیر عامل و عضو هییت مدیره",
"start_date": "1400/01/01"
},
{
"duration": "1 سال مالی",
"end_date": null,
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1400/03/30"
},
{
"duration": "1 سال مالی",
"end_date": null,
"name": "نام بازرس علی‌البدل",
"position": "بازرس علی‌البدل",
"start_date": "1400/03/30"
},
{
"duration": "G:تا تاریخ 01/07/1405",
"end_date": null,
"name": "نام رییس هییت مدیره",
"position": "رییس هیأت مدیره",
"start_date": "1403/07/01"
},
{
"duration": "G:تا تاریخ 01/07/1405",
"end_date": null,
"name": "نام نایب رییس هییت مدیره",
"position": "نایب رییس هیأت مدیره",
"start_date": "1403/07/01"
},
{
"duration": "G:تا تاریخ 01/07/1405",
"end_date": null,
"name": "نام مدیرعامل",
"position": "مدیر عامل و عضو هیأت مدیره",
"start_date": "1403/07/01"
},
{
"duration": "G:تا پایان سال مالی",
"end_date": null,
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1403/07/01"
},
{
"duration": "G:تا پایان سال مالی",
"end_date": null,
"name": "نام بازرس علی البدل",
"position": "بازرس علی البدل",
"start_date": "1403/07/01"
}
]
},
"company_title": {
"type": "string",
"example": "نام شرکت"
}
}
},
"error_code": {
"type": "string",
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"200 No Data Found": {
"value": {
"response_body": {
"data": {},
"error_code": "NO_DATA_FOUND_FOR_COMPANY",
"message": "برای این شناسه ملی هیچ روزنامه ای پیدا نشد"
},
"result": 1
}
},
"Success": {
"value": {
"response_body": {
"data": {
"board_members": [
{
"duration": "2 سال",
"end_date": "1399/01/01",
"name": "نام مدیر عامل",
"position": "مدیر عامل",
"start_date": "1397/01/01"
},
{
"duration": "2 سال",
"end_date": "1399/01/01",
"name": "نام رییس هییت مدیره",
"position": "رییس هییت مدیره",
"start_date": "1397/01/01"
},
{
"duration": "2 سال",
"end_date": "1399/01/01",
"name": "نام نایب رییس هییت مدیره",
"position": "نایب رییس هییت مدیره",
"start_date": "1397/01/01"
},
{
"duration": "1 سال مالی",
"end_date": "1398/01/01",
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1397/01/01"
},
{
"duration": "1 سال مالی",
"end_date": "1398/01/01",
"name": "نام بازرس علی البدل",
"position": "بازرس علی‌البدل",
"start_date": "1397/01/01"
},
{
"duration": "1 سال",
"end_date": "1400/01/01",
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1399/01/01"
},
{
"duration": "1 سال",
"end_date": "1400/01/01",
"name": "نام بازرس علی البدل",
"position": "بازرس علی‌البدل",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1401/01/01",
"name": "نام رییس هییت مدیره",
"position": "رییس هییت مدیره",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1401/01/01",
"name": "نام مدیرعامل",
"position": "مدیر عامل و عضو هییت مدیره",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1401/01/01",
"name": "نام نایب رییس هییت مدیره",
"position": "نایب رییس هییت مدیره",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1401/01/01",
"name": "نام عضو هییت مدیره",
"position": "عضو هییت مدیره",
"start_date": "1399/01/01"
},
{
"duration": "2 سال",
"end_date": "1402/01/01",
"name": "نام رییس هییت مدیره",
"position": "رییس هییت مدیره",
"start_date": "1400/01/01"
},
{
"duration": "2 سال",
"end_date": "1402/01/01",
"name": "نام نایب رییس هییت مدیره",
"position": "نایب رییس هییت مدیره",
"start_date": "1400/01/01"
},
{
"duration": "2 سال",
"end_date": "1402/01/01",
"name": "نام مدیرعامل",
"position": "مدیر عامل و عضو هییت مدیره",
"start_date": "1400/01/01"
},
{
"duration": "1 سال مالی",
"end_date": null,
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1400/03/30"
},
{
"duration": "1 سال مالی",
"end_date": null,
"name": "نام بازرس علی‌البدل",
"position": "بازرس علی‌البدل",
"start_date": "1400/03/30"
},
{
"duration": "G:تا تاریخ 01/07/1405",
"end_date": null,
"name": "نام رییس هییت مدیره",
"position": "رییس هیأت مدیره",
"start_date": "1403/07/01"
},
{
"duration": "G:تا تاریخ 01/07/1405",
"end_date": null,
"name": "نام نایب رییس هییت مدیره",
"position": "نایب رییس هیأت مدیره",
"start_date": "1403/07/01"
},
{
"duration": "G:تا تاریخ 01/07/1405",
"end_date": null,
"name": "نام مدیرعامل",
"position": "مدیر عامل و عضو هیأت مدیره",
"start_date": "1403/07/01"
},
{
"duration": "G:تا پایان سال مالی",
"end_date": null,
"name": "نام بازرس اصلی",
"position": "بازرس اصلی",
"start_date": "1403/07/01"
},
{
"duration": "G:تا پایان سال مالی",
"end_date": null,
"name": "نام بازرس علی البدل",
"position": "بازرس علی البدل",
"start_date": "1403/07/01"
}
],
"company_title": "نام شرکت"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
}
},
"/services/inquiry/credit_inquiry/send_otp": {
"post": {
"tags": [
"استعلام اعتبارسنجی"
],
"summary": "ارسال OTP",
"description": "ارسال OTP",
"operationId": "otp1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string",
"example": "09201234567"
},
"national_code": {
"type": "string",
"example": "11111111111"
}
}
},
"examples": {
"ارسال OTP": {
"value": {
"mobile": "09201234567",
"national_code": "11111111111"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200 Success",
"headers": {
"Connection": {
"schema": {
"type": "string",
"example": "keep-alive"
}
},
"Content-Encoding": {
"schema": {
"type": "string",
"example": "br"
}
},
"Date": {
"schema": {
"type": "string",
"example": "Mon, 17 Nov 2025 09:54:23 GMT"
}
},
"Keep-Alive": {
"schema": {
"type": "string",
"example": "timeout=65"
}
},
"Server": {
"schema": {
"type": "string",
"example": "ArvanCloud"
}
},
"Server-Timing": {
"schema": {
"type": "string",
"example": "total;dur=440"
}
},
"Transfer-Encoding": {
"schema": {
"type": "string",
"example": "chunked"
}
},
"Vary": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
}
},
"X-Request-ID": {
"schema": {
"type": "string",
"example": "20cf87b1914d22c5bab8eff057cb3973"
}
},
"X-SID": {
"schema": {
"type": "string",
"example": "5700"
}
},
"X-XSS-Protection": {
"schema": {
"type": "string",
"example": "1; mode=block"
}
},
"allow": {
"schema": {
"type": "string",
"example": "POST, OPTIONS"
}
},
"cross-origin-opener-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"referrer-policy": {
"schema": {
"type": "string",
"example": "same-origin"
}
},
"vary": {
"schema": {
"type": "string",
"example": "origin"
}
},
"x-content-type-options": {
"schema": {
"type": "string",
"example": ": nosniff"
}
},
"x-frame-options": {
"schema": {
"type": "string",
"example": "DENY"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reference_id": {
"type": "string",
"example": "<<ID>>"
},
"status": {
"type": "string",
"example": "pending"
}
}
},
"examples": {
"200 Success": {
"value": {
"reference_id": "<<ID>>",
"status": "pending"
}
}
}
}
}
}
}
}
},
"/services/inquiry/credit_inquiry/verify_otp": {
"post": {
"tags": [
"استعلام اعتبارسنجی"
],
"summary": "اعتبارسنجی OTP",
"description": "اعتبارسنجی OTP",
"operationId": "otp2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"otp": {
"type": "string",
"example": "55555"
},
"reference_id": {
"type": "string",
"example": "<<reference_id>>"
}
}
},
"examples": {
"اعتبارسنجی OTP": {
"value": {
"otp": "55555",
"reference_id": "<<reference_id>>"
}
}
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/services/inquiry/credit_inquiry/result/{reference_id}": {
"get": {
"tags": [
"استعلام اعتبارسنجی"
],
"summary": "دریافت نتیجه",
"description": "دریافت نتیجه",
"operationId": "28",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response_body": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"completed_at": {
"type": "string",
"example": "20xx-xx-xxTxx:xx:xx.166000"
},
"reference_id": {
"type": "string",
"example": "69061561dXXXXXXXX10fb63e"
},
"result": {
"type": "object",
"properties": {
"bounced_cheque": {
"type": "object",
"properties": {
"bounced_cheques": {
"nullable": true,
"example": null
},
"status": {
"type": "number",
"example": 404
}
}
},
"direct_contracts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accounting_date": {
"type": "string",
"example": "140x/xx/xx"
},
"contract_currency": {
"type": "string",
"example": "ریال"
},
"contract_currency_code": {
"type": "string",
"example": "01xxxx3"
},
"contract_id": {
"type": "number",
"example": 0
},
"contract_number": {
"type": "string",
"example": "410-xxxx-xxxxxxxx-1"
},
"contract_start_date_is_transaction_type": {
"type": "boolean",
"example": false
},
"customer_role": {
"type": "number",
"example": 13
},
"customer_role_code": {
"type": "string",
"example": "0xxxx33"
},
"customer_role_title": {
"type": "string",
"example": "متقاضی اصلی"
},
"expected_end_date": {
"type": "string",
"example": "140x/xx/xx"
},
"guarantees": {
"type": "array",
"items": {},
"example": []
},
"installments_currency": {
"type": "string",
"example": "ریال"
},
"installments_currency_code": {
"type": "string",
"example": "0xxxx33"
},
"instalment_amount": {
"type": "number",
"example": 10000
},
"negative_contract_status": {
"type": "string",
"example": "فاقد وضعیت منفی"
},
"negative_contract_status_code": {
"type": "string",
"example": "01xxxx3"
},
"organization_name": {
"type": "string",
"example": "بانک پاسارگاد"
},
"organization_name_code": {
"type": "string",
"example": "01xxxx3"
},
"organization_type": {
"type": "string",
"example": "بانک ها و موسسات اعتباری"
},
"organization_type_code": {
"type": "string",
"example": "01xxxx"
},
"outstanding_amount": {
"type": "number",
"example": 0
},
"overdue_amount": {
"type": "number",
"example": 0
},
"payment_method": {
"type": "string",
"example": "پرداخت مستقیم (نقدی)"
},
"payment_method_code": {
"type": "string",
"example": "01xxxx3"
},
"payment_periodicity": {
"type": "string",
"example": "نامنظم"
},
"payment_periodicity_code": {
"type": "string",
"example": "01xxxx3"
},
"phase_of_operation": {
"type": "number",
"example": 95
},
"phase_of_operation_code": {
"type": "string",
"example": "0xxxxx3"
},
"phase_of_operation_title": {
"type": "string",
"example": "خاتمه یافته به درخواست مشتری"
},
"purpose_of_the_credit": {
"type": "string",
"example": "سایر"
},
"purpose_of_the_credit_code": {
"type": "string",
"example": "01xxxx3"
},
"real_end_date": {
"type": "string",
"example": "14xx/xx/xx"
},
"related_persons": {
"type": "array",
"items": {},
"example": []
},
"repayments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"example": "140x/x"
},
"negative_contract_status": {
"type": "number",
"example": 0
},
"overdue_amount": {
"type": "number",
"nullable": true,
"example": null
},
"total_number_of_overdue": {
"type": "number",
"nullable": true,
"example": null
}
}
},
"example": [
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/xx",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/xx",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/xx",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "14xx/x",
"negative_contract_status": 0,
"overdue_amount": 0,
"total_number_of_overdue": 0
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": 0,
"total_number_of_overdue": 0
}
]
},
"start_date": {
"type": "string",
"example": "14xx/xx/xx"
},
"total_amount": {
"type": "number",
"example": 1000
},
"total_number_of_installments": {
"type": "number",
"example": 6
},
"total_number_of_outstanding": {
"type": "number",
"example": 0
},
"total_number_of_overdue": {
"type": "number",
"example": 0
},
"type_of_financing": {
"type": "number",
"example": 2
},
"type_of_financing_code": {
"type": "string",
"example": "01xxxx"
},
"type_of_financing_title": {
"type": "string",
"example": "سایر"
},
"type_of_installments": {
"type": "string",
"example": "اقساط ثابت"
},
"type_of_installments_code": {
"type": "string",
"example": "01xxxx3"
}
}
},
"example": [
{
"accounting_date": "140x/xx/xx",
"contract_currency": "ریال",
"contract_currency_code": "01xxxx3",
"contract_id": 0,
"contract_number": "410-xxxx-xxxxxxxx-1",
"contract_start_date_is_transaction_type": false,
"customer_role": 13,
"customer_role_code": "0xxxx33",
"customer_role_title": "متقاضی اصلی",
"expected_end_date": "140x/xx/xx",
"guarantees": [],
"installments_currency": "ریال",
"installments_currency_code": "0xxxx33",
"instalment_amount": 10000,
"negative_contract_status": "فاقد وضعیت منفی",
"negative_contract_status_code": "01xxxx3",
"organization_name": "بانک پاسارگاد",
"organization_name_code": "01xxxx3",
"organization_type": "بانک ها و موسسات اعتباری",
"organization_type_code": "01xxxx",
"outstanding_amount": 0,
"overdue_amount": 0,
"payment_method": "پرداخت مستقیم (نقدی)",
"payment_method_code": "01xxxx3",
"payment_periodicity": "نامنظم",
"payment_periodicity_code": "01xxxx3",
"phase_of_operation": 95,
"phase_of_operation_code": "0xxxxx3",
"phase_of_operation_title": "خاتمه یافته به درخواست مشتری",
"purpose_of_the_credit": "سایر",
"purpose_of_the_credit_code": "01xxxx3",
"real_end_date": "14xx/xx/xx",
"related_persons": [],
"repayments": [
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/xx",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/xx",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/xx",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "14xx/x",
"negative_contract_status": 0,
"overdue_amount": 0,
"total_number_of_overdue": 0
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": 0,
"total_number_of_overdue": 0
}
],
"start_date": "14xx/xx/xx",
"total_amount": 1000,
"total_number_of_installments": 6,
"total_number_of_outstanding": 0,
"total_number_of_overdue": 0,
"type_of_financing": 2,
"type_of_financing_code": "01xxxx",
"type_of_financing_title": "سایر",
"type_of_installments": "اقساط ثابت",
"type_of_installments_code": "01xxxx3"
}
]
},
"indirect_contracts": {
"type": "array",
"items": {},
"example": []
},
"inquiry_histories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bank_name": {
"type": "string",
"example": "بانک پاسارگاد"
},
"date": {
"type": "string",
"example": "20xx-xx-xxTxx:xx:xx.257"
}
}
},
"example": [
{
"bank_name": "بانک پاسارگاد",
"date": "20xx-xx-xxTxx:xx:xx.257"
}
]
},
"inquiry_stats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"contract_negative_status_count": {
"type": "number",
"example": 0
},
"last_month_inquiry_count": {
"type": "number",
"example": 0
},
"last_year_inquiry_count": {
"type": "number",
"example": 0
},
"organization_type": {
"type": "string",
"example": "بانک مرکزی"
},
"organization_type_code": {
"type": "string",
"example": "010xxx3"
},
"person_negative_status_count": {
"type": "number",
"example": 0
},
"role_type": {
"type": "number",
"example": 0
}
}
},
"example": [
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "بانک مرکزی",
"organization_type_code": "010xxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 1,
"organization_type": "بانک ها و موسسات اعتباری",
"organization_type_code": "01xxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "تلکام/سازمان هاي خدماتی",
"organization_type_code": "01xxxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "سازمان های خرده فروشی",
"organization_type_code": "01xxxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "سازمان های عمومی/دولتی",
"organization_type_code": "01xxxx33",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "سازمان های قضايی",
"organization_type_code": "01xxxx33",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "مصرف کنندگان",
"organization_type_code": "01xxxx33",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "موسسات اعتباري غير متشکل",
"organization_type_code": "01xxxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "موسسات صادر کننده کارت اعتباری",
"organization_type_code": "01xxxx3",
"person_negative_status_count": 0,
"role_type": 0
}
]
},
"judiciary": {
"type": "object",
"properties": {
"judiciary_data": {
"type": "object",
"properties": {
"accounting_date": {
"type": "string",
"example": "20xx-xx-xxTxx:xx:xxZ"
},
"bankruptcy_count": {
"type": "number",
"example": 0
},
"error_code": {
"type": "string",
"example": ""
},
"error_description": {
"type": "string",
"example": ""
},
"insolvency_count": {
"type": "number",
"example": 0
},
"insolvency_sum_penalty": {
"type": "number",
"example": 0
},
"national_code": {
"type": "string",
"example": "0017xxxxxx7"
},
"sum_execute_count": {
"type": "number",
"example": 0
},
"sum_execute_sum_penalty_amount": {
"type": "number",
"example": 0
},
"sum_not_execute_count": {
"type": "number",
"example": 0
},
"sum_not_execute_sum_penalty_amount": {
"type": "number",
"example": 0
}
}
},
"status": {
"type": "number",
"example": 200
}
}
},
"person_negative_status": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"example": "140x/xx/xx"
},
"organization_name": {
"type": "string",
"example": "بانک پاسارگاد"
},
"organization_name_code": {
"type": "string",
"example": "01xxxx3"
},
"organization_type": {
"type": "string",
"example": "بانک ها و موسسات اعتباری"
},
"organization_type_code": {
"type": "string",
"example": "01xxxx"
},
"state": {
"type": "string",
"example": "فاقد وضعیت منفی"
},
"state_code": {
"type": "string",
"example": "01xxxxx3"
}
}
},
"example": [
{
"date": "140x/xx/xx",
"organization_name": "بانک پاسارگاد",
"organization_name_code": "01xxxx3",
"organization_type": "بانک ها و موسسات اعتباری",
"organization_type_code": "01xxxx",
"state": "فاقد وضعیت منفی",
"state_code": "01xxxxx3"
},
{
"date": "140x/xx/xx",
"organization_name": "بانک مرکزی جمهوری اسلامی ایران",
"organization_name_code": "01xxxx3",
"organization_type": "بانک مرکزی",
"organization_type_code": "01xxxx3",
"state": "فاقد وضعیت منفی",
"state_code": "01xxxxx33"
}
]
},
"person_roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "01xxxx3"
},
"number_of_contracts": {
"type": "number",
"example": 0
},
"title": {
"type": "string",
"example": "متقاضی اصلی"
}
}
},
"example": [
{
"code": "01xxxx3",
"number_of_contracts": 0,
"title": "متقاضی اصلی"
},
{
"code": "01xxxx3",
"number_of_contracts": 0,
"title": "ضامن"
}
]
},
"personal_information": {
"type": "object",
"properties": {
"birth_date": {
"type": "string",
"example": "13xx/x1/x0"
},
"father_name": {
"type": "string",
"example": "محمد"
},
"first_name": {
"type": "string",
"example": "علی"
},
"gender": {
"type": "string",
"example": "مرد"
},
"has_blocked_contract": {
"type": "boolean",
"example": true
},
"last_name": {
"type": "string",
"example": "علیپور"
},
"marital_status": {
"type": "string",
"example": "مجرد"
},
"national_code": {
"type": "string",
"example": "002xxxxxx7"
}
}
},
"pichak": {
"type": "object",
"properties": {
"person_cheques_data": {
"type": "object",
"properties": {
"national_code": {
"type": "string",
"example": "00xxxxxxx17"
},
"person_cheque_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"check_status_id": {
"type": "number",
"example": 55
},
"check_status_title": {
"type": "string",
"example": "نقدشده"
},
"count": {
"type": "number",
"example": 0
},
"total_amount": {
"type": "number",
"example": 0
}
}
},
"example": [
{
"check_status_id": 55,
"check_status_title": "نقدشده",
"count": 0,
"total_amount": 0
},
{
"check_status_id": 66,
"check_status_title": "باطل شده",
"count": 0,
"total_amount": 0
},
{
"check_status_id": 77,
"check_status_title": "برگشتی",
"count": 0,
"total_amount": 0
},
{
"check_status_id": 88,
"check_status_title": "سررسیدآتی",
"count": 0,
"total_amount": 0
},
{
"check_status_id": 99,
"check_status_title": "چک تضمینی",
"count": 0,
"total_amount": 0
}
]
},
"sum_count": {
"type": "number",
"example": 0
},
"sum_total_amount": {
"type": "number",
"example": 0
}
}
},
"status": {
"type": "number",
"example": 200
}
}
},
"score": {
"type": "object",
"properties": {
"description": {
"type": "string",
"example": "ریسک متوسط"
},
"inquiry_created_date": {
"type": "string",
"example": "14xx/x8/x7 13:25:306"
},
"previous_score": {
"type": "boolean",
"example": false
},
"previous_score_date": {
"nullable": true,
"example": null
},
"risk": {
"type": "string",
"example": "C2"
},
"score": {
"type": "number",
"example": 555
},
"score_codes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "NGS1"
},
"description": {
"type": "string",
"example": "تعداد کم ماه‌های با وضعیت مناسب بازپرداختی در حداقل یک وام طی 6 ماه اخیر"
}
}
},
"example": [
{
"code": "NGS1",
"description": "تعداد کم ماه‌های با وضعیت مناسب بازپرداختی در حداقل یک وام طی 6 ماه اخیر"
},
{
"code": "NGL1",
"description": "تعداد کم ماه‌های با وضعیت مناسب بازپرداختی در حداقل یک وام طی 3 سال اخیر"
},
{
"code": "MTA1",
"description": "عدم وجود وام‌های با مبالغ بالا طی 2 سال اخیر"
},
{
"code": "AGE1",
"description": "رده سنی بسیار جوان "
},
{
"code": "MTX1",
"description": "مبلغ پایین حداقل مالیات سالانه‌ی پرداخت شده‌ی حقوق و دستمزد طی 4 سال اخیر"
}
]
},
"score_type": {
"type": "string",
"example": "در محاسبه امتیاز اعتباری (که بر اساس مدل جدید می‌باشد) از اطلاعات سوابق تسهیلاتی، چک‌های برگشتی، مالیاتی و محکومیت‌های مالی شخص استفاده می‌شود"
}
}
},
"summary_related_contracts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"example": "ریال"
},
"currency_code": {
"type": "string",
"example": "01xxxx3"
},
"in_progress_contracts_count": {
"type": "number",
"example": 0
},
"organization_id": {
"type": "number",
"example": 18
},
"organization_name": {
"type": "string",
"example": "بانک پاسارگاد"
},
"organization_name_code": {
"type": "string",
"example": "02xxxx1"
},
"outstanding_amount": {
"type": "number",
"example": 0
},
"overdue_amount": {
"type": "number",
"example": 0
},
"role_type": {
"type": "number",
"example": 0
},
"terminated_contracts_count": {
"type": "number",
"example": 1
},
"total_amount": {
"type": "number",
"example": 10000
},
"type_of_financing": {
"type": "string",
"example": "تسهیلات"
},
"type_of_financing_code": {
"type": "string",
"example": "01xxxx"
}
}
},
"example": [
{
"currency": "ریال",
"currency_code": "01xxxx3",
"in_progress_contracts_count": 0,
"organization_id": 18,
"organization_name": "بانک پاسارگاد",
"organization_name_code": "02xxxx1",
"outstanding_amount": 0,
"overdue_amount": 0,
"role_type": 0,
"terminated_contracts_count": 1,
"total_amount": 10000,
"type_of_financing": "تسهیلات",
"type_of_financing_code": "01xxxx"
}
]
},
"tax": {
"type": "object",
"properties": {
"status": {
"type": "number",
"example": 200
},
"tax_result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accounting_date": {
"nullable": true,
"example": null
},
"bedehi_jarimeh_amalkard": {
"nullable": true,
"example": null
},
"bedehi_maliat_amalkard": {
"nullable": true,
"example": null
},
"dar_moed": {
"nullable": true,
"example": null
},
"daramad_ebrazi": {
"nullable": true,
"example": null
},
"etelate_vosol_o_ejra": {
"type": "boolean",
"example": false
},
"is_maliat_pardakhti_type_and_date": {
"nullable": true,
"example": null
},
"is_maliatghati_type_and_date": {
"nullable": true,
"example": null
},
"jarayem": {
"nullable": true,
"example": null
},
"maliat_ebrazi": {
"nullable": true,
"example": null
},
"maliat_ghati": {
"nullable": true,
"example": null
},
"maliat_tashkhisi": {
"nullable": true,
"example": null
},
"maliat_vosoli": {
"nullable": true,
"example": null
},
"maliate_hoghoghi_pardakhti_karfarma": {
"nullable": true,
"example": null
},
"maliate_hoghoghi_pardakhti_karmand": {
"nullable": true,
"example": null
},
"national_code": {
"nullable": true,
"example": null
},
"year": {
"type": "number",
"example": 1404
}
}
},
"example": [
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1404
},
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1403
},
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1402
},
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1401
},
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1400
}
]
}
}
}
}
},
"service": {
"type": "string",
"example": "استعلام اعتبارسنجی"
},
"status": {
"type": "string",
"example": "completed"
}
}
},
"error_code": {
"nullable": true,
"example": null
},
"message": {
"type": "string",
"example": "موفق"
}
}
},
"result": {
"type": "number",
"example": 1
}
}
},
"examples": {
"Success": {
"value": {
"response_body": {
"data": {
"completed_at": "20xx-xx-xxTxx:xx:xx.166000",
"reference_id": "69061561dXXXXXXXX10fb63e",
"result": {
"bounced_cheque": {
"bounced_cheques": null,
"status": 404
},
"direct_contracts": [
{
"accounting_date": "140x/xx/xx",
"contract_currency": "ریال",
"contract_currency_code": "01xxxx3",
"contract_id": 0,
"contract_number": "410-xxxx-xxxxxxxx-1",
"contract_start_date_is_transaction_type": false,
"customer_role": 13,
"customer_role_code": "0xxxx33",
"customer_role_title": "متقاضی اصلی",
"expected_end_date": "140x/xx/xx",
"guarantees": [],
"installments_currency": "ریال",
"installments_currency_code": "0xxxx33",
"instalment_amount": 10000,
"negative_contract_status": "فاقد وضعیت منفی",
"negative_contract_status_code": "01xxxx3",
"organization_name": "بانک پاسارگاد",
"organization_name_code": "01xxxx3",
"organization_type": "بانک ها و موسسات اعتباری",
"organization_type_code": "01xxxx",
"outstanding_amount": 0,
"overdue_amount": 0,
"payment_method": "پرداخت مستقیم (نقدی)",
"payment_method_code": "01xxxx3",
"payment_periodicity": "نامنظم",
"payment_periodicity_code": "01xxxx3",
"phase_of_operation": 95,
"phase_of_operation_code": "0xxxxx3",
"phase_of_operation_title": "خاتمه یافته به درخواست مشتری",
"purpose_of_the_credit": "سایر",
"purpose_of_the_credit_code": "01xxxx3",
"real_end_date": "14xx/xx/xx",
"related_persons": [],
"repayments": [
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/xx",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/xx",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "140x/xx",
"negative_contract_status": 0,
"overdue_amount": null,
"total_number_of_overdue": null
},
{
"date": "14xx/x",
"negative_contract_status": 0,
"overdue_amount": 0,
"total_number_of_overdue": 0
},
{
"date": "140x/x",
"negative_contract_status": 0,
"overdue_amount": 0,
"total_number_of_overdue": 0
}
],
"start_date": "14xx/xx/xx",
"total_amount": 1000,
"total_number_of_installments": 6,
"total_number_of_outstanding": 0,
"total_number_of_overdue": 0,
"type_of_financing": 2,
"type_of_financing_code": "01xxxx",
"type_of_financing_title": "سایر",
"type_of_installments": "اقساط ثابت",
"type_of_installments_code": "01xxxx3"
}
],
"indirect_contracts": [],
"inquiry_histories": [
{
"bank_name": "بانک پاسارگاد",
"date": "20xx-xx-xxTxx:xx:xx.257"
}
],
"inquiry_stats": [
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "بانک مرکزی",
"organization_type_code": "010xxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 1,
"organization_type": "بانک ها و موسسات اعتباری",
"organization_type_code": "01xxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "تلکام/سازمان هاي خدماتی",
"organization_type_code": "01xxxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "سازمان های خرده فروشی",
"organization_type_code": "01xxxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "سازمان های عمومی/دولتی",
"organization_type_code": "01xxxx33",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "سازمان های قضايی",
"organization_type_code": "01xxxx33",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "مصرف کنندگان",
"organization_type_code": "01xxxx33",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "موسسات اعتباري غير متشکل",
"organization_type_code": "01xxxx3",
"person_negative_status_count": 0,
"role_type": 0
},
{
"contract_negative_status_count": 0,
"last_month_inquiry_count": 0,
"last_year_inquiry_count": 0,
"organization_type": "موسسات صادر کننده کارت اعتباری",
"organization_type_code": "01xxxx3",
"person_negative_status_count": 0,
"role_type": 0
}
],
"judiciary": {
"judiciary_data": {
"accounting_date": "20xx-xx-xxTxx:xx:xxZ",
"bankruptcy_count": 0,
"error_code": "",
"error_description": "",
"insolvency_count": 0,
"insolvency_sum_penalty": 0,
"national_code": "0017xxxxxx7",
"sum_execute_count": 0,
"sum_execute_sum_penalty_amount": 0,
"sum_not_execute_count": 0,
"sum_not_execute_sum_penalty_amount": 0
},
"status": 200
},
"person_negative_status": [
{
"date": "140x/xx/xx",
"organization_name": "بانک پاسارگاد",
"organization_name_code": "01xxxx3",
"organization_type": "بانک ها و موسسات اعتباری",
"organization_type_code": "01xxxx",
"state": "فاقد وضعیت منفی",
"state_code": "01xxxxx3"
},
{
"date": "140x/xx/xx",
"organization_name": "بانک مرکزی جمهوری اسلامی ایران",
"organization_name_code": "01xxxx3",
"organization_type": "بانک مرکزی",
"organization_type_code": "01xxxx3",
"state": "فاقد وضعیت منفی",
"state_code": "01xxxxx33"
}
],
"person_roles": [
{
"code": "01xxxx3",
"number_of_contracts": 0,
"title": "متقاضی اصلی"
},
{
"code": "01xxxx3",
"number_of_contracts": 0,
"title": "ضامن"
}
],
"personal_information": {
"birth_date": "13xx/x1/x0",
"father_name": "محمد",
"first_name": "علی",
"gender": "مرد",
"has_blocked_contract": true,
"last_name": "علیپور",
"marital_status": "مجرد",
"national_code": "002xxxxxx7"
},
"pichak": {
"person_cheques_data": {
"national_code": "00xxxxxxx17",
"person_cheque_items": [
{
"check_status_id": 55,
"check_status_title": "نقدشده",
"count": 0,
"total_amount": 0
},
{
"check_status_id": 66,
"check_status_title": "باطل شده",
"count": 0,
"total_amount": 0
},
{
"check_status_id": 77,
"check_status_title": "برگشتی",
"count": 0,
"total_amount": 0
},
{
"check_status_id": 88,
"check_status_title": "سررسیدآتی",
"count": 0,
"total_amount": 0
},
{
"check_status_id": 99,
"check_status_title": "چک تضمینی",
"count": 0,
"total_amount": 0
}
],
"sum_count": 0,
"sum_total_amount": 0
},
"status": 200
},
"score": {
"description": "ریسک متوسط",
"inquiry_created_date": "14xx/x8/x7 13:25:306",
"previous_score": false,
"previous_score_date": null,
"risk": "C2",
"score": 555,
"score_codes": [
{
"code": "NGS1",
"description": "تعداد کم ماه‌های با وضعیت مناسب بازپرداختی در حداقل یک وام طی 6 ماه اخیر"
},
{
"code": "NGL1",
"description": "تعداد کم ماه‌های با وضعیت مناسب بازپرداختی در حداقل یک وام طی 3 سال اخیر"
},
{
"code": "MTA1",
"description": "عدم وجود وام‌های با مبالغ بالا طی 2 سال اخیر"
},
{
"code": "AGE1",
"description": "رده سنی بسیار جوان "
},
{
"code": "MTX1",
"description": "مبلغ پایین حداقل مالیات سالانه‌ی پرداخت شده‌ی حقوق و دستمزد طی 4 سال اخیر"
}
],
"score_type": "در محاسبه امتیاز اعتباری (که بر اساس مدل جدید می‌باشد) از اطلاعات سوابق تسهیلاتی، چک‌های برگشتی، مالیاتی و محکومیت‌های مالی شخص استفاده می‌شود"
},
"summary_related_contracts": [
{
"currency": "ریال",
"currency_code": "01xxxx3",
"in_progress_contracts_count": 0,
"organization_id": 18,
"organization_name": "بانک پاسارگاد",
"organization_name_code": "02xxxx1",
"outstanding_amount": 0,
"overdue_amount": 0,
"role_type": 0,
"terminated_contracts_count": 1,
"total_amount": 10000,
"type_of_financing": "تسهیلات",
"type_of_financing_code": "01xxxx"
}
],
"tax": {
"status": 200,
"tax_result": [
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1404
},
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1403
},
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1402
},
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1401
},
{
"accounting_date": null,
"bedehi_jarimeh_amalkard": null,
"bedehi_maliat_amalkard": null,
"dar_moed": null,
"daramad_ebrazi": null,
"etelate_vosol_o_ejra": false,
"is_maliat_pardakhti_type_and_date": null,
"is_maliatghati_type_and_date": null,
"jarayem": null,
"maliat_ebrazi": null,
"maliat_ghati": null,
"maliat_tashkhisi": null,
"maliat_vosoli": null,
"maliate_hoghoghi_pardakhti_karfarma": null,
"maliate_hoghoghi_pardakhti_karmand": null,
"national_code": null,
"year": 1400
}
]
}
},
"service": "استعلام اعتبارسنجی",
"status": "completed"
},
"error_code": null,
"message": "موفق"
},
"result": 1
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "reference_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "69061561d33ef5d7810fb63e"
}
}
]
}
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer"
}
}
},
"security": [
{
"bearerAuth": []
}
],
"tags": [
{
"name": "بانکی"
},
{
"name": "احراز هویت ویدیویی"
},
{
"name": "احراز هویت"
},
{
"name": "خدماتی"
},
{
"name": "شرکت"
},
{
"name": "استعلام اعتبارسنجی"
}
]
}
Reference in a new issue View git blame Copy permalink