{ "openapi": "3.1.0", "info": { "title": "مستندات API فینوتک | بانکداری باز و سرویس‌های استعلام", "description": "
\n\n

مشاهده سرویس‌ها و کاربردها

\n\n
\n", "contact": { "name": "Finnotech Support", "url": "https://console.finnotech.ir" } }, "servers": [ { "url": "https://api.finnotech.ir", "description": "Production" }, { "url": "https://sandboxapi.finnotech.ir", "description": "Sandbox" } ], "tags": [ { "name": "توکن", "description": "صدور و تمدید توکن OAuth2 فینوتک — Client Credential، Authorization Code پیامکی، و refresh token.\n" }, { "name": "سرویس های احراز هویت", "description": "سرویس‌های احراز هویت و استعلام هویتی — ثبت احوال، استعلام کد ملی (Client Credential و Authorization SMS)، تطبیق شبا، OCR کارت ملی، انطباق ویدئو با عکس کارت ملی، ثنا، نظام وظیفه و موارد مشابه.\n\n**Grant type:** client_credentials (برخی سرویس‌ها authorization_sms)\n" }, { "name": "سرویس های ارسال پیام کوتاه", "description": "سرویس‌های ارسال و دریافت پیامک — فینوتکست، OTP یکپارچه (Initiate/Verify)، استعلام وضعیت، دریافت پیامک و وب‌هوک‌ها.\n\n**Grant type:** client_credentials\n" }, { "name": "سرویس های پستی و کدپستی", "description": "سرویس‌های استعلام کد پستی، مختصات جغرافیایی و رهگیری مرسولات پستی.\n\n**Grant type:** client_credentials\n" }, { "name": "سرویس های قبض", "description": "سرویس‌های استعلام قبض — همگام و ناهمگام.\n\n**استعلام همگام (Client Credential):** یک فراخوانی، نتیجه فوری — استعلام قبض، استعلام با جزئیات، تاریخچه قبض، نمره منفی گواهینامه.\n\n**استعلام ناهمگام:** دو مرحله — (۱) ثبت درخواست → (۲) دریافت نتیجه با `requestId`.\n" }, { "name": "سرویس های استعلامی و تبدیلی", "description": "سرویس‌های استعلام و تبدیل داده — استعلام کارت، تبدیل کارت/حساب به شبا، استعلام اطلاعات شبا، تطبیق شاهکار، تصویر کارت ملی و موارد مشابه.\n\n**Grant type:** client_credentials (برخی سرویس‌ها authorization_sms)\n" }, { "name": "سرویس های شناخت کسب و کار", "description": "KYB (Know Your Business) — استعلام اطلاعات شرکت، اعضای هیئت مدیره، روزنامه رسمی، اینماد، صاحبان امضا و اعتبارسنجی کسب‌وکار.\n\n**احراز امضاء روزنامه رسمی (ناهمگام):** دو مرحله — (۱) ثبت درخواست → (۲) دریافت نتیجه با `requestId`.\n\n**Grant type:** client_credentials\n" }, { "name": "سرویس های خودرویی", "description": "سرویس‌های استعلام خودرو — پلاک فعال، مالکیت، تاریخچه پلاک، طرح ترافیک، عوارض آزادراهی، اطلاعات خودرو، خلافی، تصویر تخلفات، بیمه شخص ثالث، گواهینامه، نمره منفی و ریسک رانندگان.\n\n**Grant type:** client_credentials" }, { "name": "سرویس های چک صیادی", "description": "سرویس‌های چک صیادی — ثبت، انتقال، لغو، تایید، استعلام وضعیت و زنجیره انتقالات.\n\nرویکردها: Client Credential، Authorization Code، Authorization SMS" }, { "name": "استعلام تسهیلات و اعتبارسنجی", "description": "سرویس‌های استعلام تسهیلات، ضمانت‌نامه و اعتبارسنجی.\n\n**گزارش اعتباری (۲ مرحله):** (۱) ثبت درخواست → (۲) دریافت نتیجه با `assessmentId`.\n\n**استعلام اعتبار معاملاتی (۳ مرحله):** (۱) درخواست و دریافت OTP → (۲) صحت‌سنجی OTP → (۳) دریافت گزارش.\n\nرویکردها: Client Credential، Authorization Code، Authorization SMS" }, { "name": "سرویس های بر پایه حساب", "description": "سرویس‌های بر پایه حساب — گردش حساب با رویکرد Client Credential و انتقال وجه داخلی، پایا و ساتنا از حساب مبدأ تأییدشده.\n\nرویکردها: Client Credential، Authorization Code، Authorization SMS" } ], "paths": { "/billing/v2/clients/{clientId}/billingInquiryRequest": { "post": { "operationId": "billingInquiryRequestSubmit", "summary": "استعلام قبض ناهمگام (مرحله ۱) — ثبت درخواست", "description": "\nسرویس «استعلام قبض ناهمگام (مرحله ۱) — ثبت درخواست» در دسته استعلام قبض فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nدر این مرحله اطلاعات قبض وارد می‌شود و شناسه درخواست (`requestId`) به عنوان پاسخ برگردانده می‌شود.\nاز این شناسه در مرحله [دریافت نتیجه](#/operations/billingInquiryStatusPoll) استفاده می‌شود.\n\n**Scope:** `billing:billing-inquiry-request:post`
\n\n**Grant type:** client_credentials\n\n### مراحل فراخوانی\n\n1. ثبت درخواست استعلام قبض (این سرویس)\n2. [مشاهده نتیجه استعلام (مرحله ۲)](#/operations/billingInquiryStatusPoll)\n\nپوشش آب، برق و گاز سراسری است.\n", "tags": [ "سرویس های قبض" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncBillingInquirySubmitRequest" }, "examples": { "mobile": { "summary": "Mobile bill (MCI)", "value": { "type": "Mobile", "parameter": "09222223344", "secondParameter": "MCI" } }, "landline": { "summary": "Landline bill", "value": { "type": "Tel", "parameter": "02177689361" } } } } } }, "responses": { "200": { "description": "درخواست استعلام ثبت شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncBillingInquirySubmitResponse" }, "example": { "responseCode": "FN-BGFH-20099900000", "trackId": "2543148e-c4d7-4eee-8e99-aqqqqqqqqqq", "result": { "requestId": "e3e9fa28-ed42-42b1-b15a-cqqqqqqqqqqq", "status": "PENDING" }, "status": "DONE" } } } }, "400": { "description": "Invalid request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/billing/v2/clients/{clientId}/billingInquiryStatus": { "post": { "operationId": "billingInquiryStatusPoll", "summary": "استعلام قبض ناهمگام (مرحله ۲) — دریافت نتیجه", "description": "\nسرویس «استعلام قبض ناهمگام (مرحله ۲) — دریافت نتیجه» در دسته استعلام قبض فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا ورود شناسه درخواست (`requestId`) از مرحله [ثبت درخواست](#/operations/billingInquiryRequestSubmit)، نتیجه استعلام قبض برگردانده می‌شود.\n\n**Scope:** `billing:billing-inquiry-status:post`
\n\n**Grant type:** client_credentials\n\n### مراحل فراخوانی\n\n1. [ثبت درخواست استعلام قبض (مرحله ۱)](#/operations/billingInquiryRequestSubmit)\n2. دریافت نتیجه استعلام (این سرویس)\n\n### وضعیت‌های `result.status`\n\n| status | Meaning |\n| --- | --- |\n| `PENDING` | درخواست در صف پردازش است |\n| `SUCCESS` | استعلام با موفقیت انجام شد — فیلد `data` را بررسی کنید |\n| `FAILED` | استعلام ناموفق — فیلد `error` را بررسی کنید |\n", "tags": [ "سرویس های قبض" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncBillingInquiryStatusRequest" }, "example": { "requestId": "e3e9fa28-ed42-42b1-b15a-c55bb0961b92" } } } }, "responses": { "200": { "description": "وضعیت استعلام (ممکن است هنوز در حال پردازش باشد)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncBillingInquiryStatusResponse" }, "examples": { "success": { "summary": "Inquiry completed successfully", "value": { "responseCode": "FN-BGFH-20099900000", "trackId": "1e3bb70f-f558-4ef8-8368-68d3ca8bcdb9", "result": { "requestId": "4002776d-6c50-42ad-b76d-1374d84843c4", "status": "SUCCESS", "data": { "amount": "3613000", "billId": "9480837904123", "payId": "361350182", "date": "1405/03/05" } }, "status": "DONE" } }, "pending": { "summary": "Still processing", "value": { "responseCode": "FN-BGFH-20099900000", "trackId": "2543148e-c4d7-4eee-8e99-aqqqqqqqqqq", "result": { "requestId": "e3e9fa28-ed42-42b1-b15a-c55bb0961b92", "status": "PENDING" }, "status": "DONE" } }, "failed": { "summary": "Inquiry failed (business outcome)", "value": { "responseCode": "FN-BGFH-20099900000", "trackId": "d0f61173-1d9d-4aac-a4a4-3238eb3d9e06", "result": { "requestId": "e3e9fa28-ed42-42b1-b15a-c55bb0961b92", "status": "FAILED", "error": { "message": "مقدار ورودی نامعتبر است", "code": "40317" } }, "status": "DONE" } } } } } }, "400": { "description": "Invalid request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/billing/v2/clients/{clientId}/billingInquiry": { "get": { "operationId": "billingInquiryCcGet", "summary": "استعلام قبض", "description": "\nسرویس «استعلام قبض» در دسته استعلام قبض فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nسرویس استعلام قبض با گرفتن نوع قبض و شناسه مربوط به آن، اطلاعات قبض را در اختیار کاربر قرار می‌دهد.\n\n**Scope:** `billing:cc-inquiry:get`
\n\n**Grant type:** client_credentials\n\n### انواع قبض (`type`)\n\n| type | نوع قبض |\n| --- | --- |\n| `Water` | آب |\n| `Electricity` | برق |\n| `Electricity-standard` | برق (پشتیبان) |\n| `Gas` | گاز |\n| `GasByBillId` | گاز با شماره قبض |\n| `Tel` | تلفن ثابت، پایان دوره |\n| `TelNow` | تلفن ثابت، بروز |\n| `Mobile` | تلفن همراه، پایان دوره |\n| `MobileNow` | تلفن همراه، بروز |\n\n### مقدار `parameter`\n\n- آب، برق: شناسه قبض\n- گاز: شماره اشتراک\n- گاز با شماره قبض: شماره قبض\n- تلفن ثابت: شماره تلفن به همراه کد\n- تلفن همراه: شماره تلفن همراه\n\nبرای قبوض اپراتورهای ایرانسل و رایتل، `secondParameter` اجباری است.\n\nپوشش آب، برق و گاز سراسری است.", "tags": [ "سرویس های قبض" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/billType" }, { "$ref": "#/components/parameters/parameter" }, { "$ref": "#/components/parameters/secondParameter" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingInquiryResponse" }, "example": { "trackId": "46d3470b-eb14-4a17-8e77-6052031527d6", "result": { "Amount": 50000, "BillId": 931564121146, "PayId": 5080129, "Date": "" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/billing/v2/clients/{clientId}/detailBillingInquiry": { "get": { "operationId": "billingDetailInquiryCcGet", "summary": "استعلام قبوض با جزئیات", "description": "\nسرویس «استعلام قبوض با جزئیات» در دسته استعلام قبض فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nسرویس استعلام قبض با جزئیات؛ با گرفتن نوع قبض و شناسه مربوط به آن، اطلاعات قبض به همراه جزئیات را در اختیار کاربر قرار می‌دهد.\n\n**Scope:** `billing:cc-inquiry-detail:get`
\n\n**Grant type:** client_credentials\n\n### انواع قبض (`type`)\n\n| type | نوع قبض |\n| --- | --- |\n| `Water` | آب |\n| `Electricity` | برق |\n| `Electricity-support` | برق (پشتیبان) |\n| `Gas` | گاز |\n\n### مقدار `parameter`\n\n- آب، برق: شناسه قبض\n- گاز: شماره اشتراک\n\nپوشش آب، برق و گاز سراسری است.", "tags": [ "سرویس های قبض" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/billTypeDetail" }, { "$ref": "#/components/parameters/parameter" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingDetailInquiryResponse" }, "example": { "trackId": "561e5d7a-af5a-4e99-8a32-ce0d9be94019", "result": { "Amount": "590000", "BillId": "9030635704127", "PayId": "59010572", "Date": "1401/07/03", "Info": { "CompanyName": "توزيع نيروی برق تهران بزرگ", "CustomerName": "سيدمحمدرضا گلزار", "CustomerFamily": "", "CustomerType": "حقیقی", "Address": "خواجه عبداله انصاري ابوذرغفاري شمالي", "PostalCode": "1236598127", "FileNumber": "656379", "ComputerPassword": "23569741", "IdentificationNumber": "30226984", "TariffType": "خانگی", "Phase": "1", "Amper": "15", "VoltageType": "ثانویه", "ContractDemand": "3", "ConsumptionDebtAmount": "0", "OtherDebtAmount": "0", "BranchDebtAmount": "0" } }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/billing/v2/clients/{clientId}/billHistoryInquiry": { "get": { "operationId": "billingBillHistoryInquiryGet", "summary": "استعلام تاریخچه قبض", "description": "\nسرویس «استعلام تاریخچه قبض» در دسته استعلام قبض فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا تعیین نوع قبض (`Electricity` یا `Gas`) و شناسه قبض/اشتراک (`parameter`)، تاریخچه قبض برگردانده می‌شود.\n\n**Scope:** `billing:bill-history-inquiry:get`
\n\n**Grant type:** client_credentials\n\n### انواع قبض (`type`)\n\n| type | نوع قبض |\n| --- | --- |\n| `Electricity` | برق |\n| `Gas` | گاز |\n\n### مقدار `parameter`\n\n- برق: شناسه قبض\n- گاز: شماره اشتراک", "tags": [ "سرویس های قبض" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/billTypeHistory" }, { "$ref": "#/components/parameters/parameter" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingBillHistoryInquiryResponse" }, "example": { "responseCode": "FN-BGVH-20001500000", "trackId": "df5bdf96-dc4-088e36f105c8", "result": { "bills": [ { "billId": "3375845754", "payId": "0000000002696", "amount": "0", "date": "1403/07/25", "info": { "companyName": "شرکت توزیع", "customerName": "علی" } } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/identificationInquiry": { "get": { "operationId": "kycIdentificationInquiry", "summary": "استعلام اطلاعات هویتی", "description": "\nسرویس استعلام اطلاعات هویتی فینوتک یک API برای احراز هویت و فرآیندهای KYC است که به کسب‌وکارها امکان می‌دهد اطلاعات هویتی فرد را از طریق API دریافت و بررسی کنند.\n\n\n\nاین سرویس با دریافت کد ملی و تاریخ تولد، اطلاعات ثبت احوال را در خروجی نمایش می‌دهد.\n\n**Scope:** `kyc:identification-inquiry:get`
\n\n**Grant type:** client_credentials", "x-seo-title": "استعلام اطلاعات هویتی | API احراز هویت و شناخت مشتری", "x-seo-description": "سرویس استعلام اطلاعات هویتی فینوتک با کد ملی و تاریخ تولد، مشخصات ثبت احوال را برای KYC و احراز هویت برمی‌گرداند. بدون رضایت پیامکی، با Client Credential.", "x-seo-use-cases": "این سرویس برای کسب‌وکارهایی طراحی شده است که در فرآیند KYC نیاز دارند اطلاعات هویتی مشتری را از طریق API دریافت و بررسی کنند. از این سرویس می‌توان در فرآیندهایی مانند ثبت‌نام کاربران، احراز هویت مشتریان و اعتبارسنجی اطلاعات هویتی استفاده کرد.", "x-related-operations": [ "facility_nid_inquiry_cc_get", "facility_national_card_image_get", "facility_shahkar_verify_get", "kyc_death_status_inquiry_get", "kyc_ocr_verification_post" ], "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalCode" }, { "$ref": "#/components/parameters/birthDate" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycIdentificationInquiryResponse" }, "example": { "responseCode": "FN-KCST-20003000000", "trackId": "identification_inquiry_trackId", "result": { "firstName": "محمد", "lastName": "اکبری", "birthDate": "13730125", "fatherName": "اميد", "deathStatus": "زنده ", "nationalId": "0123456789", "gender": "مرد", "identityNo": 0, "identitySeri": "د77", "identitySerial": "123456", "officeName": "تهران - تهران", "officeCode": "333", "trackingCode": null, "operationStatus": null }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/ibanOwnerVerification": { "get": { "operationId": "kycIbanOwnerVerificationGet", "summary": "تطبیق شماره شبا و کد ملی", "description": "\nسرویس «تطبیق شماره شبا و کد ملی» (IBAN / National ID / KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با وارد کردن شماره شبا و کد ملی، تطبیق یا عدم تطبیق اطلاعات را در خروجی نمایش می‌دهد.\n\n**Scope:** `kyc:iban-owner-verification:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nid" }, { "$ref": "#/components/parameters/iban" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycIbanOwnerVerificationResponse" }, "example": { "responseCode": "FN-KCFH-20002800000", "trackId": "iovTrackId", "result": { "isValid": "yes" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/cardOwnerVerification": { "post": { "operationId": "kycCardOwnerVerificationPost", "summary": "تطبیق شماره کارت و کد ملی", "description": "\nسرویس «تطبیق شماره کارت و کد ملی» (National ID / KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با وارد کردن شماره کارت و کد ملی، تطبیق یا عدم تطبیق اطلاعات را در خروجی نمایش می‌دهد.\n\n**Scope:** `kyc:card-owner-verification:post`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycCardOwnerVerificationRequest" }, "example": { "card": "6362141081734437", "nid": "6661111111" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycCardOwnerVerificationResponse" }, "example": { "responseCode": "FN-KCFH-20002800000", "trackId": "covTrackId", "result": { "isValid": true }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/ibanOwnerBirthdateVerification": { "get": { "operationId": "kycIbanOwnerBirthdateVerificationGet", "summary": "تطبیق شماره شبا، کد ملی و تاریخ تولد", "description": "\nسرویس «تطبیق شماره شبا، کد ملی و تاریخ تولد» (IBAN / National ID / KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با وارد کردن شماره شبا، کد ملی و تاریخ تولد، تطبیق یا عدم تطبیق اطلاعات را در خروجی نمایش می‌دهد.\n\n**Scope:** `kyc:iban-owner-birthdate-verification:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nid" }, { "$ref": "#/components/parameters/iban" }, { "$ref": "#/components/parameters/birthDate" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycIbanOwnerBirthdateVerificationResponse" }, "example": { "responseCode": "FN-KCFH-20002800000", "trackId": "iovTrackId", "result": { "isValid": "yes" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/thirdPartyInsuranceInquiry": { "get": { "operationId": "kycThirdPartyInsuranceInquiry", "summary": "استعلام سوابق بیمه‌نامه شخص ثالث", "description": "\nسرویس «استعلام سوابق بیمه‌نامه شخص ثالث» (KYC) در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با وارد کردن کد ملی و شماره پلاک، اطلاعات سوابق بیمه‌نامه شخص ثالث مربوط به خودرو را در خروجی نمایش می‌دهد.\n\n**Scope:** `kyc:thirdParty-insurance-inquiry:get`
\n\n**Grant type:** client_credentials\n\nشماره پلاک ۹ رقمی باید طبق [جدول راهنمای شماره پلاک](/plate-number-table.html) وارد شود.", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalCode" }, { "name": "plateNumber", "in": "query", "required": true, "description": "شماره پلاک ۹ رقمی خودرو که باید طبق الگوی توضیح داده شده در [جدول راهنمای شماره پلاک](/plate-number-table.html) وارد شود.", "schema": { "type": "string" }, "example": "911715950" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycThirdPartyInsuranceInquiryResponse" }, "example": { "responseCode": "FN-KCSY-20003000000", "trackId": "trackId", "result": { "carGroupCode": 2, "companyCode": "2", "companyName": "بیمه ایران", "countLossAmount": 0, "cylCnt": 4, "damageTypes": [], "disFnYrNum": "0", "disFnYrPrcnt": "15", "endDate": "1405/12/14", "issueDate": "1404/12/13", "mapUsageName": "شخصی", "mapVehicleSystemName": "رانا", "modelCii": 1400, "plk1": 91, "plk2": 7, "plk3": 159, "plkSrl": 50, "thirdPolicyCode": 16026006945, "vin": "VIN050400N2267007" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/ocr": { "post": { "operationId": "kycOcrVerificationPost", "summary": "خواندن اطلاعات کارت ملی با OCR", "description": "\nسرویس OCR کارت ملی فینوتک اطلاعات روی و پشت کارت را از تصویر jpg استخراج می‌کند. نوع درخواست uploadCardFront یا uploadCardBack است.\n\n\n\nاین سرویس برای دریافت اطلاعات روی و پشت کارت ملی است.\n\n**Scope:** `kyc:ocr-verification:post`
\n\n**Grant type:** client_credentials\n\nتصویر باید با فرمت **jpg** ارسال شود. `type` یکی از `uploadCardFront` یا `uploadCardBack` باشد.", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "cardImage", "type" ], "properties": { "cardImage": { "type": "string", "format": "binary", "description": "تصویر رو یا پشت کارت ملی (jpg)" }, "type": { "type": "string", "enum": [ "uploadCardFront", "uploadCardBack" ], "description": "نوع درخواست" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycOcrVerificationResponse" }, "examples": { "front": { "summary": "روی کارت ملی", "value": { "responseCode": "FN-BRFH-20001300000", "trackId": "3e35adb9-0164-4d5a-9259-70024eff51c9", "result": { "nationalCode": "0000000000", "firstName": "سیمون", "lastName": "دوبوار", "fatherName": "عباس", "birthDate": "1398/11/02", "expirationDate": "1405/11/04", "docType": "national-card-front" }, "status": "DONE" } }, "back": { "summary": "پشت کارت ملی", "value": { "responseCode": "FN-BRFH-20001300000", "trackId": "3e35adb9-0164-4d5a-9259-70024eff51c9", "result": { "serial": "0G15555555", "docType": "national-card-back" }, "status": "DONE" } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/compareVideoWithNationalCardImage": { "post": { "operationId": "kycCompareVideoWithNationalCardImagePost", "summary": "انطباق ویدئو و عکس کارت ملی", "description": "\nسرویس «انطباق ویدئو و عکس کارت ملی» ویدیوی کاربر را با عکس کارت ملی هوشمند تطبیق می‌دهد. ورودی ویدیو، کد ملی، تاریخ تولد و سریال کارت است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس ویدیوی کاربر، کد ملی، تاریخ تولد و سریال پشت کارت ملی هوشمند (یا کد رهگیری رسید کاغذی کارت ملی هوشمند) را دریافت می‌کند و ویدیوی ارسالی را با عکس کارت ملی چک می‌کند.\n\n**Scope:** `kyc:compare-video-with-national-card-image:post`
\n\n**Grant type:** client_credentials\n\nپارامترهای ورودی باید در فرمت **form-data** ارسال شوند. حجم ویدیو حداکثر پنج مگابایت است.\n\nاین سرویس از یازده شب تا هفت صبح در دسترس نیست.", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "video", "nationalCode", "birthDate", "serialNumber" ], "properties": { "video": { "type": "string", "format": "binary", "description": "ویدیوی کاربر به صورت فایل با حجم حداکثر پنج مگابایت" }, "nationalCode": { "type": "string", "description": "کد ملی", "example": "0024143331" }, "birthDate": { "type": "string", "description": "تاریخ تولد به صورت yyyy/mm/dd", "example": "1371/06/18" }, "serialNumber": { "type": "string", "description": "سریال پشت کارت ملی هوشمند (یا کد رهگیری رسید کاغذی کارت ملی هوشمند)", "example": "1R29366454" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycCompareVideoWithNationalCardImageResponse" }, "example": { "responseCode": "FN-BRFH-20004210000", "trackId": "5ddcd262-2c28-467a-848d-7cef8de85c1c", "result": { "faceVerification": 95.7, "trackingCode": "123456" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/compareLiveVideoWithNationalCard": { "post": { "operationId": "kycCompareLiveVideoWithNationalCardPost", "summary": "انطباق ویدئو زنده با عکس کارت ملی", "description": "\nسرویس «انطباق ویدئو زنده با عکس کارت ملی» ویدیوی لایو را با عکس کارت ملی چک می‌کند و لایو بودن و شباهت گفتار را هم می‌سنجد. ورودی ویدیو، کد ملی، تاریخ تولد و سریال کارت است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس ویدیوی لایو کاربر، کد ملی، تاریخ تولد و سریال پشت کارت ملی هوشمند (یا کد رهگیری رسید کاغذی کارت ملی هوشمند) را دریافت می‌کند، ویدیو را با عکس کارت ملی تطبیق می‌دهد و لایو بودن آن را تایید یا رد می‌کند.\n\n**Scope:** `kyc:compare-live-video-with-national-card-image:post`
\n\n**Grant type:** client_credentials\n\nپارامترهای ورودی باید در فرمت **form-data** ارسال شوند. حجم ویدیو حداکثر پنج مگابایت است.\n\nاگر ویدیو باید حاوی خوانش متن باشد، متن مورد انتظار را در `speechText` بفرستید تا تشابه آن با متن خوانده‌شده سنجیده شود.\n\nاین سرویس از یازده شب تا هفت صبح در دسترس نیست.", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "video", "nationalCode", "birthDate", "serialNumber" ], "properties": { "video": { "type": "string", "format": "binary", "description": "ویدیوی کاربر به صورت فایل با حجم حداکثر پنج مگابایت" }, "nationalCode": { "type": "string", "description": "کد ملی", "example": "0024143331" }, "birthDate": { "type": "string", "description": "تاریخ تولد به صورت yyyy/mm/dd", "example": "1371/06/18" }, "serialNumber": { "type": "string", "description": "سریال پشت کارت ملی هوشمند (یا کد رهگیری رسید کاغذی کارت ملی هوشمند)", "example": "1R29366454" }, "speechText": { "type": "string", "description": "متن مورد انتظار برای خوانش در ویدیو (اختیاری)", "example": "سلام سلام همگی سلام" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycCompareLiveVideoWithNationalCardResponse" }, "example": { "responseCode": "FN-BRFH-20000810000", "trackId": "5ddcd262-2c28-467a-848d-7cef8de85c1c", "result": { "faceVerification": 95.7, "liveness": 80.3, "speechSimilarity": 88.3, "printLiveness": "0.4205", "replayLiveness": "0.0394", "trackingCode": "123456" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/mobileCardVerification": { "post": { "operationId": "kycMobileCardVerificationPost", "summary": "تطبیق شماره کارت و شماره موبایل", "description": "\nسرویس «تطبیق شماره کارت و شماره موبایل» (KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با دریافت شماره موبایل و شماره کارت، تطابق آن‌ها را بررسی می‌کند.\n\n**Scope:** `kyc:mobile-card-verification:post`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycMobileCardVerificationRequest" }, "example": { "card": "6219861039486541", "mobile": "09387635874" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycMobileCardVerificationResponse" }, "example": { "responseCode": "FN-KCFH-20001000000", "trackId": "62345d-986d-4e04-abd2-2e6aac1a0ef0", "result": { "isValid": true }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/militaryInquiry": { "get": { "operationId": "kycMilitaryInquiryGet", "summary": "استعلام وضعیت نظام وظیفه", "description": "\nسرویس «استعلام وضعیت نظام وظیفه» (KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن کد ملی و تاریخ تولد، وضعیت نظام وظیفه افراد مشخص می‌شود.\n\n**Scope:** `kyc:military-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalCode" }, { "$ref": "#/components/parameters/birthDate" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycMilitaryInquiryResponse" }, "example": { "responseCode": "FN-KCKZ-20002600000", "trackId": "milit-inq-81200", "result": { "conversationId": "162763836", "type": "ORDINARY", "isAllowed": true, "condition": "ALLOWED", "conditionDescription": "مشمول نیست" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/cc/sanaInquiry": { "get": { "operationId": "kycCcSanaInquiryGet", "summary": "استعلام ثنا", "description": "\nسرویس «استعلام ثنا» (KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن کد شناسایی و نوع آن، نتیجه استعلام ثنا در سامانه قوه قضائیه برگردانده می‌شود.\n\n**Scope:** `kyc:cc-sana-inquiry:get`
\n\n**Grant type:** client_credentials\n\n`idType`: مشتری حقیقی `1`، مشتری حقوقی `2`", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "idCode", "in": "query", "required": true, "description": "کد شناسایی — حقیقی کد ملی، حقوقی شناسه ملی", "schema": { "type": "string" }, "example": "1125478963" }, { "name": "idType", "in": "query", "required": true, "description": "نوع کد شناسایی — حقیقی ۱، حقوقی ۲", "schema": { "type": "string", "enum": [ "1", "2" ] }, "example": "1" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycSanaInquiryResponse" }, "example": { "responseCode": "FN-KCKZ-20003700000", "trackId": "cc_sana_inquiry_trackId", "result": { "registered": "true", "message": "کدشناسایی وارد شده در قوه قضائیه (سامانه ثنا) احراز شده است." }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/cc/taxInquiry": { "get": { "operationId": "kycCcTaxInquiryGet", "summary": "استعلام بدهی مالیاتی", "description": "\nسرویس «استعلام بدهی مالیاتی» (KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با دریافت کد ملی، لیست بدهی‌های مالیاتی مرتبط را برمی‌گرداند.\n\n**Scope:** `kyc:tax-Inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nid" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycTaxInquiryResponse" }, "example": { "responseCode": "FN-KCFH-20002800000", "trackId": "taxInquiryTrackId", "result": { "nationalId": "6780026883", "debts": [ { "followCode": null, "nationalId": "6780026883", "taxYear": 1390, "taxPeriod": 1, "taxOffice": "463221", "taxTypeTitle": "مالیات بر درآمد مشاغل", "liabilityTypeTitle": "مالیات", "liabilitySourceTitle": "بدهی ناشی از قطعی", "amount": 7491000, "creditAmount": 0, "debtAmount": 7536000 } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/sms/taxInquiry": { "get": { "operationId": "kycSmsTaxInquiryGet", "summary": "استعلام پیامکی بدهی مالیاتی", "description": "\nسرویس «استعلام پیامکی بدهی مالیاتی» (KYC / SMS/OTP) در دسته احراز هویت و شناخت مشتری فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با دریافت کد ملی، لیست بدهی‌های مالیاتی مرتبط را برمی‌گرداند.\n\n**Scope:** `kyc:sms-tax-Inquiry:get`
\n\n**Grant type:** authorization_sms\n\nبرای فراخوانی این سرویس پس از دریافت اجازه دسترسی از کاربر، با توکن Authorization SMS فراخوانی کنید.", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nid" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycTaxInquiryResponse" }, "example": { "responseCode": "FN-KCFH-20002800000", "trackId": "taxInquiryTrackId", "result": { "nationalId": "6780026883", "debts": [ { "followCode": null, "nationalId": "6780026883", "taxYear": 1390, "taxPeriod": 1, "taxOffice": "463221", "taxTypeTitle": "مالیات بر درآمد مشاغل", "liabilityTypeTitle": "مالیات", "liabilitySourceTitle": "بدهی ناشی از قطعی", "amount": 7491000, "creditAmount": 0, "debtAmount": 7536000 } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/licenseCheckInquiry": { "post": { "operationId": "kycLicenseCheckInquiryPost", "summary": "استعلام گواهینامه و وضعیت", "description": "\nسرویس «استعلام گواهینامه و وضعیت» (KYC) در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شماره موبایل و کد ملی، اطلاعات گواهینامه‌ها و وضعیت استعلام در خروجی نمایش داده می‌شود.\n\n**Scope:** `kyc:cc-license-check-inquiry:post`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycLicenseCheckInquiryRequest" }, "example": { "nationalID": "0057684356", "mobile": "09192679854" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycLicenseCheckInquiryResponse" }, "example": { "responseCode": "FN-KCGO-20099900000", "trackId": "2ed30b25-85fc-4022-bad9-9c9a7beec475", "result": { "licenses": [ { "barCode": "00692767417000000000", "issueDate": "06/13/2050 00:00:00", "firstname": "کریم", "lastname": "کریمی", "nationalCode": "000000000", "licenseNumber": "0000000000", "licenseStatus": "اسکن شده ناجي پاس", "licenseType": "پايه سوم", "licenseValidityPeriod": "10" } ], "licenseStatus": { "code": "G00000", "description": "درخواست با موفقیت انجام شد." } }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/deathStatusInquiry": { "get": { "operationId": "kycDeathStatusInquiryGet", "summary": "استعلام وضعیت حیات", "description": "\nسرویس «استعلام وضعیت حیات» (KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با دریافت کد ملی و تاریخ تولد، وضعیت حیات (زنده یا مرده) را در خروجی نمایش می‌دهد.\n\n**Scope:** `kyc:death-status-inquiry:get`
\n\n**Grant type:** client_credentials\n\n**نکته:** این سرویس از ساعت ۲۳:۰۰ تا ۷:۰۰ غیرفعال است.", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalCode" }, { "$ref": "#/components/parameters/birthDate" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycDeathStatusInquiryResponse" }, "example": { "trackId": "9602281200", "responseCode": "FN-KCFH-20002500000", "result": { "deathStatus": "زنده", "trackingCode": "123" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/foreignerIdInquiry": { "get": { "operationId": "kycForeignerIdInquiryGet", "summary": "استعلام اتباع خارجی", "description": "\nسرویس «استعلام اتباع خارجی» (KYC) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه تبعه و تاریخ تولد، اطلاعات هویتی فرد در خروجی نمایش داده می‌شود.\n\n**Scope:** `kyc:foreigner-id-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/foreignerId" }, { "$ref": "#/components/parameters/birthDate" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycForeignerIdInquiryResponse" }, "example": { "responseCode": "FN-KCVH-20004300000", "trackId": "foreignerId-inq-trckId", "result": { "firstName": "اسدالله", "lastName": "سامانی", "fullName": "سیداحمد", "fatherName": "سیدرجب", "ancestorName": "حسین", "gender": "مرد", "nationality": "Afghanistan", "identificationDocumentTypeTitle": "کارت آمایش", "identificationDocumentNumber": "9975248674" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/driversRiskInquiry": { "get": { "operationId": "kycDriversRiskInquiryGet", "summary": "استعلام ریسک رانندگان", "description": "\nسرویس «استعلام ریسک رانندگان» (KYC) در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن کد ملی و تاریخ تولد راننده، میزان ریسک فرد در خروجی نمایش داده می‌شود.\n\n**Scope:** `kyc:drivers-risk-inquiry:get`
\n\n**Grant type:** client_credentials\n\n`personType`: حقیقی `1` (پیش‌فرض)، حقوقی `2`", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalCode" }, { "$ref": "#/components/parameters/birthDate" }, { "name": "personType", "in": "query", "required": false, "description": "نوع شخص — حقیقی ۱ (پیش‌فرض)، حقوقی ۲", "schema": { "type": "string", "enum": [ "1", "2" ] }, "example": "1" }, { "name": "agentCode", "in": "query", "required": false, "description": "کد نمایندگی", "schema": { "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycDriversRiskInquiryResponse" }, "example": { "responseCode": "FN-BRFH-20000810000", "trackId": "1234fg3", "result": { "score": 8.8 }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/transactionCreditInquiryRequest": { "get": { "operationId": "kycTransactionCreditInquiryRequestGet", "summary": "استعلام اعتبار معاملاتی (مرحله ۱) — درخواست", "description": "\nسرویس «استعلام اعتبار معاملاتی (مرحله ۱) — درخواست» (KYC) در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شماره موبایل و کد ملی، رمز یکبار مصرف جهت استعلام اعتبار معاملاتی افراد ارسال می‌شود.\n\n**Scope:** `kyc:transaction-credit-inquiry-request:get`
\n\n**Grant type:** client_credentials\n\n### مراحل فراخوانی\n\n1. درخواست استعلام (این سرویس)\n2. [صحت‌سنجی OTP](#/operations/kycTransactionCreditInquiryVerifyPost)\n3. [دریافت گزارش](#/operations/kycTransactionCreditInquiryReportGet)", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalCode" }, { "$ref": "#/components/parameters/mobile" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycTransactionCreditInquiryRequestResponse" }, "example": { "responseCode": "FN-KCST-20003400000", "trackId": "51cb0631-6740-4027-a6e4-defbd1c78ab2", "result": { "message": "OK", "inquiryTrackId": "000000" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/transactionCreditInquiryVerify": { "post": { "operationId": "kycTransactionCreditInquiryVerifyPost", "summary": "استعلام اعتبار معاملاتی (مرحله ۲) — صحت‌سنجی OTP", "description": "\nسرویس «استعلام اعتبار معاملاتی (مرحله ۲) — صحت‌سنجی OTP» (KYC / SMS/OTP) در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن کد یکبارمصرف و `inquiryTrackId` دریافتی از مرحله [درخواست](#/operations/kycTransactionCreditInquiryRequestGet)، صحت OTP بررسی می‌شود.\n\n**Scope:** `kyc:transaction-credit-inquiry-verify:post`
\n\n**Grant type:** client_credentials\n\n**مرحله بعد:** [دریافت گزارش](#/operations/kycTransactionCreditInquiryReportGet)", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycTransactionCreditInquiryVerifyRequest" }, "example": { "nationalCode": "11111111111", "otp": "12345", "inquiryTrackId": "00000" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycTransactionCreditInquiryVerifyResponse" }, "example": { "responseCode": "FN-KCST-20003500000", "trackId": "09f47f7c-a990-4de5-97ce-422a280872eb", "result": { "inquiryTrackId": "0d09f3af-9e86-4a2c-9ff6-9c0bca5ff369" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyc/v2/clients/{clientId}/transactionCreditInquiryReport": { "get": { "operationId": "kycTransactionCreditInquiryReportGet", "summary": "استعلام اعتبار معاملاتی (مرحله ۳) — دریافت گزارش", "description": "\nسرویس «استعلام اعتبار معاملاتی (مرحله ۳) — دریافت گزارش» (KYC) در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا `inquiryTrackId` دریافتی از مرحله [صحت‌سنجی](#/operations/kycTransactionCreditInquiryVerifyPost)، وضعیت موثر و محکومیت‌های مالی شخص برگردانده می‌شود.\n\n**Scope:** `kyc:transaction-credit-inquiry-report:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/transactionCreditInquiryTrackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycTransactionCreditInquiryReportResponse" }, "example": { "responseCode": "FN-KCST-20003600000", "trackId": "e6749053-444a-4a25-a0fb-cf8d982a58ea", "result": { "message": "شخص محکومیت مالی اجرا شده/نشده دارد.", "hasHistory": true, "title": "محکومیت مالی اجرا شده/نشده" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/ac/sayadIssueCheque": { "post": { "operationId": "credit_v2_clients_clientId_ac_sayadIssueCheque_post_cheque_post", "summary": "ثبت چک صیادی", "description": "\nسرویس «ثبت چک صیادی» (Sayad) در دسته چک صیادی (Sayad) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی پس از رضایت کاربر با رویکرد Authorization Code است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس جهت ثبت چک توسط صادرکننده در وجه گیرنده چک میباشد.\n\n**Scope:** `credit:ac-sayad-issue-cheque:post`
\n\n**Grant type:** authorization_code", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_ac_sayadIssueCheque_post_cheque_postResponse" }, "example": { "trackId": "7b244-3c01-44f1-b395-e3aeaa", "result": { "message": "ثبت چک با موفقیت انجام شد", "referenceId": "6546542684564" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountOwners": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "کامران نظری" }, "idCode": { "type": "string", "example": "0010300950" }, "shahabId": { "type": "string", "example": "1000000010352657" }, "idType": { "type": "string", "example": "1" } } }, "description": "لیست صاحبان حساب" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "نگین عطوفتی" }, "idCode": { "type": "string", "example": "0077695161" }, "shahabId": { "type": "string", "example": "1000000010002361" }, "idType": { "type": "string", "example": "1" } } }, "description": "لیست دریافت کنندگان چک" }, "signers": { "type": "array", "items": { "type": "object", "properties": { "signer": { "type": "object", "properties": { "name": { "type": "string", "example": "کامران نظری" }, "idCode": { "type": "string", "example": "0010344950" }, "shahabId": { "type": "string", "example": "100000001000957" }, "idType": { "type": "string", "example": "1" } } }, "legalStamp": { "type": "string", "example": "0" } } }, "description": "لیست امضاکنندگان چک" }, "sayadId": { "type": "string", "example": "9727000174850598", "description": "شناسه صیاد" }, "seriesNo": { "type": "string", "example": "1017", "description": "شماره سری" }, "serialNo": { "type": "string", "example": "029973", "description": "شماره سریال" }, "fromIban": { "type": "string", "example": "IR810620000000101000007007", "description": "شماره شبا دارنده چک" }, "amount": { "type": "string", "example": "100000", "description": "مبلغ" }, "description": { "type": "string", "example": "تست", "description": "شرح ثبت چک" }, "dueDate": { "type": "string", "example": "14001027", "description": "تاریخ سررسید چک" }, "toIban": { "type": "string", "example": "IR760620000000400037910008", "description": "شماره شبا مقصد" }, "bankCode": { "type": "string", "example": "62", "description": "کد بانک مبدا" }, "branchCode": { "type": "string", "example": "6202976", "description": "کد شعبه مبدا" }, "chequeType": { "type": "string", "example": "1", "description": "نوع چک" }, "chequeMedia": { "type": "string", "example": "1", "description": "چک کاغذی1 چک دیجیتال2" }, "reason": { "type": "string", "example": "1", "description": "بابت : [اطلاعات بیشتر](/oak-reason-description.html)" } }, "required": [ "accountOwners", "receivers", "signers", "sayadId", "seriesNo", "serialNo", "fromIban", "amount", "description", "dueDate", "bankCode", "branchCode", "chequeType", "reason" ] }, "example": { "accountOwners": [ { "name": "کامران نظری", "idCode": "0010300950", "shahabId": "1000000010352657", "idType": "1" } ], "receivers": [ { "name": "نگین عطوفتی", "idCode": "0077695161", "shahabId": "1000000010002361", "idType": "1" } ], "signers": [ { "signer": { "name": "کامران نظری", "idCode": "0010344950", "shahabId": "100000001000957", "idType": "1" }, "legalStamp": "0" } ], "sayadId": "9727000174850598", "seriesNo": "1017", "serialNo": "029973", "fromIban": "IR810620000000101000007007", "amount": "100000", "description": "تست", "dueDate": "14001027", "toIban": "IR760620000000400037910008", "bankCode": "62", "branchCode": "6202976", "chequeType": "1", "chequeMedia": "1", "reason": "1" } } } } } }, "/credit/v2/clients/{clientId}/ac/sayadTransferCheque": { "post": { "operationId": "credit_v2_clients_clientId_ac_sayadTransferCheque_post_cheque_post", "summary": "انتقال چک صیادی", "description": "\nسرویس «انتقال چک صیادی» (Sayad) در دسته چک صیادی (Sayad) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی پس از رضایت کاربر با رویکرد Authorization Code است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس جهت انتقال چک توسط دارنده در وجه گیرنده چک، میباشد.\n\n**Scope:** `credit:ac-sayad-transfer-cheque:post`
\n\n**Grant type:** authorization_code", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_ac_sayadTransferCheque_post_cheque_postResponse" }, "example": { "trackId": "7b244-3c01-44f1-b395-e3aeaa", "result": { "message": "ثبت چک با موفقیت انجام شد", "referenceId": "6546542684564", "resultCode": "1" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "holder": { "type": "object", "properties": { "name": { "type": "string", "example": "ساره بیات", "description": "نام" }, "idCode": { "type": "string", "example": "0011200013", "description": "کد شناسایی . مشتری حقیقی کدملی ، مشتری حقوقی شناسه ملی شرکت" }, "shahabId": { "type": "string", "example": "1000000010000618", "description": "کد شهاب" }, "idType": { "type": "string", "example": "1", "description": "نوع کد شناسایی با ملاحضات: مشتری حقیقی 1 ،مشتری حقوقی 2" } }, "required": [ "name", "idCode", "shahabId", "idType" ], "description": "مشخصات صاحب چک (دارنده فعلی)" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "خشایار کامرانی" }, "idCode": { "type": "string", "example": "0077000061" }, "shahabId": { "type": "string", "example": "1000000070000361" }, "idType": { "type": "string", "example": "1" } } }, "description": "لیست دریافت کنندگان چک" }, "signers": { "type": "array", "items": { "type": "object", "properties": { "signer": { "type": "object", "properties": { "name": { "type": "string", "example": "ساره بیات" }, "idCode": { "type": "string", "example": "0015405613" }, "shahabId": { "type": "string", "example": "1000000015000618" }, "idType": { "type": "string", "example": "1" } } }, "legalStamp": { "type": "string", "example": "0" } } }, "description": "لیست امضاکنندگان چک" }, "sayadId": { "type": "string", "example": "3720000100764013", "description": "شناسه صیاد" }, "acceptTransfer": { "type": "string", "example": "1" }, "toIban": { "type": "string", "example": "IR760620000000203236980008", "description": "شماره شبا مقصد" }, "transferDate": { "type": "string", "example": "14001203300500", "description": "تاریخ انتقال چک" }, "description": { "type": "string", "example": "تست", "description": "شرح انتقال چک" }, "reason": { "type": "string", "example": "POSA", "description": "بابت : [اطلاعات بیشتر](/oak-reason-description.html)" }, "giveBack": { "type": "string", "example": "0", "description": "شاخصه‌ی مشخص کننده بین عودت یا انتقال چک. انتقال جهت عودت 1 و در حالت غیر 0 ارسال شود." } }, "required": [ "holder", "receivers", "signers", "sayadId", "transferDate", "description", "reason", "giveBack" ] }, "example": { "holder": { "name": "ساره بیات", "idCode": "0011200013", "shahabId": "1000000010000618", "idType": "1" }, "receivers": [ { "name": "خشایار کامرانی", "idCode": "0077000061", "shahabId": "1000000070000361", "idType": "1" } ], "signers": [ { "signer": { "name": "ساره بیات", "idCode": "0015405613", "shahabId": "1000000015000618", "idType": "1" }, "legalStamp": "0" } ], "sayadId": "3720000100764013", "acceptTransfer": "1", "toIban": "IR760620000000203236980008", "transferDate": "14001203300500", "description": "تست", "reason": "POSA", "giveBack": "0" } } } } } }, "/credit/v2/clients/{clientId}/chequeColorInquiryLegal": { "get": { "operationId": "credit_v2_clients_clientId_chequeColorInquiryLegal_get_credit_chequeColorInquiry", "summary": "استعلام وضعیت رنگ چک حقوقی", "description": "\nسرویس «استعلام وضعیت رنگ چک حقوقی» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nدر این سرویس، با وارد کردن شناسه ملی، درخروجی کد رنگ چک نمایش داده میشود.\n\n**Scope:** `credit:cheque-color-inquiry-legal:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "idCode", "in": "query", "required": true, "description": "National ID or Sayad ID (شناسه ملی یا صیاد)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_chequeColorInquiryLegal_get_credit_chequeColorInquiryResponse" }, "example": { "responseCode": "FN-CTKZ-20003700000", "trackId": "1ccdb-4924-4ab4-9a61-9ed6573", "result": { "chequeColor": "2" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/chequeColorInquiry": { "get": { "operationId": "credit_v2_clients_clientId_chequeColorInquiry_get_chequeColorInquiry_get", "summary": "استعلام وضعیت رنگ چک", "description": "\nبا شناسه ملی یا شناسه صیاد، کد رنگ چک در سامانه اعتباری برگردانده می‌شود. سرویس اعتبارسنجی با رویکرد Client Credential.\n\n\n\nدر این سرویس، با وارد کردن شناسه ملی و یا شناسه صیاد، درخروجی کد رنگ چک نمایش داده میشود.\n\n**Scope:** `credit:cheque-color-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "idCode", "in": "query", "required": true, "description": "National ID or Sayad ID (شناسه ملی یا صیاد)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_chequeColorInquiry_get_chequeColorInquiry_getResponse" }, "example": { "responseCode": "FN-CTFH-20099900000", "trackId": "1ccdb-4924-4ab4-9a61-9ed6573", "result": { "chequeColor": "2" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/clearedCheque": { "get": { "operationId": "credit_v2_clients_clientId_clearedCheque_get_clearedCheque_get", "summary": "استعلام چک رفع سو اثر شده", "description": "\nسرویس «استعلام چک رفع سو اثر شده» در دسته چک صیادی (Sayad) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nدر این سرویس با ارسال `nationalCode` و `personType`، نام، نام خانوادگی و فهرست چک‌های رفع سو اثر شده شخص برگردانده می‌شود.\n\n**Scope:** `credit:cleared-cheque:get`
\n\n**Grant type:** client_credentials\n\n`personType`: `1` حقیقی، `2` حقوقی\n\n### ClearedType (نوع رفع سوء)\n\n| کد | شرح |\n| --- | --- |\n| 1 | لاشه چک |\n| 2 | رضایتنامه محضری از ذینفع چک |\n| 3 | مسدودی یکساله مبلغ چک |\n| 4 | بخشنامه‌ای توسط بانک‌ها (فقط در پاسخ استعلام استفاده می‌شود) |\n| 5 | دستور مراجع قضایی یا نامه مرجع ثبتی |\n| 6 | مشمول مقررات مرورزمان |\n| 7 | بخشنامه‌ای توسط بانک مرکزی (فقط در پاسخ استعلام استفاده می‌شود) |\n\n### BouncedReason (دلایل برگشت)\n\n| کد | شرح |\n| --- | --- |\n| 402 | حساب دارای کسر موجودی است. |\n| 403 | حساب مورد نظر فاقد موجودی است. |\n| 404 | امضاء مطابقت ندارد. |\n| 405 | نقص امضاء دارد. |\n| 406 | مغایرت تاریخ عددی و حروفی. |\n| 407 | امضاء چک مخدوش است. |\n| 408 | مندرجات چک مخدوش است. |\n| 409 | مبلغ حروفی با عددی مغایر است. |\n| 410 | حساب مورد نظر بسته است. |\n| 411 | حساب مورد نظر مسدود است. |\n| 412 | چک با این شماره مسدود است (حسب درخواست مشتری، ذینفع و یا مرجع قضایی مستند به ماده ۱۴ قانون صدور چک) |\n| 451 | مندرجات چک ناخواناست |\n| 452 | مغایرت با اطلاعات ثبت شده در سامانه پیچک |", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "nationalCode", "in": "query", "required": true, "description": "کد ملی شخص حقیقی (۱۰ رقم) یا شناسه ملی شخص حقوقی (۱۱ رقم)", "schema": { "type": "string" } }, { "name": "personType", "in": "query", "required": true, "description": "نوع شخص؛ ۱ حقیقی و ۲ حقوقی", "schema": { "type": "string", "enum": [ "1", "2" ] } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_clearedCheque_get_clearedCheque_getResponse" }, "example": { "responseCode": "FN-CTFH-20004000000", "trackId": "clearedCheque12312", "result": { "firstName": "علی", "lastName": "محمدی", "nid": "6780026883", "personType": 1, "chequeList": [ { "clearingBankCode": "15", "clearingBranchCode": "1234", "clearingBranchName": "شعبه مرکزی", "clearedDate": "14030101", "clearedType": "2", "bouncedAtBranchName": "شعبه برگشت‌زننده", "customerType": "1", "idCheque": "99881234", "originBranchName": "شعبه افتتاح‌کننده", "amount": "1000000", "bankCode": "15", "bouncedAmount": "500000", "bouncedDate": "14021201", "dishonorReasons": [ "402" ], "bouncedAtBranchCode": "2211", "originBranchCode": "1100", "channelKind": "1", "currencyCode": "IRR", "currencyRate": "1", "deadlineDate": "14021101", "iban": "IR120170000000100123456001", "chequeSerialNumber": "0012345678" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/smsClearedCheque": { "get": { "operationId": "credit_v2_clients_clientId_smsClearedCheque_get_smsClearedCheque_get", "summary": "استعلام چک رفع سو اثر شده (پیامکی)", "description": "\nسرویس «استعلام چک رفع سو اثر شده (پیامکی)» در دسته چک صیادی (Sayad) فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nدر این سرویس با ارسال `nationalCode` و `personType` و توکن پیامکی، نام، نام خانوادگی و فهرست چک‌های رفع سو اثر شده شخص برگردانده می‌شود.\n\n**Scope:** `credit:sms-cleared-cheque:get`
\n\n**Grant type:** authorization_sms\n\n`personType`: `1` حقیقی، `2` حقوقی\n\n### ClearedType (نوع رفع سوء)\n\n| کد | شرح |\n| --- | --- |\n| 1 | لاشه چک |\n| 2 | رضایتنامه محضری از ذینفع چک |\n| 3 | مسدودی یکساله مبلغ چک |\n| 4 | بخشنامه‌ای توسط بانک‌ها (فقط در پاسخ استعلام استفاده می‌شود) |\n| 5 | دستور مراجع قضایی یا نامه مرجع ثبتی |\n| 6 | مشمول مقررات مرورزمان |\n| 7 | بخشنامه‌ای توسط بانک مرکزی (فقط در پاسخ استعلام استفاده می‌شود) |\n\n### BouncedReason (دلایل برگشت)\n\n| کد | شرح |\n| --- | --- |\n| 402 | حساب دارای کسر موجودی است. |\n| 403 | حساب مورد نظر فاقد موجودی است. |\n| 404 | امضاء مطابقت ندارد. |\n| 405 | نقص امضاء دارد. |\n| 406 | مغایرت تاریخ عددی و حروفی. |\n| 407 | امضاء چک مخدوش است. |\n| 408 | مندرجات چک مخدوش است. |\n| 409 | مبلغ حروفی با عددی مغایر است. |\n| 410 | حساب مورد نظر بسته است. |\n| 411 | حساب مورد نظر مسدود است. |\n| 412 | چک با این شماره مسدود است (حسب درخواست مشتری، ذینفع و یا مرجع قضایی مستند به ماده ۱۴ قانون صدور چک) |\n| 451 | مندرجات چک ناخواناست |\n| 452 | مغایرت با اطلاعات ثبت شده در سامانه پیچک |", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "nationalCode", "in": "query", "required": true, "description": "کد ملی شخص حقیقی (۱۰ رقم) یا شناسه ملی شخص حقوقی (۱۱ رقم)", "schema": { "type": "string" } }, { "name": "personType", "in": "query", "required": true, "description": "نوع شخص؛ ۱ حقیقی و ۲ حقوقی", "schema": { "type": "string", "enum": [ "1", "2" ] } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_smsClearedCheque_get_smsClearedCheque_getResponse" }, "example": { "responseCode": "FN-CTKZ-20004100000", "trackId": "smsClearedCheque12312", "result": { "firstName": "علی", "lastName": "محمدی", "nid": "6780026883", "personType": 1, "chequeList": [ { "clearingBankCode": "15", "clearingBranchCode": "1234", "clearingBranchName": "شعبه مرکزی", "clearedDate": "14030101", "clearedType": "2", "bouncedAtBranchName": "شعبه برگشت‌زننده", "customerType": "1", "idCheque": "99881234", "originBranchName": "شعبه افتتاح‌کننده", "amount": "1000000", "bankCode": "15", "bouncedAmount": "500000", "bouncedDate": "14021201", "dishonorReasons": [ "402" ], "bouncedAtBranchCode": "2211", "originBranchCode": "1100", "channelKind": "1", "currencyCode": "IRR", "currencyRate": "1", "deadlineDate": "14021101", "iban": "IR120170000000100123456001", "chequeSerialNumber": "0012345678" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/chequeStatusInquiry": { "post": { "operationId": "credit_v2_clients_clientId_chequeStatusInquiry_post_inquiry_post", "summary": "استعلام چک در راه", "description": "\nسرویس «استعلام چک در راه» در دسته چک صیادی (Sayad) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه صیاد و شناسه ملی حقیقی یا حقوقی، وضعیت چک( برگشت خورده، نقد شده، رفع سوء اثر شده و ...) در خروجی برمیگردد.\n\n**Scope:** `credit:cheque-status-inquiry:post`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_chequeStatusInquiry_post_inquiry_postResponse" }, "example": { "responseCode": "FN-CTKZ-20003300000", "trackId": "aaaaaaaa-8802-4321-bed4-aaaaaaaaaaaa", "result": { "onGoing": 180229920122, "ownersInfo": [ { "idCode": "1234567890", "idType": 2, "bounced": 0, "cleared": 64776521323 } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sayadId": { "type": "string", "example": "9999999999999999", "description": "شناسه صیاد چک" }, "idCode": { "type": "string", "example": "1234567890", "description": "کد شناسایی، مشتری حقیقی کد ملی٬ مشتری حقوقی شناسه ملی شرکت" } }, "required": [ "sayadId", "idCode" ] }, "example": { "sayadId": "9999999999999999", "idCode": "1234567890" } } } } } }, "/credit/v2/clients/{clientId}/chequebookInquiry": { "get": { "operationId": "credit_v2_clients_clientId_chequebookInquiry_get_chequebookInquiry_get", "summary": "استعلام دسته چک صیادی", "description": "\nسرویس «استعلام دسته چک صیادی» (Sayad) در دسته چک صیادی (Sayad) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nدر این سرویس با وارد کردن شماره حساب، میتوانید اطلاعات مربوط به لیست دسته چک های صیادی متصل به آن حساب را در خروجی مشاهده نمایید.\n\n**Scope:** `credit:chequebook-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "deposit", "in": "query", "required": true, "description": "Deposit account number (شماره سپرده)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_chequebookInquiry_get_chequebookInquiry_getResponse" }, "example": { "responseCode": "FN-CTKZ-20002800000", "trackId": "abf04237-9ee7-87150f1efada", "result": { "chequeDetails": [ { "accountNo": "0101252337009", "branchCodeAndName": "0127/گاندی - بیمه رازی", "branchCode": "0127", "branchName": "گاندی-بیمه رازی", "approvedDate": "1401/09/23", "customerName": "محمدعلي دى پير", "customerNo": "0053682167", "customerType": "1", "deliveryBranchCode": "0297", "expireDate": "14040923", "isABunch": "false", "issuanceDate": "14010923", "mediaType": "BANS", "nationalCode": "0010009007", "serialNoFrom": "8785410145586299", "serialNoTo": "6480010145586308", "serialNumbers": "868401016546299,4768013265586300,17270101467986301,4482064535586302,4098010174126303,2807589645586304,1959010146356305,5199010145326306,3737452145586307,6480058795586308", "iban": "IR600620000000101276454009", "sheetCount": "10", "stateDescription": "دسته چک چاپ شد " } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/guaranteeCollaterals": { "get": { "operationId": "credit_v2_clients_clientId_guaranteeCollaterals_get_guarantee_collaterals", "summary": "وثایق و تضامین ضمانت نامه", "description": "\nسرویس «وثایق و تضامین ضمانت نامه» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه ضمانت‌نامه (`guaranteeId`)، فهرست وثایق و تضامین متصل به آن ضمانت‌نامه برگردانده می‌شود.\n\n**Scope:** `credit:guarantee-collaterals:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "guaranteeId", "in": "query", "required": true, "description": "Guarantee identifier (شناسه ضمانت)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_guaranteeCollaterals_get_guarantee_collateralsResponse" }, "example": { "trackId": "get-guarantee-collaterals-029", "retCodeDescription": null, "guaranteeId": "6000034390000", "collaterals": [ { "collateralId": "6545645646", "collateralTypeCode": "01", "centralBankCollateralTypeCode": "02", "collateralTypeDescription": "شرح", "evaluatedAmount": "10000", "debtAmount": "10000", "interestRate": "000.21", "receiveDate": "14000101", "issueDate": "13991202", "assignDate": "14000203" } ], "alertCode": "00000", "messageOut": null, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/guaranteeDetails": { "get": { "operationId": "credit_v2_clients_clientId_guaranteeDetails_get_credit_guaranteeDetails", "summary": "اطلاعات ضمانت نامه", "description": "\nسرویس «اطلاعات ضمانت نامه» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه ضمانت‌نامه (`guaranteeId`)، جزئیات ضمانت‌نامه شامل بدهی، تاریخ صدور و سررسید و نوع ضمانت برگردانده می‌شود.\n\n**Scope:** `credit:guarantee-details:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "guaranteeId", "in": "query", "required": true, "description": "Guarantee identifier (شناسه ضمانت)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_guaranteeDetails_get_credit_guaranteeDetailsResponse" }, "example": { "trackId": "feba236a-d4b5-4f93-97e9-0b0f8e993d2a", "result": { "retCodeDescription": null, "guaranteeId": "6000034392235", "sepamId": "0297665987813241", "branchCode": "0387", "centralBankTypeCode": "02", "guaranteeSubTypeCode": "0632", "guaranteeSubTypeDesc": "ضمانتنامه‌حسن‌‌اجر‌ای‌تعهدخدمات‌", "cif": "0031254687", "debtAmount": "500000000", "issueDate": "14000824", "maturityDate": "14010301", "renewDate": " ", "companyPreDebtAmount": " ", "issueChargeAmount": "600000", "lastRenewChargeAmount": " ", "totalCharge": "600000", "guaranteeStatusCode": "1", "guaranteeStatusDescription": " وضعیت تع‌هد", "economicDesc": "بخش‌ خدمات‌", "economicSubsectionDesc": "بخش‌ خدمات‌-سایر" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/macnaInquiry": { "get": { "operationId": "credit_v2_clients_clientId_macnaInquiry_get_inquiry_get", "summary": "استعلام مکنا", "description": "\nسرویس «استعلام مکنا» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن کد ملی، مانده و سوابق مکنا (کد مکنا، مانده ایران/بانک و تاریخ‌ها) برگردانده می‌شود.\n\n**Scope:** `credit:macna-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "nationalCode", "in": "query", "required": true, "description": "National code (کد ملی)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_macnaInquiry_get_inquiry_getResponse" }, "example": { "responseCode": "FN-CTKZ-20002200000", "trackId": "feba236a-d4b5-4f93-97e9-0b0f8e993d2a", "result": [ { "trace": 14645, "firstName": "محمد", "lastName": "قریشی", "nationalCode": "2132131323", "remain": { "iran": 100000000, "bank": 2000000000 }, "history": [ { "macnaCode": "1113810072693", "issueDate": "2011-08-17", "updated": "2015-08-23", "cardType": 2, "pan": "636214******0256", "bankCode": 62, "bankName": "بانک تات", "stateCode": 3, "stateDescription": "باطل", "messageCode": 14, "messageDescription": "درخواست المثنی" } ] } ], "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/sayadSerialInquiry": { "get": { "operationId": "credit_v2_clients_clientId_sayadSerialInquiry_get_inquiry_get", "summary": "استعلام شناسه چک صیادی", "description": "\nسرویس «استعلام شناسه چک صیادی» (Sayad) در دسته چک صیادی (Sayad) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با دریافت شناسه چک صیادی، اطلاعات برگه چک و دارنده دسته چک را برمیگرداند.\n\n**Scope:** `credit:sayad-serial-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "sayadId", "in": "query", "required": true, "description": "Sayad cheque ID (شناسه صیاد)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_sayadSerialInquiry_get_inquiry_getResponse" }, "example": { "trackId": "7b244-3c01-44f1-moho-e3aeaa", "result": { "iban": "IR020620000000100925869001", "issuedDate": "14000803", "expirationDate": "null", "serialNo": "878535", "seriesNo": "1234", "mediaType": "BANS", "branchCode": "6299996", "name": "کامران تفتی", "returnedCheques": null }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/sayadTransfersChainInquiry": { "post": { "operationId": "credit_v2_clients_clientId_sayadTransfersChainInquiry_post_inquiry_post", "summary": "استعلام زنجیره انتقالات چک صیاد", "description": "\nسرویس «استعلام زنجیره انتقالات چک صیاد» (Sayad) در دسته چک صیادی (Sayad) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس جهت دریافت اطلاعات زنجیره انتقالات و ذینفعان چک می باشد.\n\n**Scope:** `credit:sayad-transfers-chain-inquiry:post`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_sayadTransfersChainInquiry_post_inquiry_postResponse" }, "example": { "responseCode": "FN-CTKZ-20003200000", "trackId": "cf1da6d1-8775-406a-moho-48228891bdd0", "result": { "chain": [ { "customers": [ { "name": "یعقوب یعقوبی", "idCode": "1111111111", "idType": 1 } ], "roleType": 1 } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sayadId": { "type": "string", "example": "1111111111111111", "description": "شناسه صیاد چک" }, "chequeType": { "type": "string", "example": "1", "description": "نوع چک" }, "idCode": { "type": "string", "example": "1111111111", "description": "کد شناسایی، مشتری حقیقی کد ملی٬ مشتری حقوقی شناسه ملی شرکت" } }, "required": [ "sayadId", "chequeType", "idCode" ] }, "example": { "sayadId": "1111111111111111", "chequeType": "1", "idCode": "1111111111" } } } } } }, "/credit/v2/clients/{clientId}/sms/chequeColorInquiry": { "get": { "operationId": "credit_v2_clients_clientId_sms_chequeColorInquiry_get_inquiry_get", "summary": "وضعیت رنگ چک پیامکی", "description": "\nسرویس «وضعیت رنگ چک پیامکی» (SMS/OTP) در دسته تسهیلات و اعتبارسنجی فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nدر این سرویس، با وارد کردن شناسه ملی حقیقی یا حقوقی، درخروجی کد رنگ چک نمایش داده میشود.\n\n**Scope:** `credit:sms-cheque-color-inquiry:get`
\n\n**Grant type:** authorization_sms", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "idCode", "in": "query", "required": true, "description": "National ID or Sayad ID (شناسه ملی یا صیاد)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_sms_chequeColorInquiry_get_inquiry_getResponse" }, "example": { "responseCode": "FN-CTKZ-20002700000", "trackId": "1ccdb-4924-4ab4-moho-9ed6573", "result": { "chequeColor": "4" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/sms/chequeStatusInquiry": { "post": { "operationId": "credit_v2_clients_clientId_sms_chequeStatusInquiry_post_inquiry_post", "summary": "استعلام چک در راه (پیامکی)", "description": "\nسرویس «استعلام چک در راه (پیامکی)» (SMS/OTP) در دسته چک صیادی (Sayad) فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه صیاد و شناسه ملی حقیقی یا حقوقی، وضعیت چک( برگشت خورده، نقد شده، رفع سوء اثر شده و ...) در خروجی برمیگردد.\n\n**Scope:** `credit:sms-cheque-status-inquiry:post`
\n\n**Grant type:** authorization_sms", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_sms_chequeStatusInquiry_post_inquiry_postResponse" }, "example": { "responseCode": "FN-CTKZ-20003300000", "trackId": "aaaaaaaa-8802-4321-bed4-aaaaaaaaaaaa", "result": { "onGoing": 180229920122, "ownersInfo": [ { "idCode": "1234567890", "idType": 2, "bounced": 0, "cleared": 64776521323 } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sayadId": { "type": "string", "example": "9999999999999999", "description": "شناسه صیاد چک" }, "idCode": { "type": "string", "example": "1234567890", "description": "کد شناسایی، مشتری حقیقی کد ملی٬ مشتری حقوقی شناسه ملی شرکت" } }, "required": [ "sayadId", "idCode" ] }, "example": { "sayadId": "9999999999999999", "idCode": "1234567890" } } } } } }, "/credit/v2/clients/{clientId}/sms/sayadTransferCheque": { "post": { "operationId": "credit_v2_clients_clientId_sms_sayadTransferCheque_post_legal_post", "summary": "انتقال چک صیاد (پیامکی)", "description": "\nسرویس «انتقال چک صیاد (پیامکی)» (Sayad / SMS/OTP) در دسته چک صیادی (Sayad) فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس جهت انتقال چک توسط دارنده حقیقی و یا حقوقی در وجه گیرنده چک، میباشد.\n\n**Scope:** `credit:sms-sayad-transfer-cheque:post`
\n\n**Grant type:** authorization_sms", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_sms_sayadTransferCheque_post_legal_postResponse" }, "example": { "responseCode": "FN-CTFH-20002600000", "trackId": "7b244-3c01-44f1-moho-e3aeaa", "result": { "message": "ثبت چک با موفقیت انجام شد", "referenceId": "6546542684564", "resultCode": "1" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "holder": { "type": "object", "properties": { "name": { "type": "string", "example": "ساره بیات", "description": "نام" }, "idCode": { "type": "string", "example": "3500406604", "description": "کد شناسایی . مشتری حقیقی کدملی ، مشتری حقوقی شناسه ملی شرکت" }, "shahabId": { "type": "string", "example": "1001011010011000", "description": "کد شهاب" } }, "required": [ "name", "idCode", "shahabId" ], "description": "مشخصات صاحب چک (دارنده فعلی)" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "خشایار کامرانی" }, "idCode": { "type": "string", "example": "1077033057" }, "shahabId": { "type": "string", "example": "1011022033044355" }, "idType": { "type": "string", "example": "1" } } }, "description": "لیست دریافت کنندگان چک" }, "signers": { "type": "array", "items": { "type": "object", "properties": { "signer": { "type": "object", "properties": { "name": { "type": "string", "example": "ساره بیات" }, "idCode": { "type": "string", "example": "1010308653" }, "shahabId": { "type": "string", "example": "1022001106077619" }, "idType": { "type": "string", "example": "1" } } }, "legalStamp": { "type": "string", "example": "0" } } }, "description": "لیست امضاکنندگان چک" }, "sayadId": { "type": "string", "example": "3720770110760412", "description": "شناسه صیاد" }, "acceptTransfer": { "type": "string", "example": "1" }, "toIban": { "type": "string", "example": "IR760620220011277246981108", "description": "شماره شبا مقصد" }, "transferDate": { "type": "string", "example": "14001203300600", "description": "تاریخ انتقال چک" }, "description": { "type": "string", "example": "تست", "description": "شرح انتقال چک" }, "reason": { "type": "string", "example": "POSA", "description": "بابت : [اطلاعات بیشتر](/oak-reason-description.html)" }, "giveBack": { "type": "string", "example": "0", "description": "شاخصه‌ی مشخص کننده بین عودت یا انتقال چک. انتقال جهت عودت 1 و در حالت غیر 0 ارسال شود." } }, "required": [ "holder", "receivers", "signers", "sayadId", "transferDate", "description", "reason", "giveBack" ] }, "example": { "holder": { "name": "ساره بیات", "idCode": "3500406604", "shahabId": "1001011010011000" }, "receivers": [ { "name": "خشایار کامرانی", "idCode": "1077033057", "shahabId": "1011022033044355", "idType": "1" } ], "signers": [ { "signer": { "name": "ساره بیات", "idCode": "1010308653", "shahabId": "1022001106077619", "idType": "1" }, "legalStamp": "0" } ], "sayadId": "3720770110760412", "acceptTransfer": "1", "toIban": "IR760620220011277246981108", "transferDate": "14001203300600", "description": "تست", "reason": "POSA", "giveBack": "0" } } } } } }, "/credit/v2/clients/{clientId}/sms/sayadTransfersChainInquiry": { "post": { "operationId": "credit_v2_clients_clientId_sms_sayadTransfersChainInquiry_post_inquiry_post", "summary": "استعلام زنجیره انتقالات چک صیاد (پیامکی)", "description": "\nسرویس «استعلام زنجیره انتقالات چک صیاد (پیامکی)» (Sayad / SMS/OTP) در دسته چک صیادی (Sayad) فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس جهت دریافت اطلاعات زنجیره انتقالات و ذینفعان چک می باشد.\n\n**Scope:** `credit:sms-sayad-transfers-chain-inquiry:post`
\n\n**Grant type:** authorization_sms", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_sms_sayadTransfersChainInquiry_post_inquiry_postResponse" }, "example": { "responseCode": "FN-CTKZ-20003200000", "trackId": "cf1da6d1-8775-406a-moho-48228891bdd0", "result": { "chain": [ { "customers": [ { "name": "یعقوب یعقوبی", "idCode": "1111111111", "idType": 1 } ], "roleType": 1 } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sayadId": { "type": "string", "example": "1111111111111111", "description": "شناسه صیاد چک" }, "chequeType": { "type": "string", "example": "1", "description": "نوع چک" }, "idCode": { "type": "string", "example": "1111111111", "description": "کد شناسایی، مشتری حقیقی کد ملی٬ مشتری حقوقی شناسه ملی شرکت" } }, "required": [ "sayadId", "chequeType", "idCode" ] }, "example": { "sayadId": "1111111111111111", "chequeType": "1", "idCode": "1111111111" } } } } } }, "/credit/v2/clients/{clientId}/users/{nid}/sms/guarantyInquiry": { "get": { "operationId": "credit_v2_clients_clientId_users_nid_sms_guarantyInquiry_get_inquiry_get", "summary": "استعلام ضمانت های فرد با پیامک", "description": "\nسرویس «استعلام ضمانت های فرد با پیامک» (National ID / SMS/OTP) در دسته تسهیلات و اعتبارسنجی فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با وارد کردن کد ملی یا شناسه ملی، فهرست وام‌هایی را برمی‌گرداند که شخص به‌عنوان ضامن در آن‌ها ثبت شده است (شامل مشخصات بدهکار، مبلغ و شعبه بانک).\n\n**Scope:** `credit:sms-guaranty-inquiry:get`
\n\n**Grant type:** authorization_sms", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "nid", "in": "path", "required": true, "description": "National ID (کد ملی)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_nid_sms_guarantyInquiry_get_inquiry_getResponse" }, "example": { "responseCode": "FN-CTKZ-20002300000", "trackId": "0705ae6c-ac95-4574-moho-0e85d149d9bf", "result": { "guarantyFirstName": "امیرمحمد", "guarantyLastName": "اسد", "guarantyNationalCode": "1234567890", "guarantyLegalId": null, "inquiryResultId": "12345678", "debtorList": [ { "debtorFirstName": "اکبر", "debtorLastName": "اکبری", "totalAmount": "97488736", "benefitAmount": "90445871", "obligationAmount": "0", "suspiciousAmount": "0", "deferredAmount": "0", "orginalAmount": "300000000", "pastExpiredAmount": "0", "bankCode": "13", "setDate": "13980521", "endDate": "14010621", "guarantyPercent": "100", "requestNumber": "2222222222222222", "requestType": "3", "branchCode": "00144", "branchDescription": "بانک صادرات - شعبه شهید نامجو", "guarantyIdNumber": "0123456789", "guarantyLegalId": "0", "defunctAmount": null, "commitmentBalanceAmount": "0", "latePenaltyAmount": "0" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/users/{user}/backChequesLegal": { "get": { "operationId": "credit_v2_clients_clientId_users_user_backChequesLegal_get_legal_get", "summary": "استعلام چک برگشتی حقوقی", "description": "\nسرویس «استعلام چک برگشتی حقوقی» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا دریافت شناسه ملی، چک های برگشتی را در خروجی نمایش می دهد.\n\n**Scope:** `credit:back-cheques-legal:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_backChequesLegal_get_legal_getResponse" }, "example": { "responseCode": "FN-CTKZ-20003000000", "trackId": "getBackCheques12312", "result": { "nid": null, "legalId": "14001111111", "name": "فینوتک پارس", "chequeList": [ { "accountNumber": "000000000013152586", "amount": "900000000", "backDate": "13960310", "bankCode": "18", "branchCode": "00167", "branchDescription": "بانک تجارت - فخررازي", "date": "13960310", "id": "090922111", "number": "0000887329" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/users/{user}/backCheques": { "get": { "operationId": "credit_v2_clients_clientId_users_user_backCheques_get_cheques_get", "summary": "استعلام چک برگشتی", "description": "\nسرویس «استعلام چک برگشتی» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nچک‌های برگشتی (همه بانک‌ها ) مشتری را برمی‌گرداند.\n\n**Scope:** `credit:back-cheques:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_backCheques_get_cheques_getResponse" }, "example": { "result": { "nid": "0012345678", "name": "سپهر صبور", "chequeList": [ { "accountNumber": "000000000013152586", "amount": 900000000, "bankCode": 17, "backDate": "13960610", "date": "13960310", "branchCode": "00151", "dishonoringBranchName": "بانک تجارت - فخررازي", "branchDescription": "بانک تجارت - فخررازي", "dishonorReason": "حساب داراي كسر موجودي است.", "branchBounced": "00151", "id": "090922111", "number": "0000887329" } ] }, "status": "DONE", "trackId": "getBackCheques12312" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/users/{user}/facilityInquiryLegal": { "get": { "operationId": "credit_v2_clients_clientId_users_user_facilityInquiryLegal_get_legal_get", "summary": "استعلام تسهیلات جاری حقوقی", "description": "\nسرویس «استعلام تسهیلات جاری حقوقی» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nتسهیلات جاری حقوقی را برمی گرداند(تسهیلات همه بانک‌ها)\n\n**Scope:** `credit:facility-inquiry-legal:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_facilityInquiryLegal_get_legal_getResponse" }, "example": { "responseCode": "FN-CTKZ-20003500000", "trackId": "getfacility213454", "result": { "user": null, "legalId": "14001111111", "name": "فینوتک پارس", "facilityTotalAmount": "324921522", "facilityDebtTotalAmount": "101017180", "facilityPastExpiredTotalAmount": "0", "facilityDeferredTotalAmount": "0", "facilitySuspiciousTotalAmount": "0", "dishonored": "", "facilityList": [ { "bankCode": "14", "branchCode": "91182", "branchDescription": "بانک مسکن - مسکن - تهران - پارک دانشجوتهران", "pastExpiredAmount": "0", "deferredAmount": "0", "suspiciousAmount": "0", "debtorTotalAmount": "101017180", "type": "18", "amountOrginal": "180000000", "benefitAmount": "101017180", "FacilityBankCode": "14", "FacilityBranchCode": "02159", "FacilityBranch": "بانک مسکن - شهیدنامجوی تهران", "FacilityRequestNo": "0215997049192414", "FacilityRequestType": "3", "FacilityCurrencyCode": "IRR", "FacilityPastExpiredAmount": "0", "FacilityDeferredAmount": "0", "FacilitySuspiciousAmount": "0", "FacilityDebtorTotalAmount": "1151155953", "FacilityType": "18", "FacilityStatus": "جاری", "FacilityAmountOrginal": "600000000", "FacilityBenefitAmount": "752873056", "FacilitySetDate": "13970430", "FacilityEndDate": "14090430", "FacilityAmountObligation": "0", "FacilityGroup": "اصلي", "FacilityMoratoriumDate": "0" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/users/{user}/facilityInquiry": { "get": { "operationId": "credit_v2_clients_clientId_users_user_facilityInquiry_get_inquiry_get", "summary": "استعلام تسهیلات", "description": "\nسرویس «استعلام تسهیلات» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nتسهیلات جاری مشتری را برمی گرداند(تسهیلات همه بانک‌ها)\n\n**Scope:** `credit:facility-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_facilityInquiry_get_inquiry_getResponse" }, "example": { "result": { "user": "007133195", "name": "امیر قریشی مقدم", "facilityTotalAmount": "324921522", "facilityDebtTotalAmount": "101017180", "facilityPastExpiredTotalAmount": "0", "facilityDeferredTotalAmount": "0", "facilitySuspiciousTotalAmount": "0", "dishonored": "", "facilityList": [ { "bankCode": "14", "branchCode": "91182", "branchDescription": "بانک مسکن - مسکن - تهران - پارک دانشجوتهران", "pastExpiredAmount": "0", "deferredAmount": "0", "suspiciousAmount": "0", "debtorTotalAmount": "101017180", "type": "18", "amountOrginal": "180000000", "benefitAmount": "101017180", "FacilityBankCode": "14", "FacilityBranchCode": "02159", "FacilityBranch": "بانک مسکن - شهیدنامجوی تهران", "FacilityRequestNo": "0215997049192414", "FacilityRequestType": "3", "FacilityCurrencyCode": "IRR", "FacilityPastExpiredAmount": "0", "FacilityDeferredAmount": "0", "FacilitySuspiciousAmount": "0", "FacilityDebtorTotalAmount": "1151155953", "FacilityType": "18", "FacilityStatus": "جاری", "FacilityAmountOrginal": "600000000", "FacilityBenefitAmount": "752873056", "FacilitySetDate": "13970430", "FacilityEndDate": "14090430", "FacilityAmountObligation": "0", "FacilityGroup": "اصلي", "FacilityMoratoriumDate": "0" } ] }, "status": "DONE", "trackId": "getfacility213454" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/users/{user}/sms/backCheques": { "get": { "operationId": "credit_v2_clients_clientId_users_user_sms_backCheques_get_cheques_get", "summary": "استعلام پیامکی چک برگشتی", "description": "\nسرویس «استعلام پیامکی چک برگشتی» (SMS/OTP) در دسته تسهیلات و اعتبارسنجی فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nچک‌های برگشتی همه بانک‌ها را با تایید پیامکی برمی‌گرداند.\n\n**Scope:** `credit:sms-back-cheques:get`
\n\n**Grant type:** authorization_sms", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_sms_backCheques_get_cheques_getResponse" }, "example": { "responseCode": "FN-CTKZ-20000500000", "trackId": "ae2ecba2-0d62-486f-moho-deec782f1f55", "result": { "nid": "0012345678", "legalId": null, "name": "سپهر صبور", "chequeList": [ { "accountNumber": "000000000013152586", "amount": 900000000, "bankCode": 17, "branchCode": "00151", "branchDescription": "بانک تجارت - فخررازي", "dishonoringBranchName": "بانک تجارت - فخررازي", "dishonorReason": "حساب داراي كسر موجودي است.", "branchBounced": "00151", "date": "13960310", "backDate": "13960610", "id": "090922111", "number": "0000887329" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/users/{user}/sms/facilityInquiry": { "get": { "operationId": "credit_v2_clients_clientId_users_user_sms_facilityInquiry_get_inquiry_get", "summary": "استعلام پیامکی تسهیلات", "description": "\nسرویس «استعلام پیامکی تسهیلات» (SMS/OTP) در دسته تسهیلات و اعتبارسنجی فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nتسهیلات جاری مشتری را با تایید پیامکی از همه بانک‌ها برمی‌گرداند.\n\n**Scope:** `credit:sms-facility-inquiry:get`
\n\n**Grant type:** authorization_sms", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_sms_facilityInquiry_get_inquiry_getResponse" }, "example": { "responseCode": "FN-CTKZ-20000100000", "trackId": "95d682a0-9c48-4927-moho-ecc70e134272", "result": { "user": "0012345678", "legalId": null, "name": "حسین رحمتی شادان", "facilityTotalAmount": "324921522", "facilityDebtTotalAmount": "101017180", "facilityPastExpiredTotalAmount": "0", "facilityDeferredTotalAmount": "0", "facilitySuspiciousTotalAmount": "0", "dishonored": "", "facilityList": [ { "bankCode": "14", "branchCode": "91182", "branchDescription": "بانک مسکن - مسکن - تهران - پارک دانشجوتهران", "pastExpiredAmount": "0", "deferredAmount": "0", "suspiciousAmount": "0", "debtorTotalAmount": "101017180", "type": "18", "amountOrginal": "180000000", "benefitAmount": "101017180", "FacilityBankCode": "14", "FacilityBranchCode": "02159", "FacilityBranch": "بانک مسکن - شهیدنامجوی تهران", "FacilityRequestNo": "0215997049192414", "FacilityRequestType": "3", "FacilityCurrencyCode": "IRR", "FacilityPastExpiredAmount": "0", "FacilityDeferredAmount": "0", "FacilitySuspiciousAmount": "0", "FacilityDebtorTotalAmount": "1151155953", "FacilityType": "18", "FacilityStatus": "جاری", "FacilityAmountOrginal": "600000000", "FacilityBenefitAmount": "752873056", "FacilitySetDate": "13970430", "FacilityEndDate": "14090430", "FacilityAmountObligation": "0", "FacilityGroup": "اصلي", "FacilityMoratoriumDate": "0" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/users/{user}/sms/sayadAcceptCheque": { "post": { "operationId": "credit_v2_clients_clientId_users_user_sms_sayadAcceptCheque_post_sms_post", "summary": "تایید و رد چک صیاد توسط گیرنده (پیامکی)", "description": "\nسرویس «تایید و رد چک صیاد توسط گیرنده (پیامکی)» (Sayad / SMS/OTP) در دسته چک صیادی (Sayad) فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با دریافت شناسه چک صیاد و اطلاعات گیرنده، امکان تایید یا رد چک را فراهم می‌کند (`accept`: ۱ تایید، ۰ رد).\n\n**Scope:** `credit:sms-sayad-accept-cheque:post`
\n\n**Grant type:** authorization_sms", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_sms_sayadAcceptCheque_post_sms_postResponse" }, "example": { "trackId": "7113b244-3c01-44f1-b395-e3ab464cfeaa", "result": { "message": "تایید چک با موفقیت انجام شد", "referenceId": "11111111111111" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sayadId": { "type": "string", "example": "6230008888888575", "description": "شناسه صیاد چک ," }, "accept": { "type": "string", "example": "1", "description": "وضعیت تایید چک که 0 به معنای رد و 1 به معنای تایید" }, "acceptDescription": { "type": "string", "example": "تایید", "description": "شرح تایید که این فیلد فقط میتواند شامل حروف فارسی باشد ," }, "acceptor": { "type": "object", "properties": { "idCode": { "type": "string", "example": "1111111111", "description": "کد شناسایی . مشتری حقیقی کدملی ، مشتری حقوقی شناسه ملی شرکت" }, "shahabId": { "type": "string", "example": "2000014000000000", "description": "کد شهاب ," }, "idType": { "type": "string", "example": "2", "description": "نوع کد شناسایی با ملاحضات: مشتری حقیقی 1 ،مشتری حقوقی 2" } }, "required": [ "idCode", "shahabId", "idType" ], "description": "اطلاعات مشتری تائید کننده چک. این مشتری می تواند حقیقی یا حقوقی باشد و باید چک به نام او کشیده شده یا انتقال داده شده باشد," }, "acceptorAgent": { "type": "object", "properties": { "idCode": { "type": "string", "example": "0055555866", "description": "کد شناسایی . مشتری حقیقی کدملی ، مشتری حقوقی شناسه ملی شرکت" }, "shahabId": { "type": "string", "example": "2000014000000000", "description": "کد شهاب ," }, "idType": { "type": "string", "example": "1", "description": "نوع کد شناسایی با ملاحضات: مشتری حقیقی 1 ،مشتری حقوقی 2" } }, "required": [ "idCode", "shahabId", "idType" ], "description": "در صورتیکه ثبت کننده تائید، نماینده شخص حقوقی یا وکیل شخص گیرنده چک باشد این داده اجباری خواهدبود ," } }, "required": [ "sayadId", "accept", "acceptDescription" ] }, "example": { "sayadId": "6230008888888575", "accept": "1", "acceptDescription": "تایید", "acceptor": { "idCode": "1111111111", "shahabId": "2000014000000000", "idType": "2" }, "acceptorAgent": { "idCode": "0055555866", "shahabId": "2000014000000000", "idType": "1" } } } } } } }, "/credit/v2/clients/{clientId}/users/{user}/sms/sayadCancelCheque": { "post": { "operationId": "credit_v2_clients_clientId_users_user_sms_sayadCancelCheque_post_sms_post", "summary": "لغو چک صیاد توسط صادر کننده (پیامکی)", "description": "\nسرویس «لغو چک صیاد توسط صادر کننده (پیامکی)» (Sayad / SMS/OTP) در دسته چک صیادی (Sayad) فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس به صادرکننده اجازه می‌دهد با دریافت شناسه چک صیاد و اطلاعات لغوکننده، چک را لغو کند.\n\n**Scope:** `credit:sms-sayad-cancel-cheque:post`
\n\n**Grant type:** authorization_sms", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_sms_sayadCancelCheque_post_sms_postResponse" }, "example": { "trackId": "7113b244-3c01-44f1-b395-e3ab464cfeaa", "result": { "message": "لغو چک با موفقیت انجام شد", "referenceId": "11111111111111" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sayadId": { "type": "string", "example": "6230008888888575", "description": "شناسه صیاد چک ," }, "cancelDescription": { "type": "string", "example": "رد", "description": "شرح لغو که این فیلد فقط میتواند شامل حروف فارسی باشد ," }, "canceller": { "type": "object", "properties": { "idCode": { "type": "string", "example": "1111111111", "description": "کد شناسایی . مشتری حقیقی کدملی ، مشتری حقوقی شناسه ملی شرکت" }, "shahabId": { "type": "string", "example": "2000014000000000", "description": "کد شهاب ," }, "idType": { "type": "string", "example": "2", "description": "نوع کد شناسایی با ملاحضات: مشتری حقیقی 1 ،مشتری حقوقی 2" } }, "required": [ "idCode", "shahabId", "idType" ], "description": "اطلاعات مشتری لغو کننده چک. این مشتری می تواند حقیقی یا حقوقی باشد و باید چک به نام او کشیده شده یا انتقال داده شده باشد," }, "cancellerAgent": { "type": "object", "properties": { "idCode": { "type": "string", "example": "0055555866", "description": "کد شناسایی . مشتری حقیقی کدملی ، مشتری حقوقی شناسه ملی شرکت" }, "shahabId": { "type": "string", "example": "2000014000000000", "description": "کد شهاب ," }, "idType": { "type": "string", "example": "1", "description": "نوع کد شناسایی با ملاحضات: مشتری حقیقی 1 ،مشتری حقوقی 2" } }, "required": [ "idCode", "shahabId", "idType" ], "description": "در صورتیکه لغو کننده، نماینده شخص حقوقی یا وکیل شخص گیرنده چک باشد این داده اجباری خواهدبود ," } }, "required": [ "sayadId", "cancelDescription" ] }, "example": { "sayadId": "6230008888888575", "cancelDescription": "رد", "canceller": { "idCode": "1111111111", "shahabId": "2000014000000000", "idType": "2" }, "cancellerAgent": { "idCode": "0055555866", "shahabId": "2000014000000000", "idType": "1" } } } } } } }, "/credit/v2/clients/{clientId}/users/{user}/sms/sayadChequeInquiry": { "get": { "operationId": "credit_v2_clients_clientId_users_user_sms_sayadChequeInquiry_get_sms_get", "summary": "استعلام چک صیاد (پیامکی)", "description": "\nسرویس «استعلام چک صیاد (پیامکی)» (Sayad / SMS/OTP) در دسته چک صیادی (Sayad) فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با دریافت شماره چک صیادی و اطلاعات دریافت کننده ی چک ،امکان استعلام چک را فراهم می نماید.\n\n**Scope:** `credit:sms-sayady-cheque-inquiry:get`
\n\n**Grant type:** authorization_sms", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "name": "sayadId", "in": "query", "required": true, "description": "Sayad cheque ID (شناسه صیاد)", "schema": { "type": "string" } }, { "name": "idCode", "in": "query", "required": true, "description": "National ID or Sayad ID (شناسه ملی یا صیاد)", "schema": { "type": "string" } }, { "name": "shahabId", "in": "query", "required": false, "description": "Shahab ID (شناسه شهاب)", "schema": { "type": "string" } }, { "name": "idType", "in": "query", "required": false, "description": "ID type (نوع شناسه)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_sms_sayadChequeInquiry_get_sms_getResponse" }, "example": { "trackId": "7113b244-3c01-44f1-b395-e3ab464cfeaa", "result": { "message": "استعلام چک با موفقیت انجام شد", "referenceId": "25161234064321", "sayadId": "0000000000000000", "branchCode": "5502227", "bankCode": "57", "amount": 100000, "dueDate": "14001027", "description": "تست ", "serialNo": "283331", "seriesNo": "9999", "fromIban": "IR550770000000104272127001", "reason": "POSA", "currency": 1, "chequeStatus": 1, "chequeType": 1, "chequeMedia": 1, "blockStatus": 0, "guaranteeStatus": 1, "locked": 0, "holders": [ { "idCode": "0050000039", "idType": 1, "name": "چارلز بوکوفسکی" } ], "signers": [ { "name": "آلبرکامو", "legalStamp": 0 } ], "lockerBankCode": "", "lockerBranchCode": "", "issueDate": "14001025143237", "toIban": null }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/users/{user}/sms/sayadIssuerInquiryCheque": { "post": { "operationId": "credit_v2_clients_clientId_users_user_sms_sayadIssuerInquiryCheque_post_inquiry_", "summary": "استعلام چک صیاد توسط صادرکننده (پیامکی)", "description": "\nسرویس «استعلام چک صیاد توسط صادرکننده (پیامکی)» (Sayad / SMS/OTP) در دسته چک صیادی (Sayad) فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا استفاده از این سرویس صادرکننده چک می تواند اطلاعات چک را دریافت نماید\n\n**Scope:** `credit:sms-sayad-issuer-inquiry-cheque:post`
\n\n**Grant type:** authorization_sms", "tags": [ "سرویس های چک صیادی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "user", "in": "path", "required": true, "description": "User national ID (کد ملی کاربر)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit_v2_clients_clientId_users_user_sms_sayadIssuerInquiryCheque_post_inquiry_Response" }, "example": { "trackId": "7113b244-3c01-44f1-b395-e3ab464cfeaa", "result": { "referenceId": "11111111111111", "inquiryResult": { "sayadId": "5000000000000000", "branchCode": "0000000", "bankCode": "62", "amount": 0, "dueDate": "00000000", "description": " جهت تست سرویس ", "serialNo": "000000", "seriesNo": "0000", "fromIban": "IR000000000000000000000000", "reason": null, "currency": 1, "chequeStatus": 1, "chequeType": 1, "chequeMedia": 1, "blockStatus": 0, "guaranteeStatus": 1, "locked": 0, "receivers": [ { "idCode": "0000000000", "idType": 1, "name": "چارلز دیکنز" } ], "issueDate": "14001218095015" } }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sayadId": { "type": "string", "example": "5000000000000000", "description": "شناسه صیاد چک" }, "callerBranchCode": { "type": "string", "example": "8000", "description": "در صورتی که از درون شعبه اجرا می‌شود نام کاربری کاربر بانک در غیر این صورت نیازی به پر کردن نیست ," }, "customerAuthStatus": { "type": "string", "example": "1", "description": "سرویس های سامانه پیچک می بایست پس از احراز هویت در اختیار مشتری قرار گیرد." }, "idCode": { "type": "string", "example": "0000000000", "description": "کد شناسایی" }, "shahabId": { "type": "string", "example": "0000000000000000", "description": "کد شهاب" }, "idType": { "type": "string", "example": "1", "description": "نوع کد شناسایی با ملاحظات زیر" } }, "required": [ "sayadId", "customerAuthStatus", "idCode", "shahabId", "idType" ] }, "example": { "sayadId": "5000000000000000", "callerBranchCode": "8000", "customerAuthStatus": "1", "idCode": "0000000000", "shahabId": "0000000000000000", "idType": "1" } } } } } }, "/credit/v2/clients/{clientId}/assessmentSubmit/json": { "post": { "operationId": "credit_v2_clients_clientId_assessmentSubmit_json_post_submit_post", "summary": "گزارش اعتباری (مرحله ۱) — ثبت درخواست JSON", "description": "\nسرویس «گزارش اعتباری (مرحله ۱) — ثبت درخواست JSON» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. با رویکرد Authorization_SMS قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا کد ملی و شماره موبایل، درخواست گزارش اعتباری با خروجی JSON ثبت می‌شود. سطح گزارش (پایه / استاندارد / پیشرفته) را کلاینت انتخاب نمی‌کند؛ بالاترین سطح مجاز برای مشتری انتخاب می‌شود.\n\nقبل از ثبت، تطبیق شاهکار انجام می‌شود. اگر شماره موبایل متعلق به این کد ملی نباشد، پاسخ `400` برمی‌گردد.\n\nپردازش ناهمگام است. پاسخ شامل `assessmentId` است. برای دریافت نتیجه از [دریافت گزارش](/operations/credit-v2-clients-client-id-assessment-inquiry-get-inquiry-get) استفاده کنید؛ نوع خروجی همان JSON ثبت‌شده در این مرحله است.\n\n**Scope:** `credit:assessment-submit-json:post`
\n\n**Grant type:** authorization_sms", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "nationalCode", "mobileNumber" ], "properties": { "nationalCode": { "type": "string", "description": "کد ملی شخص حقیقی (۱۰ رقم)", "example": "0012345678" }, "mobileNumber": { "type": "string", "description": "شماره موبایل متعلق به همان کد ملی (۰۹xxxxxxxxx)", "example": "09121234567" } } }, "example": { "nationalCode": "0012345678", "mobileNumber": "09121234567" } } } }, "responses": { "200": { "description": "درخواست ثبت شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentSubmitResponse" }, "examples": { "created": { "summary": "درخواست جدید", "value": { "responseCode": "FN-CTFH-20003800000", "assessmentId": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f" } } } } } }, "400": { "description": "ورودی نامعتبر یا عدم تطبیق موبایل و کد ملی", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "status": "FAILED", "error": { "message": "این شماره موبایل متعلق به این کدملی نیست" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/assessmentSubmit/pdf": { "post": { "operationId": "credit_v2_clients_clientId_assessmentSubmit_pdf_post_submit_post", "summary": "گزارش اعتباری (مرحله ۱) — ثبت درخواست PDF", "description": "\nسرویس «گزارش اعتباری (مرحله ۱) — ثبت درخواست PDF» در دسته تسهیلات و اعتبارسنجی فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. با رویکرد Authorization_SMS قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا کد ملی و شماره موبایل، درخواست گزارش اعتباری با خروجی PDF ثبت می‌شود. سطح گزارش (پایه / استاندارد / پیشرفته) را کلاینت انتخاب نمی‌کند؛ بالاترین سطح مجاز برای مشتری انتخاب می‌شود.\n\nقبل از ثبت، تطبیق شاهکار انجام می‌شود. اگر شماره موبایل متعلق به این کد ملی نباشد، پاسخ `400` برمی‌گردد.\n\nپردازش ناهمگام است. پاسخ شامل `assessmentId` است. برای دریافت نتیجه از [دریافت گزارش](/operations/credit-v2-clients-client-id-assessment-inquiry-get-inquiry-get) استفاده کنید؛ نوع خروجی همان PDF ثبت‌شده در این مرحله است.\n\n**Scope:** `credit:assessment-submit-pdf:post`
\n\n**Grant type:** authorization_sms", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "nationalCode", "mobileNumber" ], "properties": { "nationalCode": { "type": "string", "description": "کد ملی شخص حقیقی (۱۰ رقم)", "example": "0012345678" }, "mobileNumber": { "type": "string", "description": "شماره موبایل متعلق به همان کد ملی (۰۹xxxxxxxxx)", "example": "09121234567" } } }, "example": { "nationalCode": "0012345678", "mobileNumber": "09121234567" } } } }, "responses": { "200": { "description": "درخواست ثبت شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentSubmitResponse" }, "examples": { "created": { "summary": "درخواست جدید", "value": { "responseCode": "FN-CTFH-20003800000", "assessmentId": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f" } } } } } }, "400": { "description": "ورودی نامعتبر یا عدم تطبیق موبایل و کد ملی", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "status": "FAILED", "error": { "message": "این شماره موبایل متعلق به این کدملی نیست" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/ccAssessmentSubmit/json": { "post": { "operationId": "credit_v2_clients_clientId_ccAssessmentSubmit_json_post_submit_post", "x-internal": true, "summary": "گزارش اعتباری (مرحله ۱) — ثبت درخواست JSON با Client Credential", "description": "با کد ملی و شماره موبایل، درخواست گزارش اعتباری با خروجی JSON ثبت می‌شود. این نسخه با توکن Client Credential فراخوانی می‌شود.\n\nسطح گزارش (پایه / استاندارد / پیشرفته) را کلاینت انتخاب نمی‌کند؛ بالاترین سطح مجاز برای مشتری انتخاب می‌شود.\n\nقبل از ثبت، تطبیق شاهکار انجام می‌شود. اگر شماره موبایل متعلق به این کد ملی نباشد، پاسخ `400` برمی‌گردد.\n\nپردازش ناهمگام است. پاسخ شامل `assessmentId` است. نتیجه را با `GET /credit/v2/clients/{clientId}/ccAssessmentInquiry` بگیرید؛ نوع خروجی همان JSON ثبت‌شده در این مرحله است.\n\n**Scope:** `credit:cc-assessment-submit-json:post`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "nationalCode", "mobileNumber" ], "properties": { "nationalCode": { "type": "string", "description": "کد ملی شخص حقیقی (۱۰ رقم)", "example": "0012345678" }, "mobileNumber": { "type": "string", "description": "شماره موبایل متعلق به همان کد ملی (۰۹xxxxxxxxx)", "example": "09121234567" } } }, "example": { "nationalCode": "0012345678", "mobileNumber": "09121234567" } } } }, "responses": { "200": { "description": "درخواست ثبت شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentSubmitResponse" }, "examples": { "created": { "summary": "درخواست جدید", "value": { "responseCode": "FN-CTFH-20003800000", "assessmentId": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f" } } } } } }, "400": { "description": "ورودی نامعتبر یا عدم تطبیق موبایل و کد ملی", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "status": "FAILED", "error": { "message": "این شماره موبایل متعلق به این کدملی نیست" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/ccAssessmentSubmit/pdf": { "post": { "operationId": "credit_v2_clients_clientId_ccAssessmentSubmit_pdf_post_submit_post", "x-internal": true, "summary": "گزارش اعتباری (مرحله ۱) — ثبت درخواست PDF با Client Credential", "description": "با کد ملی و شماره موبایل، درخواست گزارش اعتباری با خروجی PDF ثبت می‌شود. این نسخه با توکن Client Credential فراخوانی می‌شود.\n\nسطح گزارش (پایه / استاندارد / پیشرفته) را کلاینت انتخاب نمی‌کند؛ بالاترین سطح مجاز برای مشتری انتخاب می‌شود.\n\nقبل از ثبت، تطبیق شاهکار انجام می‌شود. اگر شماره موبایل متعلق به این کد ملی نباشد، پاسخ `400` برمی‌گردد.\n\nپردازش ناهمگام است. پاسخ شامل `assessmentId` است. نتیجه را با `GET /credit/v2/clients/{clientId}/ccAssessmentInquiry` بگیرید؛ نوع خروجی همان PDF ثبت‌شده در این مرحله است.\n\n**Scope:** `credit:cc-assessment-submit-pdf:post`
\n\n**Grant type:** client_credentials", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "nationalCode", "mobileNumber" ], "properties": { "nationalCode": { "type": "string", "description": "کد ملی شخص حقیقی (۱۰ رقم)", "example": "0012345678" }, "mobileNumber": { "type": "string", "description": "شماره موبایل متعلق به همان کد ملی (۰۹xxxxxxxxx)", "example": "09121234567" } } }, "example": { "nationalCode": "0012345678", "mobileNumber": "09121234567" } } } }, "responses": { "200": { "description": "درخواست ثبت شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentSubmitResponse" }, "examples": { "created": { "summary": "درخواست جدید", "value": { "responseCode": "FN-CTFH-20003800000", "assessmentId": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f" } } } } } }, "400": { "description": "ورودی نامعتبر یا عدم تطبیق موبایل و کد ملی", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "status": "FAILED", "error": { "message": "این شماره موبایل متعلق به این کدملی نیست" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/credit/v2/clients/{clientId}/assessmentInquiry": { "get": { "operationId": "credit_v2_clients_clientId_assessmentInquiry_get_inquiry_get", "summary": "گزارش اعتباری (مرحله ۲) — دریافت نتیجه", "description": "\nسرویس «گزارش اعتباری (مرحله ۲) — دریافت نتیجه» (SMS/OTP) در دسته تسهیلات و اعتبارسنجی فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا `assessmentId` دریافتی از [ثبت درخواست JSON](/operations/credit-v2-clients-client-id-assessment-submit-json-post-submit-post) یا [ثبت درخواست PDF](/operations/credit-v2-clients-client-id-assessment-submit-pdf-post-submit-post) وضعیت پردازش و در صورت آماده بودن، گزارش برگردانده می‌شود.\n\nتا وقتی `status` برابر `IN_PROGRESS` است، فیلدهای خروجی گزارش وجود ندارد. چند ثانیه بعد دوباره استعلام کنید.\n\nاگر گزارش ذخیره‌شده ناقص باشد، دوباره از ابتدا گرفته می‌شود و پاسخ pending برمی‌گردد.\n\nنوع خروجی (`json` یا `pdf`) در مرحله ثبت درخواست انتخاب و ذخیره می‌شود؛ این سرویس همان مقدار را می‌خواند. وقتی `DONE` است:\n\n- `json` — بدنه گزارش در `data`\n- `pdf` — فقط `fileName` و `contentBase64` (بدون `data`)\n\n**Scope:** `credit:assessment-inquiry:get`
\n\n**Grant type:** authorization_sms\n\nبرای فراخوانی این سرویس پس از دریافت اجازه دسترسی از کاربر، با توکن Authorization SMS فراخوانی کنید.\n\n### وضعیت‌ها\n\n- `IN_PROGRESS` — در حال تهیه گزارش؛ `progress` و `stage` را ببینید\n- `DONE` — گزارش آماده است\n- `FAILED` — خطا؛ HTTP `422`", "tags": [ "استعلام تسهیلات و اعتبارسنجی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "assessmentId", "in": "query", "required": true, "description": "شناسه گزارش دریافتی از مرحله ثبت درخواست", "schema": { "type": "string" }, "example": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f" } ], "responses": { "200": { "description": "در حال پردازش یا گزارش آماده", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentInquiryResponse" }, "examples": { "pending": { "summary": "هنوز آماده نیست", "value": { "responseCode": "FN-CTFH-20003900000", "assessmentId": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f", "status": "IN_PROGRESS", "stage": "SCORE_POLL", "level": "advance", "progress": 65 } }, "done": { "summary": "گزارش آماده", "value": { "responseCode": "FN-CTFH-20003900000", "assessmentId": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f", "status": "DONE", "level": "advance", "outputType": "json", "data": { "reportInformation": { "reportLevel": "advanced", "reportLevelDescription": "پیشرفته", "reportId": "1000 0000 0000 0000 0000", "reportDate": "1405/06/17" }, "user": { "name": "علی نوروزی", "nationalCode": "6780026883", "fatherName": "حسین", "birthDate": "1374/11/28", "birthPlace": "تهران", "gender": "مرد", "maritalStatus": "مجرد", "mobile": "09121234567", "address": "ثبت نشده" }, "creditScore": { "score": "675", "risk": "A2", "riskDescription": "ریسک خیلی پایین", "minLimit": "95.2", "maxLimit": "96.9", "scoreFactorList": [ { "indicator": "تسهیلات", "description": "وام", "changeRate": "136.34", "score": "666" } ], "scoreReasonList": [ { "code": "HBC1", "description": "چک برگشتی", "order": "1" } ] }, "facilityTotalAmount": "15050988617", "facilityDebtTotalAmount": "6909253625", "facilityPastExpiredTotalAmount": "93930075" } } }, "donePdf": { "summary": "گزارش PDF آماده", "value": { "responseCode": "FN-CTFH-20003900000", "assessmentId": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f", "status": "DONE", "level": "advance", "outputType": "pdf", "fileName": "FinnotechAssessmentReport-6780026883-1405-06-17.pdf", "contentBase64": "JVBERi0xLjcK..." } } } } } }, "400": { "description": "assessmentId نامعتبر", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "گزارش پیدا نشد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "تهیه گزارش ناموفق", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/kyb/v2/clients/{clientId}/matchLegalIdWithMembers": { "get": { "operationId": "kybMatchLegalIdWithMembersGet", "summary": "تطبیق شناسه شرکت با اعضا", "description": "\nسرویس «تطبیق شناسه شرکت با اعضا» (KYB) در دسته شناخت کسب‌وکار (KYB) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه حقوقی و کد ملی، سمت فرد در شرکت و مشخصات روزنامه رسمی در خروجی نمایش داده می‌شود.\n\n**Scope:** `kyb:match-legal-id-with-members:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های شناخت کسب و کار" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalCode" }, { "name": "legalId", "in": "query", "required": true, "description": "شناسه حقوقی", "schema": { "type": "string" }, "example": "25118762226" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KybMatchLegalIdWithMembersResponse" }, "example": { "responseCode": "FN-KBIE-20000000000", "trackId": "2c122a95-1d3e-4595-moho-62b52e7b87d9", "result": { "isMatched": true, "positions": [ { "positionName": "CEO", "issueTrackingNo": "000921256803000", "rrkNewsPaperDate": "1400/01/01", "rrkNewsPaperNumber": "00900", "rrkPageNumber": "50" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyb/v2/clients/{clientId}/companyInfo": { "get": { "operationId": "kybCompanyInfoGet", "summary": "استعلام اطلاعات شرکت با شناسه ملی", "description": "\nKYB فینوتک با شناسه ملی شرکت، مشخصات ثبتی کسب‌وکار را می‌دهد. مناسب شناخت کسب‌وکار و اعتبارسنجی حقوقی.\n\n\n\nبا وارد کردن شناسه ملی شرکت، اطلاعات شرکت در خروجی برمی‌گردد.\n\n**Scope:** `kyb:company-info:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های شناخت کسب و کار" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/companyId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KybCompanyInfoResponse" }, "example": { "responseCode": "FN-KBRO-20000300000", "trackId": "5ad39615-933c-4326-a0c8-25a3706d7f2f", "result": { "companyId": 11111111111, "registrationNo": "111111", "title": "تست", "registrationDate": "2018-06-13T00:00:00", "capital": 200000000000, "address": "استان تهران - منطقه 7 ، سیدخندان ، پلاک 2 ، طبقه دوم", "postalCode": "1111111111", "status": "فعال", "registrationTypeTitle": "سهامی خاص", "persianRegistrationDate": "1397/3/23" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyb/v2/clients/{clientId}/corporateJournal": { "get": { "operationId": "kybCorporateJournalGet", "summary": "استعلام آگهی‌های روزنامه رسمی شرکت", "description": "\nسرویس «استعلام آگهی‌های روزنامه رسمی شرکت» (KYB) در دسته شناخت کسب‌وکار (KYB) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه ملی شرکت، آگهی‌های روزنامه رسمی شرکت در خروجی برمی‌گردد.\n\n**Scope:** `kyb:corporate-journal:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های شناخت کسب و کار" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/companyId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KybCorporateJournalGetResponse" }, "example": { "responseCode": "FN-KBRO-20000400000", "trackId": "a6fd38c4-253a-461d-a47d-af3ad4200a6a", "result": [ { "newsId": 11111111, "title": 11111111111, "description": "نمونه", "companyId": 25118762226, "capitalTo": 100000000, "newspaperDate": "2018-12-08T00:00:00", "newsletterDate": "2018-06-13T00:00:00", "newspaperNumber": "21477", "newspaperCity": "تهران", "pageNumber": 2, "indicatorNumber": "111111100111111111" } ], "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyb/v2/clients/{clientId}/boardMembers": { "get": { "operationId": "kybBoardMembersGet", "summary": "استعلام اعضای هیئت مدیره", "description": "\nسرویس «استعلام اعضای هیئت مدیره» (KYB) در دسته شناخت کسب‌وکار (KYB) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه ملی شرکت، اعضای هیئت مدیره و سهامداران در خروجی برمی‌گردد.\n\n**Scope:** `kyb:board-members:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های شناخت کسب و کار" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/companyId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KybBoardMembersResponse" }, "example": { "responseCode": "FN-KBIE-20000100000", "trackId": "2c122a95-62b52e7b87d9", "result": { "boardMembers": [ { "nationalId": "0074232995", "firstName": "سارا", "lastName": "صالحي", "roleCode": 1, "roleName": "عضو اصلي هيئت مديره" } ], "shareHolders": [ { "nationalId": "0057852199", "firstName": "کبری", "lastName": "صالحي", "percentage": 71.5 } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyb/v2/clients/{clientId}/enamadInquiry": { "get": { "operationId": "kybEnamadInquiryGet", "summary": "استعلام اینماد", "description": "\nسرویس «استعلام اینماد» (KYB) در دسته شناخت کسب‌وکار (KYB) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن نام شرکت و آدرس وب‌سایت، اطلاعات گواهینامه اینماد شامل تاریخ ثبت و تاریخ انقضا برگردانده می‌شود.\n\n**Scope:** `kyb:enamad-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های شناخت کسب و کار" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "companyName", "in": "query", "required": true, "description": "نام شرکت", "schema": { "type": "string" }, "example": "فین و تک پارس" }, { "name": "website", "in": "query", "required": true, "description": "آدرس وبسایت شرکت", "schema": { "type": "string" }, "example": "www.finnotech.ir" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KybEnamadInquiryResponse" }, "example": { "responseCode": "FN-KBJT-20000600000", "trackId": "abee0f-6c9e-fe88d-5a0", "result": { "licenseHolder": "فین و تک پارس", "registeredDate": "1401/04/01", "expirationDate": "1405/04/01" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyb/v2/clients/{clientId}/companyLicenses": { "get": { "operationId": "kybCompanyLicensesGet", "summary": "استعلام مجوزهای شرکت", "description": "\nسرویس «استعلام مجوزهای شرکت» (KYB) در دسته شناخت کسب‌وکار (KYB) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه ملی شرکت، لیست مجوزهای شرکت شامل اینماد، دانش‌بنیان، مجوز.آی‌آر، تولید و سایر مجوزها در خروجی برمی‌گردد.\n\n**Scope:** `kyb:company-licenses:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های شناخت کسب و کار" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/companyId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KybCompanyLicensesResponse" }, "example": { "responseCode": "FN-KBFH-20000700000", "trackId": "trackID", "result": { "enamadLicenses": [ { "type": "Enamad", "title": "اینماد", "rawType": "ای‌نماد", "status": "فعال", "isActive": true, "certificateNumber": "123", "issueDate": "2022-08-15T00:00:00", "expireDate": "2028-08-15T00:00:00", "issuer": "مركز توسعه تجارت الكترونیكی", "issuerDivision": "توسعه تجارت الکترونیکی", "category": "Website", "website": "example.ir", "categoryId": 111111, "certificateIssuerId": 10, "certificateTypeTitle": "ای‌نماد", "isLatestForType": true } ], "knowledgeBasedLicenses": [ { "type": "KnowledgeBased", "title": "دانش‌بنیان", "rawType": "نوآور", "status": "فعال", "isActive": true, "certificateNumber": "12", "issueDate": "2024-11-20T00:00:00", "expireDate": null, "issuer": "معاونت علمی ریاست جمهوری", "issuerDivision": "کارگروه شرکت‌های دانش‌بنیان", "category": "فناوری اطلاعات و ارتباطات و نرم‌افزارهای رایانه‌ای", "website": null, "categoryId": 222222, "certificateIssuerId": 20, "certificateTypeTitle": "نوآور", "isLatestForType": true } ], "licenseIrLicenses": [ { "type": "LicenseIr", "title": "مجوز.آی‌آر", "rawType": "مجوز فعالیت در حوزه فناوری اطلاعات و ارتباطات (شخص حقوقی)", "status": "معتبر", "isActive": true, "certificateNumber": "11111111", "issueDate": "2025-12-01T00:00:00", "expireDate": "2026-12-01T00:00:00", "issuer": "درگاه ملی مجوزهای کشور", "issuerDivision": "سازمان نظام صنفی رایانه‌ای کشور - سازمان نظام صنفی رایانه‌ای استان", "category": "درگاه ملی مجوزهای کشور", "website": "qr.mojavez.ir/track/11111111", "categoryId": 333333, "certificateIssuerId": 30, "certificateTypeTitle": "مجوز فعالیت در حوزه فناوری اطلاعات و ارتباطات (شخص حقوقی)", "isLatestForType": true } ], "productionLicenses": [], "otherLicenses": [ { "type": "Other", "title": "پیمانکار", "rawType": "پیمانکار", "status": "منقضی", "isActive": false, "certificateNumber": "22222", "issueDate": "2022-02-01T00:00:00", "expireDate": "2024-02-01T00:00:00", "issuer": "سازمان برنامه و بودجه", "issuerDivision": "دبیرخانه شورای عالی انفورماتیک کشور", "category": "انفورماتیک", "website": null, "categoryId": 444444, "certificateIssuerId": 40, "certificateTypeTitle": "پیمانکار", "isLatestForType": false } ], "totalLicenses": 4 }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "responseCode": "FN-KBFH-40000740655", "trackId": "trackID", "status": "FAILED", "error": { "code": "ERR_BAD_REQUEST", "message": "شناسه شرکت نامعتبر است" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyb/v2/clients/{clientId}/authorizedSignatories": { "get": { "operationId": "kybAuthorizedSignatoriesGet", "summary": "استعلام صاحبان امضا", "description": "\nسرویس «استعلام صاحبان امضا» (KYB) در دسته شناخت کسب‌وکار (KYB) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شناسه ملی شرکت، لیست دارندگان حق امضا در خروجی برمی‌گردد.\n\n**Scope:** `kyb:authorized-signatories:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های شناخت کسب و کار" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/companyId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KybAuthorizedSignatoriesResponse" }, "example": { "responseCode": "FN-KBPM-20000200000", "trackId": "a6fd38c4-253a-461d-a47d-af3ad4200a6a", "result": { "newsId": "11111111", "signatureItemFullText": "کلیه اسناد و اوراق بهادار...", "newspaperDate": "2023-12-14T00:00:00", "companyTitle": "فین و تک پارس", "signholdersStatus": { "obligatorySignature": { "holders": [], "relationships": [] }, "normalSignature": { "holders": [], "relationships": [] } } }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyb/v2/clients/{clientId}/corporateJournal/submit": { "post": { "operationId": "kybCorporateJournalSubmit", "summary": "احراز امضاء روزنامه رسمی (مرحله ۱) — ثبت درخواست", "description": "\nسرویس «احراز امضاء روزنامه رسمی (مرحله ۱) — ثبت درخواست» (KYB) در دسته شناخت کسب‌وکار (KYB) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nدرخواست احراز امضای روزنامه رسمی را به‌صورت ناهمگام ثبت می‌کند: دادهٔ روزنامه رسمی دریافت می‌شود، قواعد صاحبان امضا استخراج و امضاکنندگان ارسالی صحت‌سنجی می‌شوند. پاسخ اولیه با `status: PENDING` است؛ نتیجه را با [سرویس دریافت نتیجه (مرحله ۲)](#/operations/kybCorporateJournalInquiry) پیگیری کنید.\n\n**Scope:** `kyb:corporate-journal-submit:post`
\n\n**Grant type:** client_credentials\n\n### مراحل فراخوانی\n\n1. ثبت درخواست احراز امضاء (این سرویس)\n2. [دریافت نتیجه (مرحله ۲)](#/operations/kybCorporateJournalInquiry)\n\n### Signer business rules\n\n| documentType | conditions | Required signers |\n| --- | --- | --- |\n| `administrative` | `normal` | CEO only |\n| `administrative` | `absence of CEO` | Chairman of the Board + Board Member |\n| `financial` | `normal` | CEO + Chairman of the Board (joint) |\n| `financial` | `absence of CEO` | Chairman of the Board + Board Member (joint) |\n\n`requestId` acts as an idempotency key. Re-submitting the same `requestId` returns\nthe existing status without enqueueing a duplicate job.\n", "tags": [ "سرویس های شناخت کسب و کار" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorporateJournalSubmitRequest" }, "examples": { "financialNormal": { "summary": "Financial document — CEO present", "value": { "requestId": "req-003", "companyId": "14007651115", "documentType": "financial", "conditions": "normal", "signers": [ { "nationalId": "0451448413" }, { "nationalId": "1377522441" } ] } }, "administrativeNormal": { "summary": "Administrative document — CEO only", "value": { "requestId": "req-001", "companyId": "14007651115", "documentType": "administrative", "conditions": "normal", "signers": [ { "nationalId": "0451448413" } ] } } } } } }, "responses": { "202": { "description": "Job accepted and queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorporateJournalSubmitResponse" } } } }, "400": { "description": "Invalid request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/kyb/v2/clients/{clientId}/corporateJournal/inquiry": { "post": { "operationId": "kybCorporateJournalInquiry", "summary": "احراز امضاء روزنامه رسمی (مرحله ۲) — دریافت نتیجه", "description": "\nسرویس «احراز امضاء روزنامه رسمی (مرحله ۲) — دریافت نتیجه» (KYB) در دسته شناخت کسب‌وکار (KYB) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nوضعیت پردازش درخواست احراز امضای روزنامه رسمی را برمی‌گرداند و در صورت اتمام، نتیجهٔ صحت‌سنجی امضا را شامل می‌شود. ورودی: `requestId` از مرحله [ثبت درخواست](#/operations/kybCorporateJournalSubmit). وضعیت‌ها: `PENDING`، `PROCESSING`، `COMPLETED`، `FAILED`. نتیجه تا ۲۴ ساعت پس از اتمام نگه داشته می‌شود.\n\n**Scope:** `kyb:corporate-journal-inquiry:post`
\n\n**Grant type:** client_credentials\n\n### مراحل فراخوانی\n\n1. [ثبت درخواست احراز امضاء (مرحله ۱)](#/operations/kybCorporateJournalSubmit)\n2. دریافت نتیجه (این سرویس)\n\n### Status values\n\n| status | Meaning |\n| --- | --- |\n| `PENDING` | Queued, not yet picked up |\n| `PROCESSING` | Worker is running the pipeline |\n| `COMPLETED` | Finished — inspect `result.valid` for the business outcome |\n| `FAILED` | Pipeline or upstream error |\n\n**Important:** `result.valid === false` is **not** a service error. It means\nverification completed and the submitted signers do not satisfy the gazette rule.\n\nResults are retained for **24 hours** after completion.\n", "tags": [ "سرویس های شناخت کسب و کار" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorporateJournalInquiryRequest" }, "example": { "requestId": "req-003" } } } }, "responses": { "200": { "description": "Inquiry status (may still be processing)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorporateJournalInquiryResponse" }, "examples": { "processing": { "summary": "Still processing", "value": { "responseCode": "FN-KBRO-20000400001", "trackId": "1e3bb70f-f558-4ef8-8368-68d3ca8bcdb9", "requestId": "req-003", "status": "PROCESSING" } }, "completedValid": { "summary": "Completed — verification passed", "value": { "responseCode": "FN-KBRO-20000400000", "trackId": "1e3bb70f-f558-4ef8-8368-68d3ca8bcdb9", "requestId": "req-003", "status": "COMPLETED", "result": { "valid": true, "companyId": "14007651115", "companyName": "فین و تک پارس", "matchingRule": { "documentType": "financial", "conditions": "normal", "signatories": [ "CEO", "Chairman of the Board" ], "signatureMode": "joint", "requiresSeal": true, "expirationDate": "1405/06/28" }, "verifiedSigners": [ { "name": null, "role": "CEO", "nationalId": "0451448413" }, { "name": null, "role": "Chairman of the Board", "nationalId": "1377522441" } ], "verificationDetails": { "allRequiredPresent": true, "allSignersValid": true, "ruleNotExpired": true, "conditionsMatch": true } } } }, "completedInvalid": { "summary": "Completed — verification failed (business outcome)", "value": { "responseCode": "FN-KBRO-20000400000", "trackId": "1e3bb70f-f558-4ef8-8368-68d3ca8bcdb9", "requestId": "req-003", "status": "COMPLETED", "result": { "valid": false, "companyId": "14007651115", "companyName": "فین و تک پارس", "matchingRule": { "documentType": "financial", "conditions": "normal", "signatories": [ "CEO", "Chairman of the Board" ], "signatureMode": "joint", "requiresSeal": true, "expirationDate": "1405/06/28" }, "verifiedSigners": [ { "name": null, "role": "CEO", "nationalId": "0451448413" } ], "verificationDetails": { "allRequiredPresent": false, "allSignersValid": false, "ruleNotExpired": true, "conditionsMatch": true }, "missingSigners": { "requiredRoles": [ "Chairman of the Board" ], "message": "Missing required signers for roles: Chairman of the Board" }, "unverifiedSigners": [ { "name": null, "reason": "Not found in authorized signatories" } ] } } }, "failed": { "summary": "Pipeline failure", "value": { "responseCode": "FN-KBRO-50200400001", "trackId": "d0f61173-1d9d-4aac-a4a4-3238eb3d9e06", "requestId": "req-003", "status": "FAILED", "error": { "code": "50200400001", "message": "خطا در پردازش درخواست" } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Unknown or expired requestId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorporateJournalInquiryResponse" }, "example": { "responseCode": "FN-KBRO-40400400001", "trackId": "d0f61173-1d9d-4aac-a4a4-3238eb3d9e06", "requestId": "req-003", "status": "FAILED", "error": { "code": "40400400001", "message": "شناسه درخواست یافت نشد" } } } } } } } }, "/dev/v2/oauth2/token": { "post": { "operationId": "boomrangGetClientCredentialToken", "summary": "گرفتن توکن Client Credential فینوتک", "description": "\nبا این سرویس توکن OAuth2 فینوتک را با رویکرد Client Credential می‌گیرید؛ نیازی به رضایت کاربر بیرونی نیست و برای سرویس‌های غیرحسابی مناسب است.\n\n\n\nاز این سرویس برای تولید توکن با رویکرد `Client_Credential` استفاده کنید. از آنجا که این سرویس به منابع (resource) خود کلاینت نیاز دارد، احتیاجی به دریافت اجازه دسترسی از کاربر بیرونی نخواهد بود.\n\n**Grant type:** `client_credentials`\n\n[دانلود مستندات ریسپانس کدها](https://console.finnotech.ir) — response-code-token-cc\n\n```\nPOST /dev/v2/oauth2/token\n```\n\n### Headers\n\nمقادیر زیر باید در هدر قرار بگیرد:\n\n```\nContent-Type: application/json\nAuthorization: Basic {AuthenticationString}\n```\n\nمقدار `AuthenticationString` باید برابر Base64 از اطلاعات برنامه شما به صورت `YOURCLIENTID:YOURCLIENTSECRET` باشد. برای مثال اگر شناسه برنامه شما برابر `firstapp` باشد و رمز برنامه شما که در قسمت جزییات برنامه در کنسول قابل مشاهده است برابر `6932dddb927b76e54997` باشد، شما باید Base64 مقدار `firstapp:6932dddb927b76e54997` را تولید کنید. در این صورت مقدار این هدر باید برابر مقدار زیر قرار گیرد:\n\n```\nBasic Zmlyc3RhcHA6NjkzMmRkZGI5MjdiNzZlNTQ5OTc=\n```\n\n### Notes\n\nفرستادن تمام پارامترهای Body الزامی است.\n\nبرای بانک‌های پارسیان، تجارت و رفاه فیلدهای bank و additionalInfo لازم است.\n", "tags": [ "توکن" ], "x-seo-slug": "issue-token", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCredentialTokenRequest" }, "examples": { "default": { "summary": "درخواست استاندارد", "value": { "grant_type": "client_credentials", "nid": "0123456789", "scopes": "oak:deposit-to-iban:get" } }, "parsian": { "summary": "بانک پارسیان", "value": { "grant_type": "client_credentials", "nid": "0100000009", "scopes": "oak:cc-transfer-to:execute", "bank": "054", "additionalInfo": { "deposit": "20101007005004", "cif": "00700600", "username": "00010050060060000", "password": "006000a0-9002-400c-moho-9c0090050010" } } }, "tejarat": { "summary": "بانک تجارت", "value": { "grant_type": "client_credentials", "nid": "0100000009", "scopes": "oak:cc-transfer-to:execute", "bank": "018", "additionalInfo": { "deposit": "20101007005004", "apikey": "ZGU0Zjg1ZmU3NTNkZTZlOWViY2EyMGZjMDYxMjY1MjBjMjdkYTc" } } }, "refah": { "summary": "بانک رفاه", "value": { "grant_type": "client_credentials", "nid": "0100000009", "scopes": "oak:cc-transfer-to:execute", "bank": "013", "additionalInfo": { "deposit": "402738000", "firstPassword": "fhdsk2932", "secondPassword": "fhdsak837fr", "username": "09800000000" } } } } } } }, "responses": { "200": { "description": "توکن با موفقیت صادر شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCredentialTokenResponse" }, "example": { "responseCode": "FN-BRFH-20000000000", "result": { "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "scopes": [ "oak:deposit-to-iban:get" ], "lifeTime": 86400000, "creationDate": "14031009094910", "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "_id": "5fa0aced-84e5-441b-b8c2-531757c99cfb" }, "status": "DONE" } } } }, "401": { "description": "احراز هویت ناموفق", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/dev/v2/oauth2/authorize": { "get": { "operationId": "boomrangSmsStep1Authorize", "summary": "توکن پیامکی:مرحله ۱: درخواست احراز هویت", "description": "\nسرویس «مرحله ۱: درخواست احراز هویت» (KYC / SMS/OTP) در دسته توکن Authorization Code پیامکی (OAuth2 SMS) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی پس از رضایت کاربر با رویکرد Authorization Code است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاز این سرویس برای تولید توکن با رویکرد `Authorization_Code_Type_SMS` استفاده کنید (اشخاص حقیقی و حقوقی). سرویس‌هایی که از این نوع توکن استفاده می‌کنند نیاز به منابع سایر کاربران دارند و باید اجازه‌ی دسترسی از کاربر گرفته شود.\n\n**سرویس‌های وابسته:**\n- [مرحله ۲: تایید درخواست احراز هویت](#/operations/boomrangSmsStep2Verify)\n- [مرحله ۳: درخواست توکن](#/operations/boomrangSmsStep3Token)\n\nاولین قدم برای استفاده از این سرویس‌ها درخواست احراز هویت از کاربر است؛ به این معنی که کاربر به برنامه‌ی شما اجازه فراخوانی سرویس‌ها را بدهد. به این منظور باید درخواست احراز هویت را به شماره موبایلی که این مجوز را صادر می‌کند بفرستید.\n\n[دانلود مستندات ریسپانس کدها](https://console.finnotech.ir) — response-code-token-sms\n\n```\nGET /dev/v2/oauth2/authorize?client_id={client_id}&response_type=code&redirect_uri={redirect_uri}&scope={scope}&mobile={mobile}&state={state}&auth_type=SMS\n```\n\n### Headers\n\nمقادیر زیر باید در هدر قرار بگیرد:\n\n```\nContent-Type: application/json\nAuthorization: Basic {AuthenticationString}\n```\n\nمقدار `AuthenticationString` باید برابر Base64 از اطلاعات برنامه شما به صورت `YOURCLIENTID:YOURCLIENTSECRET` باشد. برای مثال اگر شناسه برنامه شما برابر `firstapp` باشد و رمز برنامه شما که در قسمت جزییات برنامه در کنسول قابل مشاهده است برابر `6932dddb927b76e54997` باشد، شما باید Base64 مقدار `firstapp:6932dddb927b76e54997` را تولید کنید. در این صورت مقدار این هدر باید برابر مقدار زیر قرار گیرد:\n\n```\nBasic Zmlyc3RhcHA6NjkzMmRkZGI5MjdiNzZlNTQ5OTc=\n```\n\n### مثال\n\n```\nhttps://api.finnotech.ir/dev/v2/oauth2/authorize?client_id=smokey&response_type=code&redirect_uri=https://localhost/&scope=credit:sms-advance-reliability:get&mobile=09300000000&state=15467287&auth_type=SMS\n```\n\nدر صورتی که پارامترها به درستی مشخص شوند، پیامکی برای شماره موبایل درج‌شده ارسال خواهد شد. در صورت تمایل به اعطای دسترسی، کد OTP دریافتی در پیامک را در [مرحله ۲](#/operations/boomrangSmsStep2Verify) وارد کنید. همچنین `trackId` دریافتی در این مرحله برای مرحله بعد لازم است.\n\n
\n\n

تذکر

\n\n

برای گرفتن توکن کشاورزی مقادیر زیر الزامی است:

\n\n

nid: کد ملی صاحب امضا حساب معرفی شده به بانک

\n

deposit: حساب معرفی شده به بانک

\n

bank: کد بانک‌های فعال با توکن اس‌ام‌اسی — کشاورزی: 016

\n\n

در صورت استفاده از سرویس انتقال وجه مقادیر زیر الزامی است:

\n\n

limit: حداکثر مبلغ هر تراکنش به ریال

\n

count: حداکثر تعداد تراکنش ماهانه به ازای یک توکن

\n\n
\n", "tags": [ "توکن" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "client_id", "in": "query", "required": true, "description": "شناسه ثبت‌شده برای کلاینت در سامانه فینوتک", "schema": { "type": "string" }, "example": "smokey" }, { "name": "redirect_uri", "in": "query", "required": true, "description": "آدرس بازگشتی کلاینت؛ دامنه این آدرس باید با دامنه ثبت‌شده به ازای آدرس بازگشتی کلاینت در فینوتک برابر باشد.\nآدرسی که در این قسمت فرستاده می‌شود باید با آدرس بازگشتی ارسال‌شده در مرحله دریافت توکن برابر باشد.\n", "schema": { "type": "string", "format": "uri" }, "example": "https://localhost/" }, { "name": "scope", "in": "query", "required": true, "description": "اسکوپ (دسترسی)هایی که کاربر باید مجوز دسترسی به آن‌ها را بدهد، به صورت جدا‌شونده با کاما انگلیسی (comma separated).\nتنها اسکوپ‌هایی که تایپ توکن آن‌ها از نوع sms است در اینجا قابل استفاده‌اند.\nاسکوپ‌های با دسته‌بندی متفاوت نمی‌توانند باهم ارسال شوند.\n", "schema": { "type": "string" }, "example": "credit:sms-advance-reliability:get" }, { "name": "response_type", "in": "query", "required": true, "description": "نوع پاسخ که باید برابر code باشد", "schema": { "type": "string", "enum": [ "code" ] } }, { "name": "mobile", "in": "query", "required": true, "description": "شماره موبایلی که کد احراز هویت به منظور تایید دسترسی برای سرویس مورد نظر به آن ارسال خواهد شد", "schema": { "type": "string" }, "example": "09300000000" }, { "name": "state", "in": "query", "required": false, "description": "(اختیاری) این کد برای ردگیری درخواست توسط کلاینت استفاده می‌شود و در صورت ارسال به همراه کد به آدرس بازگشتی کلاینت برگردانده می‌شود", "schema": { "type": "string" }, "example": "15467287" }, { "name": "auth_type", "in": "query", "required": true, "description": "نوع احراز هویت (sms)", "schema": { "type": "string", "enum": [ "SMS" ] } } ], "responses": { "200": { "description": "پیامک OTP ارسال شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsAuthorizeResponse" }, "example": { "result": { "smsSent": true, "trackId": "3c35adb9-0164-4b5jjj6-9259-70022cff51e9" }, "status": "DONE" } } } }, "401": { "description": "احراز هویت ناموفق", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/dev/v2/oauth2/verify/sms": { "post": { "operationId": "boomrangSmsStep2Verify", "summary": "توکن پیامکی:مرحله ۲: تایید احراز هویت", "description": "\nسرویس «مرحله ۲: تایید احراز هویت» (KYC / SMS/OTP) در دسته توکن Authorization Code پیامکی (OAuth2 SMS) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. جزئیات Grant type در ادامه آمده است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا در دست داشتن کد ارسالی و شماره `trackId` [مرحله ۱](#/operations/boomrangSmsStep1Authorize)، احراز هویت را تایید کنید.\n`code` برگشتی در [مرحله ۳](#/operations/boomrangSmsStep3Token) استفاده می‌شود.\n\n```\nPOST /dev/v2/oauth2/verify/sms\n```\n\n**مهلت:** ۳ دقیقه پس از ارسال پیامک.\n\n
\n\n

تذکر — توکن حقوقی

\n\n

برای صدور توکن حقوقی، فیلد legalId (شناسه حقوقی) را در body ارسال کنید.

\n\n

توکن‌هایی که در آنها از فیلد legalId استفاده می‌شود، فقط قابل استفاده برای فراخوانی‌های حقوقی می‌باشند.

\n\n
\n", "tags": [ "توکن" ], "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsVerifyRequest" }, "examples": { "natural": { "summary": "حقیقی", "value": { "mobile": "09300000000", "otp": "qMeQs", "nid": "0011674144", "trackId": "3c35adb9-0164-4b5jjj6-9259-70022cff51e9" } }, "legal": { "summary": "حقوقی (با legalId)", "value": { "mobile": "09300000000", "otp": "qMeQs", "nid": "0011674144", "trackId": "3c35adb9-0164-4b5jjj6-moho-70022cff51e9", "legalId": "10001110010" } } } } } }, "responses": { "200": { "description": "احراز هویت تایید شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsVerifyResponse" }, "example": { "result": { "code": "BOmYeUWF1Ixx8kdL" }, "status": "DONE" } } } }, "400": { "description": "OTP یا موبایل نامعتبر / منقضی", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalidOtp": { "value": { "status": "FAILED", "error": { "code": "VALIDATION_ERROR", "message": "invalid otp or mobile" } } }, "expired": { "value": { "status": "FAILED", "error": { "code": "VALIDATION_ERROR", "message": "Expiration time is exceeded" } } } } } } }, "401": { "description": "احراز هویت ناموفق", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/dev/v2/oauth2/token/sms": { "post": { "operationId": "boomrangSmsStep3Token", "summary": "توکن پیامکی: مرحله ۳: درخواست توکن", "description": "\nسرویس «مرحله ۳: درخواست توکن» (SMS/OTP) در دسته توکن Authorization Code پیامکی (OAuth2 SMS) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی پس از رضایت کاربر با رویکرد Authorization Code است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nپس از دریافت `code` از [مرحله ۲](#/operations/boomrangSmsStep2Verify)، سرویس درخواست توکن را فراخوانی کنید.\n\n**آدرس API:**\n\n```\nPOST /dev/v2/oauth2/token\n```\n\n**Grant type:** `authorization_code` · **auth_type:** `SMS`\n\n### Headers\n\nمقادیر زیر باید در هدر قرار بگیرد:\n\n```\nContent-Type: application/json\nAuthorization: Basic {AuthenticationString}\n```\n\nمقدار `AuthenticationString` باید برابر Base64 از اطلاعات برنامه شما به صورت `YOURCLIENTID:YOURCLIENTSECRET` باشد.\n\n```\nBasic Zmlyc3RhcHA6NjkzMmRkZGI5MjdiNzZlNTQ5OTc=\n```\n\n### Notes\n\nفرستادن تمام پارامترهای Body الزامی است.\n\n**نکته مهم:** تمامی مقادیر دریافت‌شده در پاسخ این سرویس را ذخیره کنید. کد ملی و اسکوپ‌ها برای فراخوانی سرویس‌ها و تاریخ ایجاد و عمر توکن برای کنترل زمان انقضای توکن مورد نیاز هستند.\n\n`redirect_uri` باید با آدرس بازگشتی ارسال‌شده در [مرحله ۱](#/operations/boomrangSmsStep1Authorize) برابر باشد.\n\nبرای گرفتن توکن کشاورزی فیلد bank الزامی است.\n", "tags": [ "توکن" ], "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsAuthorizationCodeTokenRequest" }, "example": { "grant_type": "authorization_code", "code": "qPhxlaT1nUjWQqOu", "auth_type": "SMS", "redirect_uri": "https://localhost/" } } } }, "responses": { "200": { "description": "توکن صادر شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsAuthorizationCodeTokenResponse" }, "examples": { "natural": { "summary": "پاسخ حقیقی", "value": { "result": { "clientId": "smokey", "scopes": [ "credit:sms-advance-reliability:get" ], "deposits": [], "lifeTime": 864000000, "bank": "", "type": "CODE", "creationDate": "13980412134609", "userId": "0012674044", "maxAmountPerTransaction": 0, "monthlyCallLimitation": 0, "auth_type": "SMS", "refreshToken": "PFCiLr12XXoWLltniE3hmppE0TjYcGcctmrgJF3Xz94xmd6C3ACs8HhZYSnbUMOd67FqD2GbAadtvw8JYEwh8iWhYSrU0GYMc12aeWbKdU06KSRiqLjqgykOgm8ZjNGicB2F1ODKErSx1qD336EA42aW9Z0FNBiIVn1JrDYhjo0HQZBj4rqCE3KiJmrl61sofvsjX92bVnexdv5JaVADQW1RcFNc2gIeIryh0CqQpKBlfQDUqcpy7uQItzkAHaqi", "value": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." }, "status": "DONE" } }, "legal": { "summary": "پاسخ حقوقی", "value": { "result": { "tokenId": "90JP4S3l5scGZmYwrOM5C2GynyNvMOHO", "clientId": "moho", "scopes": [ "credit:sms-back-cheques:get" ], "lifeTime": 864000000, "type": "CODE", "creationDate": "14030619133657", "userId": "1234567890", "auth_type": "SMS", "refreshToken": "wFyqHGclHCIrf6KMOHOf8qf7ea2adR19CbEtd1rtOR3FutbfEyHC8ndNK8oxt4jQst8FvAynSMkVmbBgynuCq0dOW7MrJXyxzyxWoWPCDdx3VTLNn4is782JuRhYSS9rgcDhlwCbHQLCd7P8s6CmSfpR0oBL2YDgWmhe4lj9386vwo3OXkozfoOqZlqLK6YN0aV4c6cJYkD0FBjx01vk1ty0zYa3v7AvLu2SG8zhnBZbzUHYzdRmlHLw0I677", "bank": "062", "legalId": "11223344550", "value": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." }, "status": "DONE" } } } } } }, "401": { "description": "احراز هویت ناموفق", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/dev/v2/oauth2/token/refresh": { "post": { "operationId": "boomrangRefreshToken", "summary": "تمدید توکن", "description": "\nقبل از انقضای access token با ارسال refresh token می‌توانید توکن جدید دریافت کنید؛ برای توکن CODE و CLIENT-CREDENTIAL. احراز هویت با Basic (client_id:client_secret).\n\n\n\nقبل از منقضی شدن توکن با ارسال رفرش توکن، می‌توانید توکن جدید دریافت کنید.\n\n**آدرس API:**\n\n```\nPOST /dev/v2/oauth2/token\n```\n\n**Grant type:** `refresh_token`\n\n### Headers\n\nمقادیر زیر باید در هدر قرار بگیرد:\n\n```\nContent-Type: application/json\nAuthorization: Basic {AuthenticationString}\n```\n\nمقدار `AuthenticationString` باید برابر Base64 از اطلاعات برنامه شما به صورت `YOURCLIENTID:YOURCLIENTSECRET` باشد. برای مثال اگر شناسه برنامه شما برابر `firstapp` باشد و رمز برنامه شما که در قسمت جزییات برنامه در کنسول قابل مشاهده است برابر `6932dddb927b76e54997` باشد، شما باید Base64 مقدار `firstapp:6932dddb927b76e54997` را تولید کنید. در این صورت مقدار این هدر باید برابر مقدار زیر قرار گیرد:\n\n```\nBasic Zmlyc3RhcHA6NjkzMmRkZGI5MjdiNzZlNTQ5OTc=\n```\n\n### Notes\n\nفرستادن تمام پارامترهای Body الزامی است.\n\nبرای توکن‌های تایپ CODE اگر از نوع احراز هویت با OTP و از طریق SMS باشد، فرستادن `auth_type` اجباری است و نیازی به فرستادن `bank` نیست. در غیر این صورت فرستادن `bank` اجباری و نیازی به فرستادن `auth_type` نیست.\n\nدر صورت رفرش توکن بانک کشاورزی، فرستادن فیلدهای `bank` و `deposit` الزامی است.\n\n| بانک | کد |\n| --- | --- |\n| آینده | 062 |\n| کشاورزی | 016 |\n| پارسیان | 054 |\n| پاسارگاد | 057 |\n| خاورمیانه | 078 |\n\n**نکته:** با توجه به لزوم رعایت دقیق پروتکل‌های OAuth 2.0، پس از دریافت AccessToken و RefreshToken جدید، حتماً از رفرش توکن جدید استفاده گردد.\n", "tags": [ "توکن" ], "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" }, "examples": { "codeWithBank": { "summary": "CODE با bank", "value": { "grant_type": "refresh_token", "token_type": "CODE", "bank": "062", "refresh_token": "sI2t91Bm7zwuORlHDIcdVAw4Ewal7Pz86xpT0w3URx9KQIk3NyWcYxkkzpiLemDWqsGihsc2wIuFvimjHHFXna33KDquF7SJYO8s7OorI5awCFoLu4crJuhqLyIviTje38AuN9TxQKFrzcf2v1yJgtstDTe4QJhRtTq3wzvPGEq8buwE5M1fWSw0Ekenf15h280Rm68oFG9G7qS8A0VUlfplcqwgwvpCD7jCQkTjNF6ZrItGt1KYuv5cS5DsPCwIPGmVxcUxW" } }, "codeSms": { "summary": "CODE با SMS", "value": { "grant_type": "refresh_token", "token_type": "CODE", "refresh_token": "sI2t91Bm7zwuORlHDIcdVAw4Ewal7Pz86xpT0w3URx9KQIk3NyWcYxkkzpiLemDWqsGihsc2wIuFvimjHHFXna33KDquF7SJYO8s7OorI5awCFoLu4crJuhqLyIviTje38AuN9TxQKFrzcf2v1yJgtstDTe4QJhRtTq3wzvPGEq8buwE5M1fWSw0Ekenf15h280Rm68oFG9G7qS8A0VUlfplcqwgwvpCD7jCQkTjNF6ZrItGt1KYuv5cS5DsPCwIPGmVxcUxW", "auth_type": "SMS" } }, "keshavarzi": { "summary": "بانک کشاورزی", "value": { "grant_type": "refresh_token", "token_type": "CODE", "bank": "016", "deposit": "0302876214008", "refresh_token": "sI2t91Bm7zwuORlHDIcdVAw4Ewal7Pz86xpT0w3URx9KQIk3NyWcYxkkzpiLemDWqsGihsc2wIuFvimjHHFXna33KDquF7SJYO8s7OorI5awCFoLu4crJuhqLyIviTje38AuN9TxQKFrzcf2v1yJgtstDTe4QJhRtTq3wzvPGEq8buwE5M1fWSw0Ekenf15h280Rm68oFG9G7qS8A0VUlfplcqwgwvpCD7jCQkTjNF6ZrItGt1KYuv5cS5DsPCwIPGmVxcUxW" } } } } } }, "responses": { "200": { "description": "توکن با موفقیت تمدید شد", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenResponse" }, "example": { "result": { "scopes": [ "oak:statement:get" ], "monthlyCallLimitation": 10, "maxAmountPerTransaction": 350000, "userId": "0012345678", "creationDate": "13970725135334", "type": "CODE", "bank": "062", "lifeTime": 864000000, "deposits": [ "0302876214008" ], "clientId": "drops", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "refreshToken": "sI2t91Bm7zwuORlHDIcdVAw4Ewal7Pz86xpT0w3URx9KQIk3NyWcYxkkzpiLemDWqsGihsc2wIuFvimjHHFXna33KDquF7SJYO8s7OorI5awCFoLu4crJuhqLyIviTje38AuN9TxQKFrzcf2v1yJgtstDTe4QJhRtTq3wzvPGEq8buwE5M1fWSw0Ekenf15h280Rm68oFG9G7qS8A0VUlfplcqwgwvpCD7jCQkTjNF6ZrItGt1KYuv5cS5DsPCwIPGmVxcUxW" }, "status": "DONE" } } } }, "401": { "description": "احراز هویت ناموفق", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/vehicle/v2/clients/{clientId}/activePlateNumbers": { "get": { "operationId": "vehicleActivePlateNumbersGet", "summary": "لیست پلاک‌های فعال", "description": "\nسرویس «لیست پلاک‌های فعال» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن کد ملی و شماره موبایل، لیست پلاک‌های فعال فرد در خروجی نمایش داده می‌شود.\n\n**Scope:** `vehicle:active-plate-numbers:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalId" }, { "$ref": "#/components/parameters/mobile" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleActivePlateNumbersResponse" }, "example": { "responseCode": "FN-CRGO-20000100000", "trackId": "410a3431-526e-4a7f-92fd-af9bcdabf70f", "result": { "plateNumbers": [ { "nationalId": "-", "plateNumber": "ایران ۹۹ - ۲۸۳ ن ۸۰", "revoked": true, "revokedDateTime": "12/26/2018 13:23:40", "revokedDescription": "شماره گذاري بوکان", "serialNumber": "1010029296607" }, { "nationalId": "-", "plateNumber": "ایران ۵۰ - ۱۵۹ ص ۸۰", "revoked": false, "serialNumber": "10100448779921" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/vehicle/v2/clients/{clientId}/matchingVehicleOwnership": { "get": { "operationId": "vehicleMatchingVehicleOwnershipGet", "summary": "تطبیق مالکیت خودرو", "description": "\nسرویس «تطبیق مالکیت خودرو» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شماره پلاک ۹ رقمی و کد ملی، تطبیق یا عدم تطبیق مالکیت خودرو در خروجی نمایش داده می‌شود.\n\n**Scope:** `vehicle:matching-vehicle-ownership:get`
\n\n**Grant type:** client_credentials\n\nنحوه تشکیل شماره پلاک ۹ رقمی در [جدول راهنمای شماره پلاک](/plate-number-table.html) آمده است.", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalId" }, { "$ref": "#/components/parameters/plateNumber" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleMatchingVehicleOwnershipResponse" }, "example": { "responseCode": "FN-VHSB-20000100000", "trackId": "1c78eb0c-253f-486f-2f1b8", "result": { "isValid": true, "vehicleType": "سايپا", "vehicleTip": "SAINA S MT", "vehicleModel": "1401" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/vehicle/v2/clients/{clientId}/plateNumberHistory": { "get": { "operationId": "vehiclePlateNumberHistoryGet", "summary": "تاریخچه پلاک", "description": "\nسرویس «تاریخچه پلاک» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شماره پلاک و کد ملی، اطلاعات مربوط به نصب پلاک بر روی خودروها نمایش داده می‌شود.\n\n**Scope:** `vehicle:plate-number-history:get`
\n\n**Grant type:** client_credentials\n\nنحوه تشکیل شماره پلاک ۹ رقمی در [جدول راهنمای شماره پلاک](/plate-number-table.html) آمده است.", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalId" }, { "$ref": "#/components/parameters/plateNumber" }, { "name": "mobile", "in": "query", "required": true, "description": "شماره موبایل صاحب پلاک", "schema": { "type": "string" }, "example": "09123456789" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclePlateNumberHistoryResponse" }, "example": { "responseCode": "FN-VHPD-20000500000", "trackId": "dece6d37-297f-429f-moho-f6eb106ff6ee", "result": { "plateHistory": [ { "vehicleSystem": "پژو", "vehicleType": "206", "installDate": "1378/02/05", "detachDate": "1400/01/11", "vehicleModel": "1377" } ], "plateStatus": "داراي مالک - نصب برروي وسيله", "tracePlate": "10100100101001" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/vehicle/v2/clients/{clientId}/trafficTollInquiry": { "get": { "operationId": "vehicleTrafficTollInquiryGet", "summary": "استعلام طرح ترافیک", "description": "\nسرویس «استعلام طرح ترافیک» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شماره پلاک ۹ رقمی، کد ملی و موبایل، فهرست بدهی طرح ترافیک خودرو دریافت می‌شود.\n\n**Scope:** `vehicle:traffic-toll-inquiry:get`
\n\n**Grant type:** client_credentials\n\nنحوه تشکیل شماره پلاک ۹ رقمی در [جدول راهنمای شماره پلاک](/plate-number-table.html) آمده است.", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/plateNumber" }, { "$ref": "#/components/parameters/mobile" }, { "$ref": "#/components/parameters/nationalId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleTrafficTollInquiryResponse" }, "example": { "responseCode": "FN-VHGO-20000300000", "trackId": "52328-fe63-46bd-b1cc-e27f48f31016", "result": { "plateNumber": "ایران 40 - 123 ص 51", "bills": [ { "amount": 887851, "fee": 0, "date": "05/14/2023 00:00:00", "paymentStatus": "Unpaid", "totalAmount": 887851, "uniqueId": "c0e803181409f98a74e808dbf9724602" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/vehicle/v2/clients/{clientId}/vehicleInfoInquiry": { "get": { "operationId": "vehicleVehicleInfoInquiryGet", "summary": "استعلام اطلاعات خودرو و تخفیفات", "description": "\nسرویس «استعلام اطلاعات خودرو و تخفیفات» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شماره پلاک ۹ رقمی و کد ملی، اطلاعات و تخفیفات مربوط به خودرو دریافت می‌شود.\n\n**Scope:** `vehicle:vehicle-info-inquiry:get`
\n\n**Grant type:** client_credentials\n\nنحوه تشکیل شماره پلاک ۹ رقمی در [جدول راهنمای شماره پلاک](/plate-number-table.html) آمده است.", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/nationalId" }, { "$ref": "#/components/parameters/plateNumber" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleInfoInquiryResponse" }, "example": { "responseCode": "FN-VHSB-20000300000", "trackId": "1c7-253f-486f-2f1b8", "result": { "axelNo": "2", "wheelNo": "4", "capacity": "جمعا 5 نفر", "cylinderNo": "4", "mainColor": "سفيد", "insuranceCompanyTitle": "بیمه آرمان", "systemByInsuranceCompany": "سايپا", "tipByInsuranceCompany": "ساينا", "chassisNumber": "NAS851100N5000587", "engineNumber": "M15/9002809", "vin": "NAS800100N5700087" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/billing/v2/clients/{clientId}/drivingOffense": { "get": { "operationId": "billingDrivingOffenseGet", "summary": "استعلام خلافی خودرو", "description": "\nسرویس «استعلام خلافی خودرو» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nسرویس استعلام خلافی خودرو با گرفتن شماره موبایل، کدملی و پلاک خودرو لیست خلافی های خودرو را همراه شماره قبض و شماره پرداخت برمیگرداند.\n\n**Scope:** `billing:driving-offense-inquiry:get`
\n\n**Grant type:** client_credentials\n\nنحوه تشکیل شماره پلاک ۹ رقمی در [جدول راهنمای شماره پلاک](/plate-number-table.html) آمده است.", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "mobile", "in": "query", "required": true, "description": "شماره موبایل صاحب خودرو", "schema": { "type": "string" }, "example": "09123456789" }, { "name": "nationalID", "in": "query", "required": true, "description": "کد ملی صاحب خودرو", "schema": { "type": "string" }, "example": "0014578963" }, { "name": "plateNumber", "in": "query", "required": true, "description": "شماره پلاک ۹ رقمی خودرو که باید طبق الگوی توضیح داده شده در [جدول راهنمای شماره پلاک](/plate-number-table.html) وارد شود.", "schema": { "type": "string" }, "example": "552411188" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingDrivingOffenseGetResponse" }, "example": { "trackId": "4ce7fa61-1734-4ced-b343-554a9ec5bad9", "result": { "Bills": [ { "id": "id", "type": "توقف دوبله در معابر", "description": "الصاقی", "code": "2085", "price": 600000, "city": null, "location": "تهران ولیعصر بهرامی", "date": "1396/11/24 - 11:11", "serial": "999999999_99", "dataValue": "", "barcode": null, "license": "plateNumber", "billId": 12345678, "paymentId": 123456789, "normalizedDate": "2018-02-13 11:11:00", "isPayable": true, "policemanCode": null, "hasImage": false } ], "TotalAmount": 600000 }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/billing/v2/clients/{clientId}/negativeScore": { "get": { "operationId": "billingNegativeScoreGet", "summary": "استعلام نمره منفی گواهینامه", "description": "\nسرویس «استعلام نمره منفی گواهینامه» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nسرویس استعلام نمره منفی گواهینامه با گرفتن شماره گواهینامه و استعلام آن از سازمان مربوطه، نمره منفی گواهینامه را در خروجی نمایش میدهد.\n\n**Scope:** `billing:cc-negative-score:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "licenseNumber", "in": "query", "required": true, "description": "شماره گواهینامه ۱۰ رقمی", "schema": { "type": "string" } }, { "name": "nationalID", "in": "query", "required": true, "description": "National ID (کد ملی)", "schema": { "type": "string" } }, { "name": "mobile", "in": "query", "required": true, "description": "Mobile number (شماره موبایل)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingNegativeScoreGetResponse" }, "example": { "responseCode": "FN-BGFH-20000300000", "trackId": "266dcf92-753c-47db-b0f9-cbbe57abffdd", "result": { "LicenseNumber": "9607173353", "NegativeScore": "0", "OffenseCount": null, "Rule": "-" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/billing/v2/clients/{clientId}/ridingOffense": { "get": { "operationId": "billingRidingOffenseGet", "summary": "استعلام خلافی موتور", "description": "\nسرویس «استعلام خلافی موتور» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با گرفتن شماره موبایل، کدملی و پلاک، لیست خلافی های موتور را همراه شماره قبض و شماره پرداخت برمیگرداند.\n\n**Scope:** `billing:riding-offense-inquiry:get`
\n\n**Grant type:** client_credentials\n\nنحوه تشکیل شماره پلاک در [جدول راهنمای شماره پلاک](/plate-number-table.html) آمده است.", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "plateNumber", "in": "query", "required": true, "description": "شماره پلاک ۸ رقمی موتور که باید طبق الگوی توضیح داده شده در [جدول راهنمای شماره پلاک](/plate-number-table.html) وارد شود.", "schema": { "type": "string" } }, { "name": "nationalID", "in": "query", "required": true, "description": "National ID (کد ملی)", "schema": { "type": "string" } }, { "name": "mobile", "in": "query", "required": true, "description": "Mobile number (شماره موبایل)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingRidingOffenseGetResponse" }, "example": { "trackId": "ridingOffenceTrackId", "result": { "Amount": 19395000, "BillID": "8289687000196", "ComplaintCode": "0", "ComplaintStatus": "شکايت ندارد", "PaymentID": "0001996805400", "PlateNumber": "12345678" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/billing/v2/clients/{clientId}/trafficOffenseImage": { "get": { "operationId": "billingTrafficOffenseImageGet", "summary": "دریافت تصویر تخلفات رانندگی", "description": "\nسرویس «دریافت تصویر تخلفات رانندگی» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با دریافت شناسه تخلف، تصویر ثبت شده ی خودرو و پلاک را برمیگرداند.\n\n**Scope:** `billing:traffic-offense-image:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "offenseId", "in": "query", "required": true, "description": "Offense identifier (شناسه تخلف)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingTrafficOffenseImageGetResponse" }, "example": { "trackId": "46d3470b-eb14-4a17-8e77-6052031527d6", "result": { "OffenseId": "47691362", "PlateImageUrl": "https://najaservices.payment.ayantech.ir/pages/files.aspx?id=37CBC84868E842FD813C123564B9A7ED", "VehicleImageUrl": "https://najaservices.payment.ayantech.ir/pages/files.aspx?id=2E1EC5139E364E4090637FF3D7E3BAC6" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/cardToIban": { "get": { "operationId": "facilityCardToIbanV2", "summary": "تبدیل کارت به شبا", "description": "\nسرویس «تبدیل کارت به شبا» (IBAN) در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب). ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با دریافت شماره کارت، اطلاعات شماره شبا را نمایش می‌دهد.\n\n**Scope:** `facility:card-to-iban:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های استعلامی و تبدیلی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "card", "in": "query", "required": true, "description": "شماره کارت", "schema": { "type": "string" }, "example": "6362141081734437" }, { "name": "version", "in": "query", "required": true, "description": "ورژن API — باید برابر ۲ باشد", "schema": { "type": "integer", "enum": [ 2 ] }, "example": 2 } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityCardToIbanV2Response" }, "example": { "trackId": "cardToIban-029", "result": { "IBAN": "IR910800005000115426432001", "bankName": "قرض الحسنه رسالت", "deposit": "10.6423499.1", "card": "6362141081734437", "depositStatus": "02", "depositOwners": "شیما کیانی" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/mpg/v2/clients/{clientId}/cards/{card}": { "get": { "operationId": "mpgCardInformationGet", "summary": "استعلام کارت", "description": "\nسرویس «استعلام کارت» در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب). ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبرای استعلام شماره کارت‌های عضو شتاب از این سرویس استفاده کنید.\n\n**Scope:** `card:information:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های استعلامی و تبدیلی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "card", "in": "path", "required": true, "description": "شماره کارت ۱۶ رقمی", "schema": { "type": "string" }, "example": "6362141081734437" }, { "$ref": "#/components/parameters/trackId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardInformationResponse" }, "example": { "result": { "destCard": "xxxx-xxxx-xxxx-3899", "name": "علی آقایی", "result": "0", "description": "موفق", "doTime": "1396/06/15 12:32:04", "bankName": "بانک تجارت" }, "status": "DONE", "trackId": "get-cardInfo-0232" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/nationalCardImage": { "get": { "operationId": "facilityNationalCardImageGet", "summary": "دریافت تصویر کارت ملی", "description": "\nسرویس «دریافت تصویر کارت ملی» (National ID) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا کد ملی، سریال کارت ملی و تاریخ تولد، عکس کارت ملی مشتری بازگردانده می‌شود.\n\n**Scope:** `facility:national-card-image:get`
\n\n**Grant type:** client_credentials\n\nدر صورت عدم دریافت کارت ملی هوشمند، کد رهگیری را در فیلد `serial` قرار دهید.", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" }, { "$ref": "#/components/parameters/nationalCode" }, { "name": "serial", "in": "query", "required": true, "description": "سریال کارت ملی (یا کد رهگیری)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/birthDate" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityNationalCardImageResponse" }, "example": { "trackId": "43d70b50-c767-4ef6-b220-202610782b05", "result": { "trackingCode": "123456", "image": "/9j/4AAQSkZJRgABAQECWAJYAAD/2wBDACAWGBwYFCAcGhwkIiAmMFA0MCwsMGJGSjpQdGZ6eHJmcG6AkLicgIiuim5woNqirr7EztDOfJri8uDI8LjKzsb/", "message": "" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/shahkar/verify": { "get": { "operationId": "facilityShahkarVerifyGet", "summary": "تطبیق شاهکار موبایل و کد ملی", "description": "\nاستعلام شاهکار مشخص می‌کند شماره موبایل به همان کد ملی تعلق دارد یا نه. این سرویس احراز هویت (KYC) با رویکرد Client Credential است.\n\n\n\nبرای تطبیق کد ملی و شماره موبایل از این سرویس استفاده کنید.\n\n**Scope:** `facility:shahkar:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "mobile", "in": "query", "required": true, "description": "شماره موبایل", "schema": { "type": "string" }, "example": "09123456789" }, { "name": "nationalCode", "in": "query", "required": true, "description": "کد ملی", "schema": { "type": "string" }, "example": "1111111111" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityShahkarVerifyResponse" }, "example": { "responseCode": "FN-FYVR-20001000000", "trackId": "e983dc66-2585-4ee3-90f0-ff2830a0eb83", "result": { "isValid": true }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/oak/v2/clients/{clientId}/ibanInquiry": { "get": { "operationId": "oakIbanInquiryGet", "summary": "استعلام شبا و صاحبان حساب", "description": "\nبا شماره شبا (IBAN) نام بانک، شماره سپرده و صاحبان حساب برمی‌گردد. سرویس استعلامی و تبدیلی فینوتک با رویکرد Client Credential.\n\n\n\nسرویس استعلام اطلاعات شبا — با وارد کردن شماره شبا، اطلاعات حساب، بانک و صاحبان حساب برگردانده می‌شود.\n\n**Scope:** `oak:iban-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های استعلامی و تبدیلی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/iban" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OakIbanInquiryResponse" }, "example": { "responseCode": "FN-OHKZ-20003400000", "trackId": "34dd9c02-d88d-44c8-8833-9495f4765d17", "result": { "IBAN": "IR560620000000000000000000", "bankName": "بانک آینده", "deposit": "0300000001007", "depositDescription": "حساب فعال است", "depositComment": "معتبر برای واریز", "depositOwners": [ { "firstName": "شیما", "lastName": "کیایی" } ], "depositStatus": "02", "errorDescription": "بدون خطا", "bankCode": "062" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/oak/v2/clients/{clientId}/deposits/{deposit}/cc/statement": { "get": { "operationId": "oakCcStatementGet", "summary": "دریافت گردش حساب", "description": "\nبا شماره حساب و بازه تاریخ، فهرست تراکنش‌های همان حساب برمی‌گردد. سرویس بر پایه حساب فینوتک با رویکرد Client Credential.\n\n\n\nبا دریافت یک حساب و تاریخ به‌عنوان پارامتر، لیست تراکنش‌های بازه زمانی ارسال‌شده آن حساب را برمی‌گرداند.\n\n**Scope:** `oak:cc-statement:get`
\n\n**Grant type:** client_credentials\n\n[دانلود مستندات ریسپانس کدها](/pdf/ResponseCodeOak.pdf)\n\nبازه زمانی گردش حساب بیشتر از ۳۱ روز نمی‌تواند باشد. اگر تاریخ شروع (`fromDate`) ارسال شود، اعلام تاریخ پایان (`toDate`) الزامی است.\n\nبرای بانک صادرات هدر `X-API-KEY` اجباری است و مقدار آن را فینوتک در اختیار کلاینت می‌گذارد.", "tags": [ "سرویس های بر پایه حساب" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "deposit", "in": "path", "required": true, "description": "شماره حساب معتبر همان حسابی است که برای کلاینت فعال شده است.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/trackId" }, { "name": "fromDate", "in": "query", "required": false, "description": "تاریخ شروع به فرمت YYMMDD. اختیاری. اگر ارسال شود، `toDate` الزامی است.", "schema": { "type": "string", "pattern": "^\\d{6}$" }, "example": "000510" }, { "name": "toDate", "in": "query", "required": false, "description": "تاریخ پایان به فرمت YYMMDD. اختیاری. بازه بیشتر از ۳۱ روز مجاز نیست.", "schema": { "type": "string", "pattern": "^\\d{6}$" }, "example": "000610" }, { "name": "fromTime", "in": "query", "required": false, "description": "زمان شروع به فرمت HHMMSS. اختیاری. برای بانک کشاورزی، کارآفرین و ملت قابل استفاده نیست.", "schema": { "type": "string", "pattern": "^\\d{6}$" } }, { "name": "toTime", "in": "query", "required": false, "description": "زمان پایان به فرمت HHMMSS. اختیاری. برای بانک کشاورزی، کارآفرین و ملت قابل استفاده نیست.", "schema": { "type": "string", "pattern": "^\\d{6}$" } }, { "name": "lastRecordNumber", "in": "query", "required": false, "description": "اگر در خروجی `transactionChain` برابر `M` باشد، بیش از ۱۰۰ تراکنش در بازه وجود دارد. مقدار `lastRecordNumber` خروجی فراخوانی قبلی را در فراخوانی بعدی بفرستید. فقط برای بانک آینده.", "schema": { "type": "string" } }, { "name": "X-API-KEY", "in": "header", "required": false, "description": "برای بانک صادرات اجباری است. این مقدار را فینوتک در اختیار کلاینت می‌گذارد.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OakCcStatementResponse" }, "example": { "trackId": "bf93588c-4f8c-401e-ad9c-1dc5dc6ed72f", "result": { "iban": "IR000000000000000000000000", "branchCode": "0240", "branchName": "صادقیه", "accountCurrentBalance": "0000000000166895", "transactions": [ { "operationCode": { "code": "722", "message": "حواله اينترنتي" }, "recordNumber": "001", "balance": "0000000000166895", "balanceSign": "C", "transactionAmountCredit": "0000000000000000", "transactionAmountDebit": "0000000000012000", "date": "000510", "fullDate": "14000510", "time": "135454", "originKey": "000510135454KZ654661", "transactionClass": "IBAN", "ibanInformationMap": { "transactionTypeCode": "61", "destinationIban": "IR000000000000000000000000", "payId": "121", "referenceId": "000005100622100000" }, "transactionAmount": "100", "customerDescription": "هدیه‌ یلدا", "sourceAccount": "IR360190000000222222222222", "statementStatus": "DONE", "transactionIdentity": "yaaa-reee-zzzzz-aaaa" } ], "lastRecordNumber": "99948986577685856751", "openDate": "13980703", "accountTypeCode": "040", "subTypeCode": "001", "customerName": "قاسم", "customerFamilyName": "ربجبر", "accountAvailableBalance": "0000000000166895", "accountAvailableBalanceSign": "C", "currentBalance": "0000000000166895", "currentBalanceSign": "C", "transactionChain": "L" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/oak/v2/clients/{clientId}/transferTo": { "post": { "operationId": "oakTransferToDepositPost", "summary": "انتقال وجه به حساب", "description": "\nاز حساب مبدأ تأییدشده به حساب همان بانک یا شبا سایر بانک‌ها واریز داخلی، پایا یا ساتنا انجام می‌شود. سرویس بر پایه حساب فینوتک با رویکرد Authorization Code.\n\n\n\nسرویس انتقال وجه (داخلی، پایا و ساتنا) از حساب کلاینت به حساب دیگران: با این سرویس می‌توانید از حساب مبدأ خود در بانک به حساب مقصد همان بانک یا به شماره شبا سایر بانک‌ها پول واریز کنید.\n\n**Scope:** `oak:transfer-to:execute`
\n\n**Grant type:** authorization_code (بانک کشاورزی: authorization_sms)\n\n[دانلود مستندات ریسپانس کدها](/pdf/ResponseCodeOak.pdf)\n\n### Notes\n\n- این سرویس فقط از مبدأ حساب‌هایی که برای اپلیکیشن شما تأیید شده امکان‌پذیر است.\n- سیکل‌های پایا تا اطلاع ثانوی:\n - چرخه اول: ۱۸:۴۵ روز قبل تا ۰۳:۴۵ روز جاری (بانک پارسیان این سیکل را پشتیبانی نمی‌کند)\n - چرخه دو: ۰۳:۴۵ تا ۰۹:۴۵ روز جاری\n - چرخه سه: ۰۹:۴۵ تا ۱۲:۴۵ روز جاری\n - چرخه چهار: ۱۲:۴۵ تا ۱۸:۴۵ روز جاری\n- انتقال وجه داخلی به حساب / کارت آینده دقایقی بین ۲۳:۵۴ تا ۰۰:۰۰ که روز مالی بانک بسته می‌شود غیرفعال است.\n- اگر وضعیت تراکنش داخلی `PENDING` یا `UNKNOWN` بود، قبل از تلاش مجدد از آخرین وضعیت مطمئن شوید.\n- اگر وضعیت تراکنش بین‌بانکی (پایا) `PENDING` یا `UNKNOWN` بود، قبل از تلاش مجدد گزارش پایا را ببینید؛ تراکنش با یک سیکل تأخیر در آن فهرست برمی‌گردد.\n- چند کاراکتر `-` پیوسته در شرح تراکنش خطای ورودی برمی‌گرداند.\n- در واریز پایای بانک پارسیان مبلغ همان لحظه از حساب کم نمی‌شود؛ موجودی را با احتساب تراکنش‌های در جریان ببینید.\n- اگر وضعیت تراکنش ناموفق / نامشخص / تایم‌اوت (کد ۴۰۸) بود از تکرار خودداری کنید و صورتحساب را چک کنید. برای پایا، گزارش پایا را هم ببینید و بعد از حداکثر ۷۲ ساعت تصمیم بگیرید.\n- دو `trackId` یکسان سمت فینوتک نفرستید.\n- بابت (`reasonDescription`): [اطلاعات بیشتر](/oak-reason-description.html)\n\nالزام فیلدهای بدنه بانک‌به‌بانک است. جدول کامل در توضیح هر فیلد آمده است. حداقل مبلغ پایا ۱۰۰۰۰ ریال است.", "tags": [ "سرویس های بر پایه حساب" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OakTransferToDepositRequest" }, "example": { "amount": 1, "description": "شرح تراکنش", "destinationFirstname": "خلیلی حسینی بیابانی", "destinationLastname": "سمیه غز اله فریماه", "destinationNumber": "IR120620000000302876732005", "paymentNumber": "123456", "deposit": "776700000", "sourceFirstName": "مارتین", "sourceLastName": "اسکورسیزی", "reasonDescription": "1", "merchantName": "آقای پذیرا", "merchantIban": "IR120620000000302876733006" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OakTransferToDepositResponse" }, "example": { "trackId": "transfer-to-deposit-0323", "result": { "amount": 1, "description": "شرح تراکنش", "destinationFirstname": "خلیلی حسینی بیابانی", "destinationLastname": "سمیه غز اله فریماه", "destinationNumber": "0201000900000", "inquiryDate": "951217", "inquirySequence": 1001, "inquiryTime": "095554", "message": " ", "paymentNumber": "12", "refCode": "9611240622211448", "sourceFirstname": "مهدی ز اده", "sourceLastname": "امیر", "sourceNumber": "0200900000000", "type": "internal", "reasonDescription": "19", "transactionId": "1510-asf4973-098245893498872-1766", "endToEndId": "654651236465132", "payaSatnaInquiryTrackId": "45715sf498fgsdf" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "sameAccount": { "summary": "حساب مبدأ و مقصد یکسان", "value": { "status": "FAILED", "trackId": "TrackId", "error": { "code": "VALIDATION_ERROR", "message": "Source And destination accounts are the same!" } } }, "maxAmount": { "summary": "مبلغ بالاتر از سقف توکن", "value": { "status": "FAILED", "trackId": "TrackId", "error": { "code": "VALIDATION_ERROR", "message": "Max amount per transaction limitation exceeded" } } }, "accountConditions": { "summary": "شرایط برداشت حساب رعایت نشده", "value": { "status": "FAILED", "trackId": "TrackId", "error": { "code": "VALIDATION_ERROR", "message": "account conditions not passed" } } }, "minPaya": { "summary": "مبلغ پایا کمتر از حداقل", "value": { "status": "FAILED", "trackId": "TrackId", "error": { "code": "SERVICE_CALL_ERROR", "message": "Minimum amount is 10000 Rials." } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/depositToIban": { "get": { "operationId": "facilityDepositToIbanGet", "summary": "تبدیل حساب به شبا", "description": "\nسرویس «تبدیل حساب به شبا» (IBAN) در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب). ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با وارد کردن شماره حساب و کد بانک، شماره شبا را نمایش می‌دهد.\n\n**Scope:** `facility:cc-deposit-iban:get`
\n\n**Grant type:** client_credentials\n\n**نکات:**\n- در شماره حساب از `/` به جای جداکننده استفاده کنید\n- شماره حساب بانک پاسارگاد با فرمت اصلی بانک ارسال شود\n- برای بانک رسالت از جداکننده نقطه (`.`) استفاده شود", "tags": [ "سرویس های استعلامی و تبدیلی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "deposit", "in": "query", "required": true, "description": "شماره حساب", "schema": { "type": "string" }, "example": "1071333715508" }, { "name": "bankCode", "in": "query", "required": true, "description": "کد بانک صاحب حساب", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityDepositToIbanResponse" }, "example": { "responseCode": "FN-FYFH-20000600000", "trackId": "f4e0457a-5f55-4d5c-8428-f8474f38b6cf", "result": { "deposit": "1071333715508", "accountStatus": "02", "bankName": "SEPAH", "iban": "IR480150000001071333715508", "depositOwners": "محمد حسامی / فعال" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/cardToDeposit": { "get": { "operationId": "facilityCardToDepositGet", "summary": "تبدیل شماره کارت به شماره حساب", "description": "\nسرویس «تبدیل شماره کارت به شماره حساب» در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب). ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس با وارد کردن شماره کارت، شماره حساب را نمایش می‌دهد.\n\n**Scope:** `facility:card-to-deposit:get`
\n\n**Grant type:** client_credentials\n\nبرای فراخوانی نیازی به افزودن حساب نیست و می‌توانید با توکن بدون حساب سرویس را فراخوانی کنید.", "tags": [ "سرویس های استعلامی و تبدیلی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "card", "in": "query", "required": true, "description": "شماره کارت", "schema": { "type": "string" }, "example": "6362141081734437" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityCardToDepositResponse" }, "example": { "responseCode": "FN-FYFH-20000200000", "trackId": "4c3fbcc1-eb919b-05749cd6e118", "result": { "destCard": "5894631987353323", "name": "اکبر اکبری", "result": "0", "doTime": "1403/11/23 14:44:06", "description": "موفق", "deposit": "19475846" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/shahkar/smsSend": { "get": { "operationId": "facilityShahkarSmsSendGet", "summary": "تطبیق موبایل و کد ملی با پیامک", "description": "\nسرویس «تطبیق موبایل و کد ملی با پیامک» (Shahkar / National ID / SMS/OTP) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس جهت تطبیق کد ملی و شماره موبایل و ارسال پیامک تأیید است.\n\n**Scope:** `facility:sms-shahkar-send:get`
\n\n**Grant type:** client_credentials\n\nبرای نسخه به‌روز سرویس، `version=2` ارسال کنید.", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" }, { "name": "mobile", "in": "query", "required": true, "description": "شماره موبایل", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/nationalCode" }, { "name": "version", "in": "query", "required": false, "description": "برای نسخه به‌روز، مقدار ۲", "schema": { "type": "integer", "enum": [ 2 ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityShahkarSmsSendResponse" }, "example": { "trackId": "43d70b50-c767-4ef6-b220-202610782b05", "result": { "smsSent": true }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/users/{nid}/cc/nidInquiry": { "get": { "operationId": "facilityNidInquiryCcGet", "summary": "استعلام کد ملی (Client Credential)", "description": "\nسرویس «استعلام کد ملی» (National ID) در دسته احراز هویت و شناخت مشتری فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاستعلام کد ملی — این سرویس کد ملی و تاریخ تولد دریافت می‌کند و اطلاعات ثبت احوال را برمی‌گرداند. این سرویس در تمامی ساعات شبانه‌روز فعال است.\n\n**Scope:** `facility:cc-nid-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "nid", "in": "path", "required": true, "description": "کد ملی که می‌خواهید صحت آن را بررسی کنید", "schema": { "type": "string" }, "example": "0123456789" }, { "$ref": "#/components/parameters/trackId" }, { "name": "birthDate", "in": "query", "required": true, "description": "تاریخ تولد صاحب کد ملی به صورت yyyy/mm/dd", "schema": { "type": "string" }, "example": "1372/07/14" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityNidInquiryResponse" }, "example": { "responseCode": "FN-FYST-20000500000", "trackId": "0cf5f12f-35aa-48e2-9dfb-42dc59d62f58", "result": { "birthdate": "1372/07/14", "deathStatus": "زنده", "nationalCode": "0123456789", "firstName": "محسن", "lastName": "اکبری", "fatherName": "علي" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/users/{nid}/sms/nidInquiry": { "get": { "operationId": "facilityNidInquirySmsGet", "summary": "استعلام کد ملی (Authorization SMS)", "description": "\nسرویس «استعلام کد ملی (Authorization SMS)» (National ID / SMS/OTP) در دسته احراز هویت و شناخت مشتری فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاستعلام کد ملی — این سرویس کد ملی و تاریخ تولد دریافت می‌کند و اطلاعات ثبت احوال را برمی‌گرداند. این سرویس در تمامی ساعات شبانه‌روز فعال است.\n\n**Scope:** `facility:sms-nid-inquiry:get`
\n\n**Grant type:** authorization_sms\n\nبرای فراخوانی این سرویس پس از دریافت اجازه دسترسی از کاربر، با توکن Authorization SMS فراخوانی کنید.", "tags": [ "سرویس های احراز هویت" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "nid", "in": "path", "required": true, "description": "کد ملی که می‌خواهید صحت آن را بررسی کنید", "schema": { "type": "string" }, "example": "0123456789" }, { "$ref": "#/components/parameters/trackId" }, { "name": "birthDate", "in": "query", "required": true, "description": "تاریخ تولد صاحب کد ملی به صورت yyyy/mm/dd", "schema": { "type": "string" }, "example": "1372/07/14" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityNidInquiryResponse" }, "example": { "responseCode": "FN-FYST-20000500000", "trackId": "0cf5f12f-35aa-48e2-9dfb-42dc59d62f58", "result": { "birthdate": "1372/07/14", "deathStatus": "زنده", "nationalCode": "0123456789", "firstName": "محسن", "lastName": "اکبری", "fatherName": "علي" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/users/{nid}/cc/nidVerification": { "get": { "operationId": "facilityNidVerificationCc", "summary": "احراز هویت با کد ملی", "description": "\nسرویس «احراز هویت با کد ملی» (National ID / KYC) در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب). ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاحراز هویت با کد ملی؛ این سرویس کد ملی، تاریخ تولد و نام را دریافت می‌کند و شباهت نام ارسال‌شده را با نام واقعی صاحب کد ملی برمی‌گرداند. نام را هم به صورت یک فیلد (`fullName`) و هم به صورت `firstName` و `lastName` جدا می‌توانید بفرستید.\n\n**Scope:** `facility:cc-nid-verification:get`
\n\n**Grant type:** client_credentials\n\n**نکته:** پارامترهای query باید [encode](https://datatracker.ietf.org/doc/html/rfc3986#section-2.1) شده ارسال شوند. حداقل یکی از فیلدهای `fullName`، `firstName` یا `lastName` برای مشاهده شباهت ارسال شود.", "tags": [ "سرویس های استعلامی و تبدیلی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "nid", "in": "path", "required": true, "description": "کد ملی که می‌خواهید صحت آن را بررسی کنید", "schema": { "type": "string" }, "example": "0067408595" }, { "$ref": "#/components/parameters/trackId" }, { "name": "birthDate", "in": "query", "required": true, "description": "تاریخ تولد صاحب کد ملی به صورت yyyy/mm/dd", "schema": { "type": "string" }, "example": "1365/11/25" }, { "name": "fullName", "in": "query", "required": false, "description": "نام و نام خانوادگی (یکی از fullName یا firstName/lastName اجباری است)", "schema": { "type": "string" }, "example": "سعید غلامی فرد" }, { "name": "firstName", "in": "query", "required": false, "description": "نام کوچک صاحب کد ملی", "schema": { "type": "string" }, "example": "سعید" }, { "name": "lastName", "in": "query", "required": false, "description": "نام خانوادگی صاحب کد ملی", "schema": { "type": "string" }, "example": "غلامی فرد" }, { "name": "fatherName", "in": "query", "required": false, "description": "نام پدر صاحب کد ملی", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "required": false, "description": "جنسیت صاحب کد ملی — یکی از «زن» یا «مرد»", "schema": { "type": "string", "enum": [ "زن", "مرد" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityNidVerificationCcResponse" }, "example": { "responseCode": "FN-FYKZ-20000400000", "trackId": "nid-inq-9602281200", "result": { "nationalCode": "0067408595", "birthDate": "1365/11/25", "status": "DONE", "fullName": "سعید غلامی فرد", "fullNameSimilarity": 100, "firstName": "سعید", "firstNameSimilarity": 100, "lastName": "غلامی فرد", "lastNameSimilarity": 100, "fatherName": "علی", "fatherNameSimilarity": 100, "deathStatus": "زنده", "gender": "مرد", "genderSimilarity": 100, "description": "", "trackingCode": "123456" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/users/{nid}/sms/nidVerification": { "get": { "operationId": "facilityNidVerificationSms", "summary": "احراز هویت با کد ملی با پیامک", "description": "\nسرویس «احراز هویت با کد ملی با پیامک» (National ID / KYC / SMS/OTP) در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب)؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاحراز هویت با کد ملی؛ این سرویس کد ملی، تاریخ تولد و نام را دریافت می‌کند و شباهت نام ارسال‌شده را با نام واقعی صاحب کد ملی برمی‌گرداند.\n\n**Scope:** `facility:sms-nid-verification:get`
\n\n**Grant type:** authorization_sms\n\n**نکته:** پارامترهای query باید [encode](https://datatracker.ietf.org/doc/html/rfc3986#section-2.1) شده ارسال شوند. حداقل یکی از `fullName`، `firstName`، `lastName` یا `gender` برای مشاهده شباهت ارسال شود.", "tags": [ "سرویس های استعلامی و تبدیلی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "name": "nid", "in": "path", "required": true, "description": "کد ملی که می‌خواهید صحت آن را بررسی کنید", "schema": { "type": "string" }, "example": "0067408595" }, { "$ref": "#/components/parameters/trackId" }, { "name": "birthDate", "in": "query", "required": true, "description": "تاریخ تولد به صورت yyyy/mm/dd", "schema": { "type": "string" }, "example": "1365/11/25" }, { "name": "fullName", "in": "query", "required": false, "description": "نام کامل", "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "required": false, "description": "نام", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "required": false, "description": "نام خانوادگی", "schema": { "type": "string" } }, { "name": "fatherName", "in": "query", "required": false, "description": "نام پدر", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "required": false, "description": "جنسیت — زن یا مرد", "schema": { "type": "string", "enum": [ "زن", "مرد" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityNidVerificationCcResponse" }, "example": { "responseCode": "FN-FYKZ-20000400000", "trackId": "nid-inq-9602281200", "result": { "nationalCode": "0067408595", "birthDate": "1365/11/25", "status": "DONE", "fullName": "سعید غلامی فرد", "fullNameSimilarity": 100, "firstName": "سعید", "firstNameSimilarity": 100, "lastName": "غلامی فرد", "lastNameSimilarity": 100, "fatherName": "علی", "fatherNameSimilarity": 100, "deathStatus": "زنده", "gender": "مرد", "genderSimilarity": 100, "description": "", "trackingCode": "123456" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/depositInfo": { "get": { "operationId": "facilityDepositInfoGet", "summary": "استعلام حساب", "description": "\nسرویس «استعلام حساب» در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب). ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبرای استعلام شماره حساب‌های **بانک خاورمیانه** از این سرویس استفاده می‌شود.\n\n**Scope:** `facility:deposit-information:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های استعلامی و تبدیلی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "deposit", "in": "query", "required": true, "description": "شماره حساب بانک خاورمیانه", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityDepositInfoResponse" }, "example": { "trackId": "f4e0457a-5f55-4d5c-8428-f8474f", "result": { "bankName": "بانک خاورمیانه", "fullName": "مهدی وارسته" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/finnotext": { "post": { "operationId": "facilityFinnotextPost", "summary": "فینوتکست — ارسال پیامک گروهی", "description": "\nسرویس «فینوتکست — ارسال پیامک گروهی» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nسرویس ارسال پیامک؛ هنگامی به کار می‌رود که قصد دارید با یک سرشماره، پیامک گروهی ارسال کنید.\n\n**Scope:** `facility:finnotext:post`
\n\n**Grant type:** client_credentials\n\n**سرویس مرتبط:** [استعلام فینوتکست](#/paths/~1facility~1v2~1clients~1{clientId}~1finnotextInquiry/get)\n\nلیست `to` و `message` باید تناظر یک‌به‌یک و از نظر طول برابر باشند. شماره‌های نامعتبر حذف می‌شوند.", "tags": [ "سرویس های ارسال پیام کوتاه" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityFinnotextRequest" }, "example": { "from": "200000", "to": [ "+9891********", "091********" ], "message": [ "پیام دوم با فرض اینکه در دو بخش فرستاده شده است", "پیام اول که یک بخشی است" ], "templateId": "61dd3f6d49ec892aa628e0f1" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityFinnotextResponse" }, "example": { "trackId": "43d70b50-c767-4ef6-b220-202610782b05", "result": { "numberOfRecords": "2", "numberOfParts": "3" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/finnotextOtp": { "post": { "operationId": "facilityFinnotextOtpPost", "summary": "ارسال پیامک کد تأیید (OTP)", "description": "\nسرویس «ارسال پیامک کد تأیید (OTP)» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nاین سرویس هنگامی به کار می‌رود که قصد دارید با سرشماره مشخص، پیامک کد تأیید ارسال کنید.\n\n**Scope:** `facility:finnotext-otp:post`
\n\n**Grant type:** client_credentials\n\n**سرویس مرتبط:** [استعلام فینوتکست](#/paths/~1facility~1v2~1clients~1{clientId}~1finnotextInquiry/get)", "tags": [ "سرویس های ارسال پیام کوتاه" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityFinnotextOtpRequest" }, "example": { "from": "200000", "to": "+9891********", "message": "متن پیام", "templateId": "61dd3f6d49ec892aa628e0f1" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityFinnotextOtpResponse" }, "example": { "responseCode": "FN-FYJR-20001500000", "trackId": "43d70b50-c767-4ef6-b220-202610782b05", "result": { "numberOfRecords": 1, "numberOfParts": 1 }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/finnotextInquiry": { "get": { "operationId": "facilityFinnotextInquiryGet", "summary": "استعلام فینوتکست", "description": "\nسرویس «استعلام فینوتکست» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا `inquiryTrackId` (همان `trackId` فراخوانی فینوتکست)، وضعیت ارسال پیامک‌های ارسالی استعلام می‌شود.\n\n**Scope:** `facility:finnotext-inquiry:get`
\n\n**Grant type:** client_credentials\n\n### کدهای وضعیت (`status`)\n\n| status | معنی |\n| --- | --- |\n| -1 | پیامک دارای خطا |\n| 0 | منتظر ارسال |\n| 1 | ارسال شده |\n| 10 | ارسال با خطا |\n| 24 | به دست مشترک رسیده |\n| 100 | امکان گزارش‌گیری نیست |", "tags": [ "سرویس های ارسال پیام کوتاه" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" }, { "name": "inquiryTrackId", "in": "query", "required": true, "description": "trackId استفاده‌شده در فراخوانی سرویس فینوتکست", "schema": { "type": "string" }, "example": "ef226c90-20cc-48c6-b582-dee29e71676a" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityFinnotextInquiryResponse" }, "example": { "trackId": "43d70b50-c767-4ef6-b220-202610782b05", "result": { "messages_status": [ { "to_number": "+9891********", "status": 24 }, { "to_number": "+091********", "status": 10 } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/facility/v2/clients/{clientId}/receiveSMS": { "get": { "operationId": "facilityReceiveSmsGet", "summary": "دریافت پیامک", "description": "\nسرویس «دریافت پیامک» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن سرشماره (`destinationNumber`) و بازه تاریخ شمسی (`startDateTime` / `endDateTime`)، پیامک‌های دریافت‌شده روی آن سرشماره برگردانده می‌شود.\n\n**Scope:** `facility:receive-sms:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های ارسال پیام کوتاه" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "destinationNumber", "in": "query", "required": true, "description": "سرشماره دریافت‌کننده پیامک", "schema": { "type": "string" }, "example": "9092301202" }, { "name": "startDateTime", "in": "query", "required": true, "description": "تاریخ شروع بازه (شمسی، yyyy/mm/dd)", "schema": { "type": "string" }, "example": "1405/06/09" }, { "name": "endDateTime", "in": "query", "required": true, "description": "تاریخ پایان بازه (شمسی، yyyy/mm/dd)", "schema": { "type": "string" }, "example": "1405/06/09" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityReceiveSmsResponse" }, "example": { "responseCode": "FN-FYFH-20001600000", "trackId": "ed980658-a437-4a28-907a-f7be859c69d9", "result": { "data": [ { "sourceAddress": "989092301209", "destinationAddress": "88880777", "messageText": "bidari?", "receiveDateTime": "2024-01-01T10:35:23.058Z" }, { "sourceAddress": "989092301209", "destinationAddress": "88880777", "messageText": "سلام", "receiveDateTime": "2024-01-01T10:40:17.003Z" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/sms/status": { "post": { "operationId": "facilityWebhookFinnotextStatus", "summary": "وب‌هوک دریافت وضعیت پیامک", "description": "\nسرویس «وب‌هوک دریافت وضعیت پیامک» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. جزئیات Grant type در ادامه آمده است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nجهت دریافت وضعیت تحویل پیامک پس از ارسال، مشترک باید این endpoint را در اختیار فینوتک قرار دهد.\n\n**Scope:** `facility:finnotext-notification:post`\n\n**Authorization:** مقدار `Basic` از Base64 رشته `YOURCLIENTID:YOURCLIENTSECRET`", "tags": [ "سرویس های ارسال پیام کوتاه" ], "servers": [ { "url": "https://example.com", "description": "آدرس callback مشترک" } ], "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityWebhookFinnotextStatusPayload" }, "example": { "Status": "24", "NumberOfParts": "1", "InquiryId": "123456789", "TrackId": "123456789", "DateTime": "2025-08-26T10:30:00", "ToNumber": "09120000000", "FromNumber": "09120000000" } } } }, "responses": { "200": { "description": "Payload received" } } } }, "/sms/receive": { "post": { "operationId": "facilityWebhookReceiveSms", "summary": "وب‌هوک دریافت پیامک", "description": "\nسرویس «وب‌هوک دریافت پیامک» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. جزئیات Grant type در ادامه آمده است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nجهت دریافت پیامک‌های ارسالی به سرشماره‌های اختصاصی، مشترک باید این endpoint را در اختیار فینوتک قرار دهد.\n\n**Scope:** `facility:finnotext-inbox:post`\n\n**Authorization:** مقدار `Basic` از Base64 رشته `YOURCLIENTID:YOURCLIENTSECRET`", "tags": [ "سرویس های ارسال پیام کوتاه" ], "servers": [ { "url": "https://example.com", "description": "آدرس callback مشترک" } ], "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityWebhookReceiveSmsPayload" }, "example": { "Text": "123456789", "DateTime": "2025-08-26T10:30:00", "ToNumber": "09120000000", "FromNumber": "09120000000" } } } }, "responses": { "200": { "description": "Payload received" } } } }, "/messaging/v2/clients/{clientId}/otp/initiate": { "post": { "operationId": "messagingOtpInitiatePost", "summary": "ثبت درخواست ارسال رمز یکبار مصرف (Initiate)", "description": "\nسرویس «ثبت درخواست ارسال رمز یکبار مصرف (Initiate)» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nسرویس یکپارچه مدیریت چرخه حیات OTP — در این مرحله با ارسال شناسه کاربر و انتخاب کانال (SMS، USSD یا Bot)، فرآیند تولید رمز آغاز شده و `traceId` برای مرحله بعد صادر می‌گردد.\n\n**Scope:** `messaging:otp-initiate:post`
\n\n**Grant type:** client_credentials\n\n### مراحل فراخوانی\n\n1. ثبت درخواست ارسال رمز (این سرویس)\n2. دریافت رمز توسط کاربر از طریق کانال انتخابی\n3. [صحت‌سنجی رمز (Verify)](#/operations/messagingOtpVerifyPost)", "tags": [ "سرویس های ارسال پیام کوتاه" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagingOtpInitiateRequest" }, "example": { "identifier": "09123456789", "method": "sms", "purpose": "login", "ttl": 120 } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagingOtpInitiateResponse" }, "example": { "responseCode": "FN-MGFH-20000100000", "trackId": "ef226c90-20cc-48c6-b582-dee29e71676a", "result": { "traceId": "atx_88234-9912", "status": "pending", "expiresIn": 120 }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/messaging/v2/clients/{clientId}/otp/verify": { "post": { "operationId": "messagingOtpVerifyPost", "summary": "صحت‌سنجی رمز یکبار مصرف (Verify)", "description": "\nسرویس «صحت‌سنجی رمز یکبار مصرف (Verify)» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن کد دریافت‌شده توسط کاربر و `traceId` مرحله [Initiate](#/operations/messagingOtpInitiatePost)، صحت رمز بررسی شده و نتیجه نهایی اعلام می‌گردد.\n\n**Scope:** `messaging:otp-verify:post`
\n\n**Grant type:** client_credentials\n\n### مراحل فراخوانی\n\n1. [ثبت درخواست ارسال رمز (Initiate)](#/operations/messagingOtpInitiatePost)\n2. دریافت رمز توسط کاربر از طریق کانال انتخابی\n3. صحت‌سنجی رمز (این سرویس)", "tags": [ "سرویس های ارسال پیام کوتاه" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackIdRequired" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagingOtpVerifyRequest" }, "example": { "traceId": "atx_88234-9912", "otp": "554321" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagingOtpVerifyResponse" }, "example": { "responseCode": "FN-MGFH-20000200000", "trackId": "ef226c90-20cc-48c6-b582-dee29e71676a", "result": { "status": "verified", "verifiedAt": "14050119104850" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/ecity/v2/clients/{clientId}/postalCode": { "get": { "operationId": "ecityPostalCodeInquiryGet", "summary": "استعلام کد پستی", "description": "\nسرویس «استعلام کد پستی» در دسته استعلام کد پستی و رهگیری مرسوله. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا دریافت کد پستی ۱۰ رقمی، اطلاعات مربوط به آدرس پستی برگردانده می‌شود.\n\n**Scope:** `ecity:cc-postal-code-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های پستی و کدپستی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "postalCode", "in": "query", "required": true, "description": "کد پستی ۱۰ رقمی", "schema": { "type": "string" }, "example": "1341666958" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcityPostalCodeInquiryResponse" }, "example": { "responseCode": "FN-EYRO-20001500000", "trackId": "423068ef-995a-443d-936c-87bbe19f5b5c", "result": { "postalCode": "1341993449", "street": "کوچه امیرانی", "LocalityName": "تهران", "Province": "تهران", "Floor": "1", "HouseNumber": 4, "LocalityType": "شهر", "street2": "کوچه دربندی", "SubLocality": "دکترهوشیار", "TownShip": "تهران", "Zone": "مرکزی", "address": "شهر تهران,محله دکتر معین,کوچه شهید اکبری ,خیابان صالحی,پلاک 4", "buildingId": 6707727, "plateName": "4" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/ecity/v2/clients/{clientId}/postalCodeInquiryCoordinates": { "get": { "operationId": "ecityPostalCodeInquiryCoordinatesGet", "summary": "استعلام کد پستی همراه با مختصات جغرافیایی", "description": "\nسرویس «استعلام کد پستی همراه با مختصات جغرافیایی» در دسته استعلام کد پستی و رهگیری مرسوله. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن کد پستی، استعلام آدرس و مختصات جغرافیایی (عرض و طول) برگردانده می‌شود.\n\n**Scope:** `ecity:postal-code-inquiry-coordinates:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های پستی و کدپستی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "postalCode", "in": "query", "required": true, "description": "کد پستی ۱۰ رقمی", "schema": { "type": "string" }, "example": "1341666958" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcityPostalCodeInquiryCoordinatesResponse" }, "example": { "responseCode": "FN-EYRO-20001800000", "trackId": "90e5e3e6-5171-4915-86ba-4ccd3c49a142", "result": { "postalCode": "8169533243", "localityName": "اصفهان", "province": "اصفهان", "localityType": "شهر", "subLocality": "سیچان", "townShip": "اصفهان", "address": "شهر اصفهان,محله سیچان,کوچه شهید آرش پرویزی,بن بست اکبری,پلاک 42", "street": "کوچه شهید آرش پرویزی", "street2": "بن بست اکبری", "houseNumber": "42", "buildingId": "3392706", "floor": "1", "plateName": "42", "zone": "مرکزی", "latitude": "32.628984725", "longitude": "51.660951825" }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/ecity/v2/clients/{clientId}/postalInquiry": { "get": { "operationId": "ecityPostalInquiryGet", "summary": "استعلام مرسولات پستی", "description": "\nسرویس «استعلام مرسولات پستی» در دسته استعلام کد پستی و رهگیری مرسوله. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن کد رهگیری (`trackingCode`)، اطلاعات رهگیری بسته پستی برگردانده می‌شود.\n\n**Scope:** `ecity:postal-inquiry:get`
\n\n**Grant type:** client_credentials", "tags": [ "سرویس های پستی و کدپستی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "name": "trackingCode", "in": "query", "required": true, "description": "شناسه پیگیری مرسوله", "schema": { "type": "string" }, "example": "000000000000000000000000" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcityPostalInquiryResponse" }, "example": { "responseCode": "FN-EYVH-20001700000", "trackId": "cf65bc2d-c1b3-4579-90bf-ac5ab6448741", "result": { "postType": "پیشتاز", "sourcePostOffice": "دفتر پیشخوان دولت72162332", "source": "استان تهران شهر منطقه 14 پستي تهران", "destination": "استان تهران شهر تهران", "senderName": "senderName", "receiverName": "receiverName", "weight": "425", "totalAmount": "291995", "details": [ { "date": "1403/05/31", "event": "مرسوله تحویل گیرنده گردیده است.", "id": "5", "postalNode": "تهران،منطقه 17 پستي تهران،نقطه مبادله پستی منطقه17", "time": "14:39" } ] }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/ecity/v2/clients/{clientId}/freewayTollInquiry": { "get": { "operationId": "ecityFreewayTollInquiryGet", "summary": "استعلام عوارض آزادراهی", "description": "\nسرویس «استعلام عوارض آزادراهی» در دسته استعلام خودرو و پلاک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، [راهنمای شروع](/guide.html) را ببینید.\n\n\n\nبا وارد کردن شماره پلاک ۹ رقمی، فهرست قبض‌های عوارض آزادراهی خودرو دریافت می‌شود.\n\n**Scope:** `ecity:freeway-toll-inquiry:get`
\n\n**Grant type:** client_credentials\n\nنحوه تشکیل شماره پلاک ۹ رقمی در [جدول راهنمای شماره پلاک](/plate-number-table.html) آمده است.", "tags": [ "سرویس های خودرویی" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/trackId" }, { "$ref": "#/components/parameters/plateNumber" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcityFreewayTollInquiryResponse" }, "example": { "trackId": "12b52a3de-4ac19f637d08", "result": { "bills": [ { "paymentId": "9529451", "date": "2023-07-21 09:46:23", "price": 12000, "gateway": null, "freeway": "21" } ], "totalAmount": 12000 }, "status": "DONE" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "basicAuth": { "type": "http", "scheme": "basic" } }, "parameters": { "clientId": { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "fino-test" }, "trackId": { "name": "trackId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 40 }, "example": "billingInquiry876543" }, "trackIdRequired": { "name": "trackId", "in": "query", "required": true, "description": "Correlation ID (max 40 alphanumeric characters). UUID recommended.", "schema": { "type": "string", "maxLength": 40 }, "example": "ef226c90-20cc-48c6-b582-dee29e71676a" }, "billType": { "name": "type", "in": "query", "required": true, "description": "نوع قبض", "schema": { "type": "string", "enum": [ "Water", "Electricity", "Electricity-standard", "Gas", "GasByBillId", "Tel", "TelNow", "Mobile", "MobileNow" ] }, "example": "Tel" }, "billTypeDetail": { "name": "type", "in": "query", "required": true, "description": "نوع قبض — فقط آب، برق و گاز", "schema": { "type": "string", "enum": [ "Water", "Electricity", "Electricity-support", "Gas" ] }, "example": "Electricity" }, "billTypeHistory": { "name": "type", "in": "query", "required": true, "description": "نوع قبض — برق یا گاز", "schema": { "type": "string", "enum": [ "Electricity", "Gas" ] }, "example": "Gas" }, "parameter": { "name": "parameter", "in": "query", "required": true, "schema": { "type": "string" }, "example": "02177689361" }, "secondParameter": { "name": "secondParameter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MCI", "MTN", "RIGHTEL" ] }, "example": "MCI" }, "nationalCode": { "name": "nationalCode", "in": "query", "required": true, "description": "کد ملی", "schema": { "type": "string" }, "example": "0057684356" }, "birthDate": { "name": "birthDate", "in": "query", "required": true, "description": "تاریخ تولد به صورت yyyy/mm/dd", "schema": { "type": "string" }, "example": "1356/02/23" }, "nid": { "name": "nid", "in": "query", "required": true, "description": "کد ملی صاحب حساب", "schema": { "type": "string" }, "example": "6661111111" }, "iban": { "name": "iban", "in": "query", "required": true, "description": "شماره شبا", "schema": { "type": "string" }, "example": "IR111111111111111111111111" }, "foreignerId": { "name": "foreignerId", "in": "query", "required": true, "description": "شناسه تبعه", "schema": { "type": "string" } }, "companyId": { "name": "companyId", "in": "query", "required": true, "description": "شناسه ملی شرکت", "schema": { "type": "string" }, "example": "14000000000" }, "nationalId": { "name": "nationalId", "in": "query", "required": true, "description": "کد ملی", "schema": { "type": "string" }, "example": "0057684356" }, "plateNumber": { "name": "plateNumber", "in": "query", "required": true, "description": "شماره پلاک ۹ رقمی خودرو که باید طبق الگوی توضیح داده شده در [جدول راهنمای شماره پلاک](/plate-number-table.html) وارد شود.", "schema": { "type": "string" }, "example": "911716950" }, "mobile": { "name": "mobile", "in": "query", "required": true, "description": "شماره موبایل", "schema": { "type": "string" }, "example": "09123456789" }, "transactionCreditInquiryTrackId": { "name": "inquiryTrackId", "in": "query", "required": true, "description": "شناسه پیگیری دریافتی از مرحله درخواست یا صحت‌سنجی", "schema": { "type": "string" }, "example": "INQUIRY_TRACKID" } }, "responses": { "Unauthorized": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "schemas": { "ErrorDetail": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "TokenIssueResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string", "enum": [ "DONE", "FAILED" ] }, "result": { "type": "object", "properties": { "token": { "type": "string" }, "refreshToken": { "type": "string" }, "lifeTime": { "type": "integer" }, "scopes": { "type": "array", "items": { "type": "string" } } } } } }, "ErrorResponse": { "type": "object", "properties": { "status": { "type": "string" }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } }, "FinnotechServiceResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "description": "Response code (کد پاسخ)" }, "trackId": { "type": "string", "description": "Correlation ID (کد پیگیری)" }, "status": { "type": "string", "enum": [ "DONE", "FAILED" ], "description": "API call status (وضعیت فراخوانی)" }, "result": { "type": "object", "additionalProperties": true, "description": "Service result payload" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_empty_reliability_get_sms_getResponse": { "type": "object", "properties": { "numberOfInquiry": { "type": "array", "items": { "type": "object", "properties": { "subscriberType": { "type": "string", "example": "Bank", "description": "subscriberType (see legacy documentation)" }, "last1Month": { "type": "string", "example": "0", "description": "last1Month (see legacy documentation)" }, "last1Year": { "type": "string", "example": "0", "description": "last1Year (see legacy documentation)" } }, "description": "numberOfInquiry (see legacy documentation)" }, "description": "numberOfInquiry (see legacy documentation)" }, "score": { "type": "string", "example": "-1", "description": "آرایه‌ای از رتبه‌بندی کاربر" }, "riskGrade": { "type": "string", "example": "RiskGrade.XX", "description": "riskGrade (see legacy documentation)" }, "scoreRange": { "type": "string", "example": "-1", "description": "scoreRange (see legacy documentation)" }, "scoreDescription": { "type": "string", "example": "ExcludedFromScoring", "description": "scoreDescription (see legacy documentation)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_historical_reliability_get_sms_getResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "72c1442e-3534-48bd-8465-8cb6a095bf84", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "Header": { "type": "object", "properties": { "BatchId": { "type": "string", "example": "127257179", "description": "BatchId (see legacy documentation)" }, "State": { "type": "string", "example": "Finished", "description": "State (see legacy documentation)" }, "BeginTimeStamp": { "type": "string", "example": "2019-06-15T06:45:02.2344822Z", "description": "BeginTimeStamp (see legacy documentation)" }, "TimeStamp": { "type": "string", "example": "2019-06-15T06:45:02.5163708Z", "description": "TimeStamp (see legacy documentation)" }, "FinishTimeStamp": { "type": "string", "example": "2019-06-15T06:45:02.5163708Z", "description": "FinishTimeStamp (see legacy documentation)" }, "Duration": { "type": "string", "example": "0.2819", "description": "Duration (see legacy documentation)" }, "Subscriber": { "type": "string", "example": "Mobin", "description": "Subscriber (see legacy documentation)" }, "SubscriberUnit": { "type": "string", "example": "It", "description": "SubscriberUnit (see legacy documentation)" }, "CommandsUploaded": { "type": "string", "example": "1", "description": "CommandsUploaded (see legacy documentation)" }, "CommandsCompleted": { "type": "string", "example": "1", "description": "CommandsCompleted (see legacy documentation)" } }, "description": "Header (see legacy documentation)" }, "Commands": { "type": "object", "properties": { "Command": { "type": "object", "properties": { "_identifier": { "type": "string", "example": "1", "description": "_identifier (see legacy documentation)" }, "Exception": { "type": "object", "properties": { "ErrorCode": { "type": "string", "example": "Cis.CB4.Modules.BatchUploader.Generated.Interfaces.Lookup.Lookup_BatchUploaderException.ProductAccessDenied", "description": "ErrorCode (see legacy documentation)" }, "FullErrorCode": { "type": "string", "example": "Cis.CB4.Modules.BatchUploader.Body.dll/AccessHelper/CheckAccessInternal/Cis.CB4.Modules.BatchUploader.Generated.Interfaces.Lookup.Lookup_BatchUploaderException.ProductAccessDenied", "description": "FullErrorCode (see legacy documentation)" }, "LogGuid": { "type": "string", "example": "c9ade9a9-b588-4e73-8b75-40fe3ec096b3", "description": "LogGuid (see legacy documentation)" }, "Parameters": { "type": "object", "properties": { "Parameter": { "type": "array", "items": { "type": "object", "properties": { "Key": { "type": "string", "example": "product", "description": "Key (see legacy documentation)" }, "Value": { "type": "string", "example": "String256/86: Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.HistoricalIndividualReport", "description": "Value (see legacy documentation)" } }, "description": "Parameter (see legacy documentation)" }, "description": "Parameter (see legacy documentation)" } }, "description": "Parameters (see legacy documentation)" } }, "description": "Exception (see legacy documentation)" } }, "description": "Command (see legacy documentation)" } }, "description": "Commands (see legacy documentation)" }, "ResponseType": { "type": "string", "example": "Historical", "description": "ResponseType (see legacy documentation)" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_loans_loanId_get_info_getResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "getLoanInfo213454", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "loanStatusCode": { "type": "string", "example": "0", "description": "کد وضعیت تسهیلات(به جدول پایین مراجعه شود)" }, "branchCode": { "type": "string", "example": "0297", "description": "کد شعبه تسهیلات" }, "lastInstallmentMaturityDate": { "type": "string", "example": "020828", "description": "تاریخ سررسید آخرین قسط" }, "currentMaturityDate": { "type": "string", "example": "991028", "description": "تاریخ اولین قسط وصول نشده" }, "totalInstallmentAmount": { "type": "string", "example": "0000002530637798", "description": "مانده بدهی کل تسهیلات" }, "currentInstallmentAmount": { "type": "string", "example": "0000000000000000", "description": "مانده بدهی تا امروز" }, "totalInstallmentsNo": { "type": "string", "example": "0036", "description": "تعداد کل اقساط" }, "currentInstalledNo": { "type": "string", "example": "0001", "description": "تعداد اقساط وصول شده" }, "currentInstalledAmount": { "type": "string", "example": "0000000072332322", "description": "مبلغ وصولی تاکنون" }, "installmentAmount": { "type": "string", "example": "0000000072305000", "description": "مبلغ هر قسط" }, "currentInstalledPenalty": { "type": "string", "example": "0000000000000000", "description": "مبلغ جریمه وصول شده تاکنون" }, "loanDate": { "type": "string", "example": "990828", "description": "تاریخ اعصای تسهیلات" }, "cif": { "type": "string", "example": "0036580370", "description": "شماره مشتری" }, "account": { "type": "string", "example": "0100856321006", "description": "شماره حساب سپرده" }, "errorCode": { "type": "string", "example": "00", "description": "کد اشکال" }, "payableAmount": { "type": "string", "example": "0000002530637798", "description": "مبلغ قابل پرداخت" }, "paymentTypeCode": { "type": "string", "example": "01", "description": "کد نوع پرداخت تسهیلات" }, "chargeCode": { "type": "string", "example": "0000000000000000", "description": "مبلغ کارمزد" }, "debitCustomer": { "type": "string", "example": "0000001982138865", "description": "مانده طلب یا بدهی مشتری" }, "benefitInterest": { "type": "string", "example": "0000000548498933", "description": "تخفیف سود" }, "penaltyAmount": { "type": "string", "example": "0000000000000000", "description": "بدهی بابت خسارت تاخیر" }, "loanSubtypeCode": { "type": "string", "example": "5055", "description": "کد زیر نوع تسهیلات اعطایی" }, "loanSubtypeDesc": { "type": "string", "example": "فروش اقساطی مسکن", "description": "شرح زیر نوع تسهیلات اعطایی" }, "contractTypeCode": { "type": "string", "example": "55", "description": "نوع عقد تسهیلات" }, "contractTypeDesc": { "type": "string", "example": "فروش اقساطی", "description": "شرح نوع عقد تسهیلات" }, "customerName": { "type": "string", "example": "محمد زمانی", "description": "نام و نام خانوادگی مشتری" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_reliability_get_reliability_getResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "86b32e5f-feda-4d58-8b0c-bf00c46ef25e", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "Header": { "type": "object", "properties": { "BatchId": { "type": "string", "example": "126383865", "description": "BatchId (see legacy documentation)" }, "State": { "type": "string", "example": "Finished", "description": "State (see legacy documentation)" }, "BeginTimeStamp": { "type": "string", "example": "2019-06-01T06:19:29.3473361Z", "description": "BeginTimeStamp (see legacy documentation)" }, "TimeStamp": { "type": "string", "example": "2019-06-01T06:19:30.8439841Z", "description": "TimeStamp (see legacy documentation)" }, "FinishTimeStamp": { "type": "string", "example": "2019-06-01T06:19:30.8439841Z", "description": "FinishTimeStamp (see legacy documentation)" }, "Duration": { "type": "string", "example": "1.4966", "description": "Duration (see legacy documentation)" }, "Subscriber": { "type": "string", "example": "Mobin", "description": "Subscriber (see legacy documentation)" }, "SubscriberUnit": { "type": "string", "example": "It", "description": "SubscriberUnit (see legacy documentation)" }, "CommandsUploaded": { "type": "string", "example": "1", "description": "CommandsUploaded (see legacy documentation)" }, "CommandsCompleted": { "type": "string", "example": "1", "description": "CommandsCompleted (see legacy documentation)" } }, "description": "Header (see legacy documentation)" }, "Commands": { "type": "object", "properties": { "Command": { "type": "object", "properties": { "_identifier": { "type": "string", "example": "1", "description": "_identifier (see legacy documentation)" }, "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.ScoringIndividualReport.Response": { "type": "object", "properties": { "Reports.PersonalInformation": { "type": "object", "properties": { "PersonalCode": { "type": "string", "example": "940721894", "description": "PersonalCode (see legacy documentation)" }, "FathersName": { "type": "string", "example": "ابوالقاسم", "description": "FathersName (see legacy documentation)" }, "FirstName": { "type": "string", "example": "ابولفضل", "description": "FirstName (see legacy documentation)" }, "Surname": { "type": "string", "example": "علوی", "description": "Surname (see legacy documentation)" }, "Lookups.Gender": { "type": "string", "example": "Gender.Female", "description": "Lookups.Gender (see legacy documentation)" }, "DateOfBirth": { "type": "string", "example": "1982-02-05T20:30:00Z", "description": "DateOfBirth (see legacy documentation)" } }, "description": "Reports.PersonalInformation (see legacy documentation)" }, "Reports.Lookups.ReportStatus": { "type": "string", "example": "ReportStatus.OK", "description": "Reports.Lookups.ReportStatus (see legacy documentation)" }, "Reports.ScoringInformation": { "type": "object", "properties": { "ICSScore": { "type": "string", "example": "706", "description": "ICSScore (see legacy documentation)" }, "RiskGrade": { "type": "string", "example": "RiskGrade.A1", "description": "RiskGrade (see legacy documentation)" }, "ReasonCodes": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "ReasonCodes (see legacy documentation)" }, "ScoreRange": { "type": "string", "example": "680 - 900", "description": "ScoreRange (see legacy documentation)" }, "ScoreDescription": { "type": "string", "example": "ScoreDescription.VeryLowRisk", "description": "ScoreDescription (see legacy documentation)" } }, "description": "Reports.ScoringInformation (see legacy documentation)" }, "ScoringReportComments": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "ScoringReportComments (see legacy documentation)" }, "ReportDate": { "type": "string", "example": "2019-06-01T06:19:29.7675496Z", "description": "ReportDate (see legacy documentation)" } }, "description": "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.ScoringIndividualReport.Response (see legacy documentation)" } }, "description": "Command (see legacy documentation)" } }, "description": "Commands (see legacy documentation)" }, "ResponseType": { "type": "string", "example": "Scoring", "description": "ResponseType (see legacy documentation)" } }, "description": "این سرویس بسته به پارامترهای ورودی متفاوت، نتیجه‌ی متفاوتی برمیگرداند." }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_score_reliability_get_sms_getResponse": { "type": "object", "properties": { "Header": { "type": "object", "properties": { "BatchId": { "type": "string", "example": "126981824", "description": "BatchId (see legacy documentation)" }, "State": { "type": "string", "example": "Finished", "description": "State (see legacy documentation)" }, "BeginTimeStamp": { "type": "string", "example": "2019-06-11T05:24:07.0965275Z", "description": "BeginTimeStamp (see legacy documentation)" }, "TimeStamp": { "type": "string", "example": "2019-06-11T05:24:07.9024789Z", "description": "TimeStamp (see legacy documentation)" }, "FinishTimeStamp": { "type": "string", "example": "2019-06-11T05:24:07.9024789Z", "description": "FinishTimeStamp (see legacy documentation)" }, "Duration": { "type": "string", "example": "0.8060", "description": "Duration (see legacy documentation)" }, "Subscriber": { "type": "string", "example": "Mobin", "description": "Subscriber (see legacy documentation)" }, "SubscriberUnit": { "type": "string", "example": "It", "description": "SubscriberUnit (see legacy documentation)" }, "CommandsUploaded": { "type": "string", "example": "1", "description": "CommandsUploaded (see legacy documentation)" }, "CommandsCompleted": { "type": "string", "example": "1", "description": "CommandsCompleted (see legacy documentation)" } }, "description": "Header (see legacy documentation)" }, "Commands": { "type": "object", "properties": { "Command": { "type": "object", "properties": { "_identifier": { "type": "string", "example": "1", "description": "_identifier (see legacy documentation)" }, "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.ScoringIndividualReport.Response": { "type": "object", "properties": { "Reports.PersonalInformation": { "type": "object", "properties": { "PersonalCode": { "type": "string", "example": "0075511037", "description": "PersonalCode (see legacy documentation)" }, "FathersName": { "type": "string", "example": "علی", "description": "FathersName (see legacy documentation)" }, "FirstName": { "type": "string", "example": "رضا", "description": "FirstName (see legacy documentation)" }, "Surname": { "type": "string", "example": "حسینی نژاد", "description": "Surname (see legacy documentation)" }, "Lookups.Gender": { "type": "string", "example": "Gender.Male", "description": "Lookups.Gender (see legacy documentation)" }, "DateOfBirth": { "type": "string", "example": "1984-08-08T19:30:00Z", "description": "DateOfBirth (see legacy documentation)" } }, "description": "Reports.PersonalInformation (see legacy documentation)" }, "Reports.Lookups.ReportStatus": { "type": "string", "example": "ReportStatus.OK", "description": "Reports.Lookups.ReportStatus (see legacy documentation)" }, "Reports.ScoringInformation": { "type": "object", "properties": { "ICSScore": { "type": "string", "example": "-1", "description": "ICSScore (see legacy documentation)" }, "RiskGrade": { "type": "string", "example": "RiskGrade.XX", "description": "RiskGrade (see legacy documentation)" }, "ReasonCodes": { "type": "object", "properties": { "ReasonCodeList": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "ReasonCode": { "type": "string", "example": "CIPSReasonCodes.XDAT", "description": "ReasonCode (see legacy documentation)" } }, "description": "ReasonCodeList (see legacy documentation)" } }, "description": "ReasonCodes (see legacy documentation)" }, "ScoreRange": { "type": "string", "example": "-1", "description": "ScoreRange (see legacy documentation)" }, "ScoreDescription": { "type": "string", "example": "ScoreDescription.ExcludedFromScoring", "description": "ScoreDescription (see legacy documentation)" } }, "description": "Reports.ScoringInformation (see legacy documentation)" }, "ScoringReportComments": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "ScoringReportComments (see legacy documentation)" }, "ReportDate": { "type": "string", "example": "2019-06-11T05:24:07.3720755Z", "description": "ReportDate (see legacy documentation)" } }, "description": "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.ScoringIndividualReport.Response (see legacy documentation)" } }, "description": "Command (see legacy documentation)" } }, "description": "Commands (see legacy documentation)" }, "ResponseType": { "type": "string", "example": "Scoring", "description": "ResponseType (see legacy documentation)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "CreditScoreReportRegenerateResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "c9470a1c-6d44-4145-accb-d07269896085", "description": "(اجباری) رشته ای با طول حداکثر ۴۰ کاراکتر شامل حرف و عدد. پیشنهاد 2ما برای trackId تولید کردن UUID است. در صورت نیاز به نتیجه یک فراخوانی میتوانید با trackId آن را فیلتر کنید. در گزارش فراخوانی سرویس فراخوانی مورد نظر را با همین کد پیگیری پیدا میکنید." }, "status": { "type": "string", "example": "DONE", "description": "API call status: DONE or FAILED (وضعیت فراخوانی سرویس)" }, "result": { "type": "object", "properties": { "data": { "type": "object", "properties": { "resendWait": { "type": "integer", "example": 180, "description": "زمان لازم برای ارسال مجدد" }, "resendLocked": { "type": "boolean", "example": false, "description": "درصورتی که ارسال مجدد موفق نباشد مقدار true خواهد داشت" } }, "description": "آبجکتی شامل مقادیر برگشتی زیر" }, "hasError": { "type": "boolean", "example": false, "description": "اگر خطایی موجود باشد مقدار true می باشد." }, "messages": { "type": [ "string", "null" ], "description": "متن خطا" } }, "description": "Service result payload (نتیجه سرویس)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "CreditScoreReportRenewOtpResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "c9470a1c-6d44-4145-accb-d07269896085", "description": "(اجباری) رشته ای با طول حداکثر ۴۰ کاراکتر شامل حرف و عدد. پیشنهاد 2ما برای trackId تولید کردن UUID است. در صورت نیاز به نتیجه یک فراخوانی میتوانید با trackId آن را فیلتر کنید. در گزارش فراخوانی سرویس فراخوانی مورد نظر را با همین کد پیگیری پیدا میکنید." }, "status": { "type": "string", "example": "DONE", "description": "API call status: DONE or FAILED (وضعیت فراخوانی سرویس)" }, "result": { "type": "object", "properties": { "data": { "type": "object", "properties": { "resendWait": { "type": "integer", "example": 180, "description": "زمان لازم برای ارسال مجدد" }, "resendLocked": { "type": "boolean", "example": false, "description": "درصورتی که ارسال مجدد موفق نباشد مقدار true خواهد داشت" } }, "description": "آبجکتی شامل مقادیر برگشتی زیر" }, "hasError": { "type": "boolean", "example": false, "description": "اگر خطایی موجود باشد مقدار true می باشد." }, "messages": { "type": [ "string", "null" ], "description": "متن خطا" } }, "description": "Service result payload (نتیجه سرویس)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "CreditScoreReportSendResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "ac468674-ae31-4f34-9b1d", "description": "(اجباری) رشته ای با طول حداکثر ۴۰ کاراکتر شامل حرف و عدد. پیشنهاد ما برای trackId تولید کردن UUID است. در صورت نیاز به نتیجه یک فراخوانی میتوانید با trackId آن را فیلتر کنید. در گزارش فراخوانی سرویس فراخوانی مورد نظر را با همین کد پیگیری پیدا میکنید." }, "status": { "type": "string", "example": "DONE", "description": "API call status: DONE or FAILED (وضعیت فراخوانی سرویس)" }, "result": { "type": "object", "properties": { "data": { "type": "string", "example": "KLSNSDKLFNSKLNFNNFSDFNSKDFKJSBFKBFKB3pQYw==", "description": "آبجکتی شامل مقادیر برگشتی زیر" }, "hasError": { "type": "boolean", "example": false, "description": "اگر خطایی موجود باشد مقدار true می باشد." }, "messages": { "type": [ "string", "null" ], "description": "متن خطا" } }, "description": "خروجی گزارش اعتبارسنجی. در صورتی که فیلد outputType=\"json\" یا outputType=\"pdf\" باشد، آنگاه result به فرم json یا pdf می‌باشد. در غیر این‌صورت به فرم xml است." }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "CreditScoreReportVerifyAndCreateResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "15a7f751-75c4-41c0", "description": "(اجباری) رشته ای با طول حداکثر ۴۰ کاراکتر شامل حرف و عدد. پیشنهاد ما برای trackId تولید کردن UUID است. در صورت نیاز به نتیجه یک فراخوانی میتوانید با trackId آن را فیلتر کنید. در گزارش فراخوانی سرویس فراخوانی مورد نظر را با همین کد پیگیری پیدا میکنید." }, "status": { "type": "string", "example": "DONE", "description": "API call status: DONE or FAILED (وضعیت فراخوانی سرویس)" }, "result": { "type": "object", "properties": { "data": { "type": "string", "example": "InProcessing", "description": "آبجکتی شامل مقادیر برگشتی زیر" }, "hasError": { "type": "boolean", "example": false, "description": "اگر خطایی موجود باشد مقدار true می باشد." }, "messages": { "type": [ "string", "null" ], "description": "متن خطا" } }, "description": "خروجی گزارش اعتبارسنجی. در صورتی که فیلد outputType=\"json\" یا outputType=\"pdf\" باشد، آنگاه result به فرم json یا pdf می‌باشد. در غیر این‌صورت به فرم xml است." }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "CreditScoreReportStatusCheckResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "e3d91d25-5b7f-42d2-a99e-9d1cb8ca3f9b", "description": "(اجباری) رشته ای با طول حداکثر ۴۰ کاراکتر شامل حرف و عدد. پیشنهاد ما برای trackId تولید کردن UUID است. در صورت نیاز به نتیجه یک فراخوانی میتوانید با trackId آن را فیلتر کنید. در گزارش فراخوانی سرویس فراخوانی مورد نظر را با همین کد پیگیری پیدا میکنید." }, "status": { "type": "string", "example": "DONE", "description": "API call status: DONE or FAILED (وضعیت فراخوانی سرویس)" }, "result": { "type": "object", "properties": { "data": { "type": "object", "properties": { "statusTitle": { "type": "string", "example": "ساخت گزارش", "description": "عنوان درخواست" }, "status": { "type": "string", "example": "ReportGenerated" }, "reportLink": { "type": "string", "example": "https://hostName.ir/report/pNw7x2muLx8TZPx4wx94w=", "description": "لینک حاوی گزارش. از قسمت آخر reportLink می‌توان در مرحله بعد به عنوان هش استفاده کرد. برای مثال در اینجا مقدار آن pNw7x2muLx8TZPx4wx94w= می‌باشد." }, "otpMessageStatusTitle": { "type": "string", "example": "رسیده به مخابرات", "description": "عنوان وضعیت کد فعال سازی" }, "otpMessageStatus": { "type": "integer", "example": 3, "description": "کد وضعیت کد فعال سازی" }, "reportTryCount": { "type": "integer", "example": 0, "description": "تعداد درخواست" } }, "description": "آبجکتی شامل مقادیر برگشتی زیر" }, "hasError": { "type": "boolean", "example": false, "description": "اگر خطایی موجود باشد مقدار true می باشد." }, "messages": { "type": [ "string", "null" ], "description": "متن خطا" } }, "description": "خروجی گزارش اعتبارسنجی. در صورتی که فیلد outputType=\"json\" یا outputType=\"pdf\" باشد، آنگاه result به فرم json یا pdf می‌باشد. در غیر این‌صورت به فرم xml است." }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "CreditScoreReportGetRequestDataResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "your-track-id", "description": "(اجباری) رشته ای با طول حداکثر ۴۰ کاراکتر شامل حرف و عدد. پیشنهاد ما برای trackId تولید کردن UUID است. در صورت نیاز به نتیجه یک فراخوانی میتوانید با trackId آن را فیلتر کنید. در گزارش فراخوانی سرویس فراخوانی مورد نظر را با همین کد پیگیری پیدا میکنید." }, "status": { "type": "string", "example": "DONE", "description": "API call status: DONE or FAILED (وضعیت فراخوانی سرویس)" }, "result": { "type": "object", "properties": { "_declaration": { "type": "object", "properties": { "_attributes": { "type": "object", "properties": { "version": { "type": "string", "example": "1.0", "description": "version (see legacy documentation)" }, "encoding": { "type": "string", "example": "utf-16", "description": "encoding (see legacy documentation)" } }, "description": "_attributes (see legacy documentation)" } }, "description": "_declaration (see legacy documentation)" }, "GetGeneratedReportV2DTO": { "type": "object", "properties": { "_attributes": { "type": "object", "properties": { "xmlns:xsi": { "type": "string", "example": "http://www.w3.org/2001/XMLSchema-instance", "description": "xmlns:xsi (see legacy documentation)" }, "xmlns:xsd": { "type": "string", "example": "http://www.w3.org/2001/XMLSchema", "description": "xmlns:xsd (see legacy documentation)" } }, "description": "_attributes (see legacy documentation)" }, "ReportTypes": { "type": "object", "properties": { "string": { "type": "object", "properties": { "_text": { "type": "string", "example": "Inquiry", "description": "_text (see legacy documentation)" } }, "description": "string (see legacy documentation)" } }, "description": "ReportTypes (see legacy documentation)" }, "Score": { "type": "object", "properties": { "Score": { "type": "object", "properties": { "_text": { "type": "string", "example": "0", "description": "_text (see legacy documentation)" } }, "description": "Score (see legacy documentation)" } }, "description": "Score (see legacy documentation)" }, "Report": { "type": "object", "properties": { "PersonInformation": { "type": "object", "properties": { "NationalCode": { "type": "object", "properties": { "_text": { "type": "string", "example": "6789123456", "description": "_text (see legacy documentation)" } }, "description": "NationalCode (see legacy documentation)" }, "Contacts": { "type": "object", "properties": {}, "description": "Contacts (see legacy documentation)" }, "HasBlockedContract": { "type": "object", "properties": { "_text": { "type": "string", "example": "false", "description": "_text (see legacy documentation)" } }, "description": "HasBlockedContract (see legacy documentation)" }, "DateOfBirth": { "type": "object", "properties": {}, "description": "DateOfBirth (see legacy documentation)" } }, "description": "PersonInformation (see legacy documentation)" }, "InquiryStats": { "type": "object", "properties": { "InquiryStats": { "type": "array", "items": { "type": "object", "properties": { "OrganizationType": { "type": "object", "properties": { "_text": { "type": "string", "example": "بانک مرکزی", "description": "_text (see legacy documentation)" } }, "description": "OrganizationType (see legacy documentation)" }, "OrganizationTypeCode": { "type": "object", "properties": { "_text": { "type": "string", "example": "0102533", "description": "_text (see legacy documentation)" } }, "description": "OrganizationTypeCode (see legacy documentation)" }, "LastMonthInquiryCount": { "type": "object", "properties": { "_text": { "type": "string", "example": "0", "description": "_text (see legacy documentation)" } }, "description": "LastMonthInquiryCount (see legacy documentation)" }, "LastYearInquiryCount": { "type": "object", "properties": { "_text": { "type": "string", "example": "0", "description": "_text (see legacy documentation)" } }, "description": "LastYearInquiryCount (see legacy documentation)" }, "PersonNegativeStatusCount": { "type": "object", "properties": { "_text": { "type": "string", "example": "0", "description": "_text (see legacy documentation)" } }, "description": "PersonNegativeStatusCount (see legacy documentation)" }, "ContractNegativeStatusCount": { "type": "object", "properties": { "_text": { "type": "string", "example": "0", "description": "_text (see legacy documentation)" } }, "description": "ContractNegativeStatusCount (see legacy documentation)" } }, "description": "InquiryStats (see legacy documentation)" }, "description": "InquiryStats (see legacy documentation)" } }, "description": "InquiryStats (see legacy documentation)" }, "PersonRoles": { "type": "object", "properties": {}, "description": "PersonRoles (see legacy documentation)" }, "SummaryInformationRelatedToContracts": { "type": "object", "properties": {}, "description": "SummaryInformationRelatedToContracts (see legacy documentation)" }, "SummaryInformationRelatedToContractsSum": { "type": "object", "properties": {}, "description": "SummaryInformationRelatedToContractsSum (see legacy documentation)" }, "DirectContracts": { "type": "object", "properties": {}, "description": "DirectContracts (see legacy documentation)" }, "IndirectContracts": { "type": "object", "properties": {}, "description": "IndirectContracts (see legacy documentation)" }, "ContractNegativeStatus": { "type": "object", "properties": {}, "description": "ContractNegativeStatus (see legacy documentation)" }, "PersonNegativeStatus": { "type": "object", "properties": {}, "description": "PersonNegativeStatus (see legacy documentation)" }, "InquiryCreatedDate": { "type": "object", "properties": { "_text": { "type": "string", "example": "1401/03/31 09:18", "description": "_text (see legacy documentation)" } }, "description": "InquiryCreatedDate (see legacy documentation)" } }, "description": "Report (see legacy documentation)" } }, "description": "GetGeneratedReportV2DTO (see legacy documentation)" } }, "description": "خروجی گزارش اعتبارسنجی. در صورتی که فیلد outputType=\"json\" یا outputType=\"pdf\" باشد، آنگاه result به فرم json یا pdf می‌باشد. در غیر این‌صورت به فرم xml است." }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_standard_reliability_get_sms_getResponse": { "type": "object", "properties": { "_identifier": { "type": "string", "example": "1", "description": "_identifier (see legacy documentation)" }, "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.StandardIndividualReport.Response": { "type": "object", "properties": { "Reports.EmptyIndividualData": { "type": "object", "properties": { "Types.Subject.Individual.PersonalCode": { "type": "string", "example": "0075511037", "description": "Types.Subject.Individual.PersonalCode (see legacy documentation)" } }, "description": "Reports.EmptyIndividualData (see legacy documentation)" }, "Reports.BasicIndividualData": { "type": "object", "properties": { "Relations.Subjects.PersonalData": { "type": "object", "properties": { "Types.Subject.Individual.FarthersName": { "type": "string", "example": "علی", "description": "Types.Subject.Individual.FarthersName (see legacy documentation)" }, "Types.Subject.Individual.FirstName": { "type": "string", "example": "رضا", "description": "Types.Subject.Individual.FirstName (see legacy documentation)" }, "Types.Subject.Individual.Surname": { "type": "string", "example": "حسینی نژاد", "description": "Types.Subject.Individual.Surname (see legacy documentation)" }, "Lookups.Gender": { "type": "string", "example": "Gender.Male", "description": "Lookups.Gender (see legacy documentation)" }, "Lookups.MaritalStatus": { "type": "string", "example": "MaritalStatus.Married", "description": "Lookups.MaritalStatus (see legacy documentation)" }, "Lookups.BorrowerClassification": { "type": "string", "example": "BorrowerClassification.Individual", "description": "Lookups.BorrowerClassification (see legacy documentation)" } }, "description": "Relations.Subjects.PersonalData (see legacy documentation)" }, "Relations.Subjects.BirthData": { "type": "object", "properties": { "Types.Subject.BirthData.BirthSurname": { "type": "string", "example": "حسینی نژاد", "description": "Types.Subject.BirthData.BirthSurname (see legacy documentation)" }, "Types.Subject.BirthData.DateOfBirth": { "type": "string", "example": "1984-08-08T19:30:00Z", "description": "Types.Subject.BirthData.DateOfBirth (see legacy documentation)" }, "Types.Subject.BirthData.PlaceOfBirth": { "type": "string", "example": "10001", "description": "Types.Subject.BirthData.PlaceOfBirth (see legacy documentation)" }, "Lookups.CountryOfBirth": { "type": "string", "example": "CountryCodes.IR", "description": "Lookups.CountryOfBirth (see legacy documentation)" } }, "description": "Relations.Subjects.BirthData (see legacy documentation)" }, "Reports.SubjectData.Current.NegativeSubjectStatus": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "00", "description": "_key (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2013-05-21T07:00:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Lookups.NegativeSubjectStatus": { "type": "string", "example": "NegativeStatusOfSubject.NoNegativeStatus", "description": "Lookups.NegativeSubjectStatus (see legacy documentation)" }, "Reports.Creditor": { "type": "string", "example": "بانک ملت", "description": "Reports.Creditor (see legacy documentation)" } }, "description": "Reports.SubjectData.Current.NegativeSubjectStatus (see legacy documentation)" }, "description": "Reports.SubjectData.Current.NegativeSubjectStatus (see legacy documentation)" } }, "description": "Reports.BasicIndividualData (see legacy documentation)" }, "Reports.SubjectData.AddressesIndividual": { "type": "object", "properties": { "Reports.Addresses.PermanentAddress": { "type": "object", "properties": { "_key": { "type": "string", "example": "1", "description": "_key (see legacy documentation)" }, "Relations.Addresses.AddressTypeChoice": { "type": "object", "properties": { "Relations.Addresses.TextAddress": { "type": "object", "properties": { "Types.Subject.Address.TextAddress": { "type": "string", "example": "تهران خ ايران ك فياض بخش ك كريمي ك شفيعي پ45", "description": "Types.Subject.Address.TextAddress (see legacy documentation)" } }, "description": "Relations.Addresses.TextAddress (see legacy documentation)" } }, "description": "Relations.Addresses.AddressTypeChoice (see legacy documentation)" } }, "description": "Reports.Addresses.PermanentAddress (see legacy documentation)" } }, "description": "Reports.SubjectData.AddressesIndividual (see legacy documentation)" }, "Reports.SubjectData.Contacts": { "type": "object", "properties": { "Reports.Contacts.Cellular": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Types.Subject.Communication.ContactNumber": { "type": "string", "example": "09122718615", "description": "Types.Subject.Communication.ContactNumber (see legacy documentation)" } }, "description": "Reports.Contacts.Cellular (see legacy documentation)" }, "Reports.Contacts.Fax": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Types.Subject.Communication.ContactNumber": { "type": "string", "example": "-", "description": "Types.Subject.Communication.ContactNumber (see legacy documentation)" } }, "description": "Reports.Contacts.Fax (see legacy documentation)" }, "Reports.Contacts.Phone": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Types.Subject.Communication.ContactNumber": { "type": "string", "example": "02133554546-09122718615", "description": "Types.Subject.Communication.ContactNumber (see legacy documentation)" } }, "description": "Reports.Contacts.Phone (see legacy documentation)" }, "description": "Reports.Contacts.Phone (see legacy documentation)" } }, "description": "Reports.SubjectData.Contacts (see legacy documentation)" }, "Reports.Inquiries": { "type": "object", "properties": { "Reports.Inquiries.LastMonth": { "type": "string", "example": "77", "description": "Reports.Inquiries.LastMonth (see legacy documentation)" }, "Reports.Inquiries.ThreeMonths": { "type": "string", "example": "94", "description": "Reports.Inquiries.ThreeMonths (see legacy documentation)" }, "Reports.Inquiries.SixMonths": { "type": "string", "example": "94", "description": "Reports.Inquiries.SixMonths (see legacy documentation)" }, "Reports.Inquiries.TwelveMonths": { "type": "string", "example": "94", "description": "Reports.Inquiries.TwelveMonths (see legacy documentation)" } }, "description": "Reports.Inquiries (see legacy documentation)" }, "Reports.Summary": { "type": "object", "properties": { "Reports.Summary.TotalDebtOverdue": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalDebtOverdue (see legacy documentation)" }, "Reports.Summary.TotalNumberOfUnpaidInstalments": { "type": "string", "example": "0", "description": "Reports.Summary.TotalNumberOfUnpaidInstalments (see legacy documentation)" }, "Reports.Summary.TotalOutstandingAmount": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalOutstandingAmount (see legacy documentation)" }, "Reports.Summary.NumberOfExistingOperations": { "type": "string", "example": "0", "description": "Reports.Summary.NumberOfExistingOperations (see legacy documentation)" }, "Reports.Summary.NumberOfTerminatedOperations": { "type": "string", "example": "3", "description": "Reports.Summary.NumberOfTerminatedOperations (see legacy documentation)" }, "Reports.Summary.NegativeStatusReported": { "type": "object", "properties": { "_key": { "type": "string", "example": "00", "description": "_key (see legacy documentation)" }, "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.PastDueDebt", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2016-02-18T20:30:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Reports.Creditor": { "type": "string", "example": "بانک ملت", "description": "Reports.Creditor (see legacy documentation)" } }, "description": "Reports.Summary.NegativeStatusReported (see legacy documentation)" } }, "description": "Reports.Summary (see legacy documentation)" }, "Reports.SummaryCreditors": { "type": "object", "properties": { "Reports.SummaryCreditor": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "12", "description": "_key (see legacy documentation)" }, "Reports.Creditor": { "type": "string", "example": "بانک ملت", "description": "Reports.Creditor (see legacy documentation)" }, "Reports.Summary.TotalDebtOverdue": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalDebtOverdue (see legacy documentation)" }, "Reports.Summary.TotalNumberOfUnpaidInstalments": { "type": "string", "example": "0", "description": "Reports.Summary.TotalNumberOfUnpaidInstalments (see legacy documentation)" }, "Reports.Summary.TotalOutstandingAmount": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalOutstandingAmount (see legacy documentation)" }, "Reports.Summary.NumberOfExistingOperations": { "type": "string", "example": "0", "description": "Reports.Summary.NumberOfExistingOperations (see legacy documentation)" }, "Reports.Summary.NumberOfTerminatedOperations": { "type": "string", "example": "1", "description": "Reports.Summary.NumberOfTerminatedOperations (see legacy documentation)" }, "Reports.Summary.NegativeStatusReported": { "type": "object", "properties": { "_key": { "type": "string", "example": "00", "description": "_key (see legacy documentation)" }, "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.PastDueDebt", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2016-02-18T20:30:00Z", "description": "Reports.LastUpdate (see legacy documentation)" } }, "description": "Reports.Summary.NegativeStatusReported (see legacy documentation)" } }, "description": "Reports.SummaryCreditor (see legacy documentation)" }, "description": "Reports.SummaryCreditor (see legacy documentation)" } }, "description": "Reports.SummaryCreditors (see legacy documentation)" }, "Reports.BaseDataOperations": { "type": "object", "properties": { "Reports.ContractData.ExistingOperationsDebtor": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Reports.ContractData.ExistingOperationsDebtor (see legacy documentation)" }, "Reports.ContractData.TerminatedOperationsDebtor": { "type": "object", "properties": { "Reports.ContractData.Instalments": { "type": "object", "properties": { "Reports.ContractData.Instalment": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Relations.Contracts.InstalmentDetails": { "type": "object", "properties": { "Lookups.TypeOfFinancingInstalments": { "type": "string", "example": "TypeOfFinancingInstalments.QarzAlHassaneh", "description": "Lookups.TypeOfFinancingInstalments (see legacy documentation)" }, "Lookups.TypeOfInstalments": { "type": "string", "example": "TypeOfInstalments.Fixed", "description": "Lookups.TypeOfInstalments (see legacy documentation)" }, "Lookups.PeriodicityOfPayments": { "type": "string", "example": "PeriodicityOfPayments.MonthlyInstalments30Days", "description": "Lookups.PeriodicityOfPayments (see legacy documentation)" }, "Lookups.MethodOfPayment": { "type": "string", "example": "MethodOfPayment.CurrentAccount", "description": "Lookups.MethodOfPayment (see legacy documentation)" }, "Relations.Amounts.TotalCredit": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "32399880.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.TotalCredit (see legacy documentation)" }, "Types.Contract.NumberOfInstalments": { "type": "string", "example": "36", "description": "Types.Contract.NumberOfInstalments (see legacy documentation)" }, "Relations.Amounts.StandardPeriodicalInstalment": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "909000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.StandardPeriodicalInstalment (see legacy documentation)" }, "Relations.Amounts.Overdue": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Overdue (see legacy documentation)" }, "Relations.Amounts.Outstanding": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Outstanding (see legacy documentation)" } }, "description": "Relations.Contracts.InstalmentDetails (see legacy documentation)" }, "Reports.HistoricalCalendar.Instalment": { "type": "object", "properties": { "Reports.HistoricalCalendar.InstalmentRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "139703", "description": "_key (see legacy documentation)" }, "Reports.HistoricalCalendar.Month": { "type": "string", "example": "3", "description": "Reports.HistoricalCalendar.Month (see legacy documentation)" }, "Reports.HistoricalCalendar.Year": { "type": "string", "example": "1397", "description": "Reports.HistoricalCalendar.Year (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.Instalment (see legacy documentation)" }, "Reports.ContractData.GeneralInformation": { "type": "object", "properties": { "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.NoNegativeStatus", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Relations.Contracts.Dates": { "type": "object", "properties": { "Types.Contract.Dates.Start": { "type": "string", "example": "2013-05-17T19:30:00Z", "description": "Types.Contract.Dates.Start (see legacy documentation)" }, "Types.Contract.Dates.ExpectedEnd": { "type": "string", "example": "2016-05-16T19:30:00Z", "description": "Types.Contract.Dates.ExpectedEnd (see legacy documentation)" }, "Types.Contract.Dates.RealEnd": { "type": "string", "example": "2016-05-16T19:30:00Z", "description": "Types.Contract.Dates.RealEnd (see legacy documentation)" } }, "description": "Relations.Contracts.Dates (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "Lookups.PurposeOfTheCredit": { "type": "string", "example": "PurposeOfTheCredit.Others", "description": "Lookups.PurposeOfTheCredit (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.DebtorMainApplicant", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" }, "Reports.ContractData.Creditor": { "type": "string", "example": "بانک ملت", "description": "Reports.ContractData.Creditor (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2016-05-19T00:00:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Lookups.PhaseOfOperation": { "type": "string", "example": "PhaseOfOperation.TerminatedAccordingTheContract", "description": "Lookups.PhaseOfOperation (see legacy documentation)" } }, "description": "Reports.ContractData.GeneralInformation (see legacy documentation)" }, "Reports.ContractData.ConnectedSubjects": { "type": "object", "properties": { "Reports.ContractData.ConnectedSubject": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Reports.ContractData.ConnectedIndividuals": { "type": "object", "properties": { "Types.Subject.Individual.PersonalCode": { "type": "string", "example": "2296547699", "description": "Types.Subject.Individual.PersonalCode (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.Guarantor", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" } }, "description": "Reports.ContractData.ConnectedIndividuals (see legacy documentation)" } }, "description": "Reports.ContractData.ConnectedSubject (see legacy documentation)" } }, "description": "Reports.ContractData.ConnectedSubjects (see legacy documentation)" } }, "description": "Reports.ContractData.Instalment (see legacy documentation)" }, "description": "Reports.ContractData.Instalment (see legacy documentation)" } }, "description": "Reports.ContractData.Instalments (see legacy documentation)" } }, "description": "Reports.ContractData.TerminatedOperationsDebtor (see legacy documentation)" } }, "description": "Reports.BaseDataOperations (see legacy documentation)" }, "Reports.SubjectData.IDs": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Reports.SubjectData.IDs (see legacy documentation)" }, "Reports.Lookups.ReportStatus": { "type": "string", "example": "ReportStatus.OK", "description": "Reports.Lookups.ReportStatus (see legacy documentation)" }, "Reports.SummaryReport": { "type": "object", "properties": { "Reports.Lookups.ReportStatus": { "type": "string", "example": "ReportStatus.OK", "description": "Reports.Lookups.ReportStatus (see legacy documentation)" }, "NegativeStatusesAndInquiries": { "type": "object", "properties": { "NumberOfInquiries": { "type": "object", "properties": { "NumberOfInquiriesRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "Bank", "description": "_key (see legacy documentation)" }, "Lookups.SubscriberType": { "type": "string", "example": "SubscriberType.Bank", "description": "Lookups.SubscriberType (see legacy documentation)" }, "Last1Month": { "type": "string", "example": "0", "description": "Last1Month (see legacy documentation)" }, "Last1Year": { "type": "string", "example": "0", "description": "Last1Year (see legacy documentation)" } }, "description": "NumberOfInquiriesRecord (see legacy documentation)" }, "description": "NumberOfInquiriesRecord (see legacy documentation)" } }, "description": "NumberOfInquiries (see legacy documentation)" } }, "description": "NegativeStatusesAndInquiries (see legacy documentation)" }, "PersonalInformation": { "type": "object", "properties": { "PersonalCode": { "type": "string", "example": "0075511037", "description": "PersonalCode (see legacy documentation)" }, "FirstName": { "type": "string", "example": "رضا", "description": "FirstName (see legacy documentation)" }, "Surname": { "type": "string", "example": "حسینی نژاد", "description": "Surname (see legacy documentation)" }, "FathersName": { "type": "string", "example": "علی", "description": "FathersName (see legacy documentation)" }, "DateOfBirth": { "type": "string", "example": "1984-08-08T19:30:00Z", "description": "DateOfBirth (see legacy documentation)" }, "PlaceOfBirth": { "type": "string", "example": "10001", "description": "PlaceOfBirth (see legacy documentation)" }, "Lookups.Gender": { "type": "string", "example": "Gender.Male", "description": "Lookups.Gender (see legacy documentation)" }, "Lookups.MaritalStatus": { "type": "string", "example": "MaritalStatus.Married", "description": "Lookups.MaritalStatus (see legacy documentation)" } }, "description": "PersonalInformation (see legacy documentation)" }, "AddressAndContactInformation": { "type": "object", "properties": { "HomeAddress": { "type": "string", "example": "تهران خ ايران ك فياض بخش ك كريمي ك شفيعي پ45", "description": "HomeAddress (see legacy documentation)" }, "MobilePhones": { "type": "object", "properties": { "MobilePhone": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "ContactValue": { "type": "string", "example": "09122718615", "description": "ContactValue (see legacy documentation)" } }, "description": "MobilePhone (see legacy documentation)" } }, "description": "MobilePhones (see legacy documentation)" }, "Faxes": { "type": "object", "properties": { "Fax": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "ContactValue": { "type": "string", "example": "-", "description": "ContactValue (see legacy documentation)" } }, "description": "Fax (see legacy documentation)" } }, "description": "Faxes (see legacy documentation)" }, "HomePhones": { "type": "object", "properties": { "HomePhone": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "ContactValue": { "type": "string", "example": "02133554546-09122718615", "description": "ContactValue (see legacy documentation)" } }, "description": "HomePhone (see legacy documentation)" }, "description": "HomePhone (see legacy documentation)" } }, "description": "HomePhones (see legacy documentation)" } }, "description": "AddressAndContactInformation (see legacy documentation)" }, "ContractsSummary": { "type": "object", "properties": { "Contracts": { "type": "object", "properties": { "ContractRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.TypeOfContract": { "type": "string", "example": "TypeOfContract.Instalment", "description": "Lookups.TypeOfContract (see legacy documentation)" }, "Products.Types.Subscriber": { "type": "string", "example": "Melat", "description": "Products.Types.Subscriber (see legacy documentation)" }, "Products.Types.SubscriberLocalName": { "type": "string", "example": "بانک ملت", "description": "Products.Types.SubscriberLocalName (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "NumberOfOpenContracts": { "type": "string", "example": "0", "description": "NumberOfOpenContracts (see legacy documentation)" }, "NumberOfTerminatedContracts": { "type": "string", "example": "1", "description": "NumberOfTerminatedContracts (see legacy documentation)" }, "OutstandingAmount": { "type": "string", "example": "0", "description": "OutstandingAmount (see legacy documentation)" }, "OverdueAmount": { "type": "string", "example": "0", "description": "OverdueAmount (see legacy documentation)" } }, "description": "ContractRecord (see legacy documentation)" }, "description": "ContractRecord (see legacy documentation)" }, "TotalRecord": { "type": "object", "properties": { "_key": { "type": "string", "example": "2", "description": "_key (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "NumberOfOpenContracts": { "type": "string", "example": "0", "description": "NumberOfOpenContracts (see legacy documentation)" }, "NumberOfTerminatedContracts": { "type": "string", "example": "3", "description": "NumberOfTerminatedContracts (see legacy documentation)" }, "OutstandingAmount": { "type": "string", "example": "0", "description": "OutstandingAmount (see legacy documentation)" }, "OverdueAmount": { "type": "string", "example": "0", "description": "OverdueAmount (see legacy documentation)" } }, "description": "TotalRecord (see legacy documentation)" } }, "description": "Contracts (see legacy documentation)" } }, "description": "ContractsSummary (see legacy documentation)" }, "SubjectRoles": { "type": "object", "properties": { "SubjectRoleRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.DebtorMainApplicant", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" }, "NumberOfContracts": { "type": "string", "example": "0", "description": "NumberOfContracts (see legacy documentation)" } }, "description": "SubjectRoleRecord (see legacy documentation)" }, "description": "SubjectRoleRecord (see legacy documentation)" } }, "description": "SubjectRoles (see legacy documentation)" }, "ReportDate": { "type": "string", "example": "2019-06-11T05:15:15.3173883Z", "description": "ReportDate (see legacy documentation)" } }, "description": "Reports.SummaryReport (see legacy documentation)" } }, "description": "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.StandardIndividualReport.Response (see legacy documentation)" }, "score": { "type": "string", "example": "-1", "description": "آرایه‌ای از رتبه‌بندی کاربر" }, "riskGrade": { "type": "string", "example": "RiskGrade.XX", "description": "riskGrade (see legacy documentation)" }, "scoreRange": { "type": "string", "example": "-1", "description": "scoreRange (see legacy documentation)" }, "scoreDescription": { "type": "string", "example": "ExcludedFromScoring", "description": "scoreDescription (see legacy documentation)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_standardReliability_get_v3_hiddenResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "4a12a4ce-10ab-49fe-b542-9bc00501c8f6", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "result": { "type": "object", "properties": { "result": { "type": "object", "properties": { "State": { "type": "integer", "example": 1, "description": "State (see legacy documentation)" }, "Valid": { "type": "boolean", "example": true, "description": "Valid (see legacy documentation)" }, "Score": { "type": "object", "properties": { "Commands": { "type": "object", "properties": { "Command": { "type": "object", "properties": { "_identifier": { "type": "string", "example": "1", "description": "_identifier (see legacy documentation)" }, "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.ScoringIndividualReport.Response": { "type": "object", "properties": { "Reports.PersonalInformation": { "type": "object", "properties": { "PersonalCode": { "type": "string", "example": "0011001100", "description": "PersonalCode (see legacy documentation)" }, "FathersName": { "type": "string", "example": "اصغر", "description": "FathersName (see legacy documentation)" }, "FirstName": { "type": "string", "example": "فاطمه", "description": "FirstName (see legacy documentation)" }, "Surname": { "type": "string", "example": "تستی", "description": "Surname (see legacy documentation)" }, "Lookups.Gender": { "type": "string", "example": "Gender.Female", "description": "Lookups.Gender (see legacy documentation)" }, "DateOfBirth": { "type": "string", "example": "1982-09-02T19:30:00Z", "description": "DateOfBirth (see legacy documentation)" } }, "description": "Reports.PersonalInformation (see legacy documentation)" }, "Reports.Lookups.ReportStatus": { "type": "string", "example": "ReportStatus.OK", "description": "Reports.Lookups.ReportStatus (see legacy documentation)" }, "Reports.ScoringInformation": { "type": "object", "properties": { "ICSScore": { "type": "string", "example": "556", "description": "ICSScore (see legacy documentation)" }, "RiskGrade": { "type": "string", "example": "RiskGrade.C2", "description": "RiskGrade (see legacy documentation)" }, "ReasonCodes": { "type": "object", "properties": { "ReasonCodeList": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "ReasonCode": { "type": "string", "example": "CIPSReasonCodes.AGE1", "description": "ReasonCode (see legacy documentation)" } }, "description": "ReasonCodeList (see legacy documentation)" }, "description": "ReasonCodeList (see legacy documentation)" } }, "description": "ReasonCodes (see legacy documentation)" }, "ScoreRange": { "type": "string", "example": "540 - 559", "description": "ScoreRange (see legacy documentation)" }, "ScoreDescription": { "type": "string", "example": "ScoreDescription.AverageRisk", "description": "ScoreDescription (see legacy documentation)" } }, "description": "Reports.ScoringInformation (see legacy documentation)" }, "ScoringReportComments": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "ScoringReportComments (see legacy documentation)" }, "ReportDate": { "type": "string", "example": "2019-09-22T10:23:08.9727303Z", "description": "ReportDate (see legacy documentation)" } }, "description": "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.ScoringIndividualReport.Response (see legacy documentation)" } }, "description": "Command (see legacy documentation)" } }, "description": "Commands (see legacy documentation)" } }, "description": "Score (see legacy documentation)" }, "Report": { "type": "object", "properties": { "Commands": { "type": "object", "properties": { "Command": { "type": "object", "properties": { "_identifier": { "type": "string", "example": "1", "description": "_identifier (see legacy documentation)" }, "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.StandardIndividualReport.Response": { "type": "object", "properties": { "Reports.EmptyIndividualData": { "type": "object", "properties": { "Types.Subject.Individual.PersonalCode": { "type": "string", "example": "0011001100", "description": "Types.Subject.Individual.PersonalCode (see legacy documentation)" } }, "description": "Reports.EmptyIndividualData (see legacy documentation)" }, "Reports.BasicIndividualData": { "type": "object", "properties": { "Relations.Subjects.PersonalData": { "type": "object", "properties": { "Types.Subject.Individual.FarthersName": { "type": "string", "example": "اصغر", "description": "Types.Subject.Individual.FarthersName (see legacy documentation)" }, "Types.Subject.Individual.FirstName": { "type": "string", "example": "فاطمه", "description": "Types.Subject.Individual.FirstName (see legacy documentation)" }, "Types.Subject.Individual.Surname": { "type": "string", "example": "تستی", "description": "Types.Subject.Individual.Surname (see legacy documentation)" }, "Lookups.Gender": { "type": "string", "example": "Gender.Female", "description": "Lookups.Gender (see legacy documentation)" }, "Lookups.MaritalStatus": { "type": "string", "example": "MaritalStatus.Single", "description": "Lookups.MaritalStatus (see legacy documentation)" }, "Lookups.BorrowerClassification": { "type": "string", "example": "BorrowerClassification.Individual", "description": "Lookups.BorrowerClassification (see legacy documentation)" } }, "description": "Relations.Subjects.PersonalData (see legacy documentation)" }, "Relations.Subjects.BirthData": { "type": "object", "properties": { "Types.Subject.BirthData.BirthSurname": { "type": "string", "example": "تستی", "description": "Types.Subject.BirthData.BirthSurname (see legacy documentation)" }, "Types.Subject.BirthData.DateOfBirth": { "type": "string", "example": "1982-09-02T19:30:00Z", "description": "Types.Subject.BirthData.DateOfBirth (see legacy documentation)" }, "Types.Subject.BirthData.PlaceOfBirth": { "type": "string", "example": "54002", "description": "Types.Subject.BirthData.PlaceOfBirth (see legacy documentation)" }, "Lookups.CountryOfBirth": { "type": "string", "example": "CountryCodes.IR", "description": "Lookups.CountryOfBirth (see legacy documentation)" } }, "description": "Relations.Subjects.BirthData (see legacy documentation)" }, "Reports.SubjectData.Current.NegativeSubjectStatus": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "00", "description": "_key (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2017-03-19T19:30:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Lookups.NegativeSubjectStatus": { "type": "string", "example": "NegativeStatusOfSubject.NoNegativeStatus", "description": "Lookups.NegativeSubjectStatus (see legacy documentation)" }, "Reports.Creditor": { "type": "string", "example": "بانک ملی", "description": "Reports.Creditor (see legacy documentation)" } }, "description": "Reports.SubjectData.Current.NegativeSubjectStatus (see legacy documentation)" }, "description": "Reports.SubjectData.Current.NegativeSubjectStatus (see legacy documentation)" } }, "description": "Reports.BasicIndividualData (see legacy documentation)" }, "Reports.SubjectData.AddressesIndividual": { "type": "object", "properties": { "Reports.Addresses.PermanentAddress": { "type": "object", "properties": { "_key": { "type": "string", "example": "1", "description": "_key (see legacy documentation)" }, "Relations.Addresses.AddressTypeChoice": { "type": "object", "properties": { "Relations.Addresses.TextAddress": { "type": "object", "properties": { "Types.Subject.Address.TextAddress": { "type": "string", "example": "اطلاعات هدف مندي", "description": "Types.Subject.Address.TextAddress (see legacy documentation)" } }, "description": "Relations.Addresses.TextAddress (see legacy documentation)" } }, "description": "Relations.Addresses.AddressTypeChoice (see legacy documentation)" } }, "description": "Reports.Addresses.PermanentAddress (see legacy documentation)" } }, "description": "Reports.SubjectData.AddressesIndividual (see legacy documentation)" }, "Reports.SubjectData.Contacts": { "type": "object", "properties": { "Reports.Contacts.Cellular": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Types.Subject.Communication.ContactNumber": { "type": "string", "example": "09192760754", "description": "Types.Subject.Communication.ContactNumber (see legacy documentation)" } }, "description": "Reports.Contacts.Cellular (see legacy documentation)" }, "Reports.Contacts.Phone": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Types.Subject.Communication.ContactNumber": { "type": "string", "example": "-", "description": "Types.Subject.Communication.ContactNumber (see legacy documentation)" } }, "description": "Reports.Contacts.Phone (see legacy documentation)" } }, "description": "Reports.SubjectData.Contacts (see legacy documentation)" }, "Reports.Inquiries": { "type": "object", "properties": { "Reports.Inquiries.LastMonth": { "type": "string", "example": "16", "description": "Reports.Inquiries.LastMonth (see legacy documentation)" }, "Reports.Inquiries.ThreeMonths": { "type": "string", "example": "16", "description": "Reports.Inquiries.ThreeMonths (see legacy documentation)" }, "Reports.Inquiries.SixMonths": { "type": "string", "example": "16", "description": "Reports.Inquiries.SixMonths (see legacy documentation)" }, "Reports.Inquiries.TwelveMonths": { "type": "string", "example": "16", "description": "Reports.Inquiries.TwelveMonths (see legacy documentation)" } }, "description": "Reports.Inquiries (see legacy documentation)" }, "Reports.Summary": { "type": "object", "properties": { "Reports.Summary.TotalDebtOverdue": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalDebtOverdue (see legacy documentation)" }, "Reports.Summary.TotalNumberOfUnpaidInstalments": { "type": "string", "example": "0", "description": "Reports.Summary.TotalNumberOfUnpaidInstalments (see legacy documentation)" }, "Reports.Summary.TotalOutstandingAmount": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "39583333.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalOutstandingAmount (see legacy documentation)" }, "Reports.Summary.NumberOfExistingOperations": { "type": "string", "example": "2", "description": "Reports.Summary.NumberOfExistingOperations (see legacy documentation)" }, "Reports.Summary.NumberOfTerminatedOperations": { "type": "string", "example": "0", "description": "Reports.Summary.NumberOfTerminatedOperations (see legacy documentation)" }, "Reports.Summary.NegativeStatusReported": { "type": "object", "properties": { "_key": { "type": "string", "example": "00", "description": "_key (see legacy documentation)" }, "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.DoubtfulDebt", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2018-07-10T19:30:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Reports.Creditor": { "type": "string", "example": "صندوق علوم", "description": "Reports.Creditor (see legacy documentation)" } }, "description": "Reports.Summary.NegativeStatusReported (see legacy documentation)" } }, "description": "Reports.Summary (see legacy documentation)" }, "Reports.SummaryCreditors": { "type": "object", "properties": { "Reports.SummaryCreditor": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "11", "description": "_key (see legacy documentation)" }, "Reports.Creditor": { "type": "string", "example": "بانک ملی", "description": "Reports.Creditor (see legacy documentation)" }, "Reports.Summary.TotalDebtOverdue": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalDebtOverdue (see legacy documentation)" }, "Reports.Summary.TotalNumberOfUnpaidInstalments": { "type": "string", "example": "0", "description": "Reports.Summary.TotalNumberOfUnpaidInstalments (see legacy documentation)" }, "Reports.Summary.TotalOutstandingAmount": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "39583333.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalOutstandingAmount (see legacy documentation)" }, "Reports.Summary.NumberOfExistingOperations": { "type": "string", "example": "1", "description": "Reports.Summary.NumberOfExistingOperations (see legacy documentation)" }, "Reports.Summary.NumberOfTerminatedOperations": { "type": "string", "example": "0", "description": "Reports.Summary.NumberOfTerminatedOperations (see legacy documentation)" } }, "description": "Reports.SummaryCreditor (see legacy documentation)" }, "description": "Reports.SummaryCreditor (see legacy documentation)" } }, "description": "Reports.SummaryCreditors (see legacy documentation)" }, "Reports.BaseDataOperations": { "type": "object", "properties": { "Reports.ContractData.ExistingOperationsDebtor": { "type": "object", "properties": { "Reports.ContractData.Instalments": { "type": "object", "properties": { "Reports.ContractData.Instalment": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Relations.Contracts.InstalmentDetails": { "type": "object", "properties": { "Lookups.TypeOfFinancingInstalments": { "type": "string", "example": "TypeOfFinancingInstalments.QarzAlHassaneh", "description": "Lookups.TypeOfFinancingInstalments (see legacy documentation)" }, "Lookups.TypeOfInstalments": { "type": "string", "example": "TypeOfInstalments.Fixed", "description": "Lookups.TypeOfInstalments (see legacy documentation)" }, "Lookups.PeriodicityOfPayments": { "type": "string", "example": "PeriodicityOfPayments.AtTheFinalDayOfThePeriodOfContract", "description": "Lookups.PeriodicityOfPayments (see legacy documentation)" }, "Lookups.MethodOfPayment": { "type": "string", "example": "MethodOfPayment.DirectRemittance", "description": "Lookups.MethodOfPayment (see legacy documentation)" }, "Relations.Amounts.TotalCredit": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "100000000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.TotalCredit (see legacy documentation)" }, "Types.Contract.NumberOfInstalments": { "type": "string", "example": "48", "description": "Types.Contract.NumberOfInstalments (see legacy documentation)" }, "Relations.Amounts.StandardPeriodicalInstalment": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "2083333.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.StandardPeriodicalInstalment (see legacy documentation)" }, "Relations.Amounts.Overdue": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Overdue (see legacy documentation)" }, "Types.Contract.OutstandingInstalments": { "type": "string", "example": "19", "description": "Types.Contract.OutstandingInstalments (see legacy documentation)" }, "Relations.Amounts.Outstanding": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "39583333.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Outstanding (see legacy documentation)" } }, "description": "Relations.Contracts.InstalmentDetails (see legacy documentation)" }, "Reports.HistoricalCalendar.Instalment": { "type": "object", "properties": { "Reports.HistoricalCalendar.InstalmentRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "139706", "description": "_key (see legacy documentation)" }, "Relations.Amounts.Overdue": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "6000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Overdue (see legacy documentation)" }, "Reports.HistoricalCalendar.Month": { "type": "string", "example": "6", "description": "Reports.HistoricalCalendar.Month (see legacy documentation)" }, "Reports.HistoricalCalendar.Year": { "type": "string", "example": "1397", "description": "Reports.HistoricalCalendar.Year (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.Instalment (see legacy documentation)" }, "Reports.ContractData.GeneralInformation": { "type": "object", "properties": { "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.NoNegativeStatus", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Relations.Contracts.Dates": { "type": "object", "properties": { "Types.Contract.Dates.Start": { "type": "string", "example": "2017-02-24T20:30:00Z", "description": "Types.Contract.Dates.Start (see legacy documentation)" }, "Types.Contract.Dates.ExpectedEnd": { "type": "string", "example": "2021-02-24T20:30:00Z", "description": "Types.Contract.Dates.ExpectedEnd (see legacy documentation)" } }, "description": "Relations.Contracts.Dates (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "Lookups.PurposeOfTheCredit": { "type": "string", "example": "PurposeOfTheCredit.Others", "description": "Lookups.PurposeOfTheCredit (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.DebtorMainApplicant", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" }, "Reports.ContractData.Creditor": { "type": "string", "example": "بانک ملی", "description": "Reports.ContractData.Creditor (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2019-08-21T00:00:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Lookups.PhaseOfOperation": { "type": "string", "example": "PhaseOfOperation.Existing", "description": "Lookups.PhaseOfOperation (see legacy documentation)" } }, "description": "Reports.ContractData.GeneralInformation (see legacy documentation)" }, "Reports.ContractData.ConnectedSubjects": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Reports.ContractData.ConnectedSubjects (see legacy documentation)" }, "Reports.ContractData.Collaterals": { "type": "object", "properties": { "Reports.ContractData.Collateral": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.TypeOfGuarantee": { "type": "string", "example": "GuaranteeType.CollateralToBeProvidedInFuture", "description": "Lookups.TypeOfGuarantee (see legacy documentation)" }, "Relations.Amounts.Guarantee": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "120000000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Guarantee (see legacy documentation)" } }, "description": "Reports.ContractData.Collateral (see legacy documentation)" } }, "description": "Reports.ContractData.Collaterals (see legacy documentation)" } }, "description": "Reports.ContractData.Instalment (see legacy documentation)" } }, "description": "Reports.ContractData.Instalments (see legacy documentation)" } }, "description": "Reports.ContractData.ExistingOperationsDebtor (see legacy documentation)" }, "Reports.ContractData.TerminatedOperationsDebtor": { "type": "object", "properties": { "Reports.ContractData.Instalments": { "type": "object", "properties": { "Reports.ContractData.Instalment": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Relations.Contracts.InstalmentDetails": { "type": "object", "properties": { "Lookups.TypeOfFinancingInstalments": { "type": "string", "example": "TypeOfFinancingInstalments.QarzAlHassaneh", "description": "Lookups.TypeOfFinancingInstalments (see legacy documentation)" }, "Lookups.TypeOfInstalments": { "type": "string", "example": "TypeOfInstalments.Fixed", "description": "Lookups.TypeOfInstalments (see legacy documentation)" }, "Lookups.PeriodicityOfPayments": { "type": "string", "example": "PeriodicityOfPayments.MonthlyInstalments30Days", "description": "Lookups.PeriodicityOfPayments (see legacy documentation)" }, "Lookups.MethodOfPayment": { "type": "string", "example": "MethodOfPayment.DirectRemittance", "description": "Lookups.MethodOfPayment (see legacy documentation)" }, "Relations.Amounts.TotalCredit": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "15975000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.TotalCredit (see legacy documentation)" }, "Types.Contract.NumberOfInstalments": { "type": "string", "example": "60", "description": "Types.Contract.NumberOfInstalments (see legacy documentation)" }, "Relations.Amounts.StandardPeriodicalInstalment": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "266250.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.StandardPeriodicalInstalment (see legacy documentation)" }, "Relations.Amounts.Overdue": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Overdue (see legacy documentation)" }, "Relations.Amounts.Outstanding": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Outstanding (see legacy documentation)" } }, "description": "Relations.Contracts.InstalmentDetails (see legacy documentation)" }, "Reports.HistoricalCalendar.Instalment": { "type": "object", "properties": { "Reports.HistoricalCalendar.InstalmentRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "139706", "description": "_key (see legacy documentation)" }, "Relations.Amounts.Overdue": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Overdue (see legacy documentation)" }, "Reports.HistoricalCalendar.Month": { "type": "string", "example": "6", "description": "Reports.HistoricalCalendar.Month (see legacy documentation)" }, "Reports.HistoricalCalendar.Year": { "type": "string", "example": "1397", "description": "Reports.HistoricalCalendar.Year (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.Instalment (see legacy documentation)" }, "Reports.ContractData.GeneralInformation": { "type": "object", "properties": { "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.NoNegativeStatus", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Relations.Contracts.Dates": { "type": "object", "properties": { "Types.Contract.Dates.Start": { "type": "string", "example": "2018-01-09T20:30:00Z", "description": "Types.Contract.Dates.Start (see legacy documentation)" }, "Types.Contract.Dates.ExpectedEnd": { "type": "string", "example": "2022-12-14T20:30:00Z", "description": "Types.Contract.Dates.ExpectedEnd (see legacy documentation)" }, "Types.Contract.Dates.RealEnd": { "type": "string", "example": "2018-09-04T19:30:00Z", "description": "Types.Contract.Dates.RealEnd (see legacy documentation)" } }, "description": "Relations.Contracts.Dates (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "Lookups.PurposeOfTheCredit": { "type": "string", "example": "PurposeOfTheCredit.Others", "description": "Lookups.PurposeOfTheCredit (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.DebtorMainApplicant", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" }, "Reports.ContractData.Creditor": { "type": "string", "example": "صندوق علوم", "description": "Reports.ContractData.Creditor (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2018-09-04T00:00:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Lookups.PhaseOfOperation": { "type": "string", "example": "PhaseOfOperation.TerminatedAccordingTheContract", "description": "Lookups.PhaseOfOperation (see legacy documentation)" } }, "description": "Reports.ContractData.GeneralInformation (see legacy documentation)" }, "Reports.ContractData.ConnectedSubjects": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Reports.ContractData.ConnectedSubjects (see legacy documentation)" } }, "description": "Reports.ContractData.Instalment (see legacy documentation)" } }, "description": "Reports.ContractData.Instalments (see legacy documentation)" } }, "description": "Reports.ContractData.TerminatedOperationsDebtor (see legacy documentation)" } }, "description": "Reports.BaseDataOperations (see legacy documentation)" }, "Reports.SubjectData.IDs": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Reports.SubjectData.IDs (see legacy documentation)" }, "Reports.Lookups.ReportStatus": { "type": "string", "example": "ReportStatus.OK", "description": "Reports.Lookups.ReportStatus (see legacy documentation)" }, "Reports.SummaryReport": { "type": "object", "properties": { "Reports.Lookups.ReportStatus": { "type": "string", "example": "ReportStatus.OK", "description": "Reports.Lookups.ReportStatus (see legacy documentation)" }, "NegativeStatusesAndInquiries": { "type": "object", "properties": { "NumberOfInquiries": { "type": "object", "properties": { "NumberOfInquiriesRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "Bank", "description": "_key (see legacy documentation)" }, "Lookups.SubscriberType": { "type": "string", "example": "SubscriberType.Bank", "description": "Lookups.SubscriberType (see legacy documentation)" }, "Last1Month": { "type": "string", "example": "0", "description": "Last1Month (see legacy documentation)" }, "Last1Year": { "type": "string", "example": "0", "description": "Last1Year (see legacy documentation)" } }, "description": "NumberOfInquiriesRecord (see legacy documentation)" }, "description": "NumberOfInquiriesRecord (see legacy documentation)" } }, "description": "NumberOfInquiries (see legacy documentation)" } }, "description": "NegativeStatusesAndInquiries (see legacy documentation)" }, "PersonalInformation": { "type": "object", "properties": { "PersonalCode": { "type": "string", "example": "0011001100", "description": "PersonalCode (see legacy documentation)" }, "FirstName": { "type": "string", "example": "فاطمه", "description": "FirstName (see legacy documentation)" }, "Surname": { "type": "string", "example": "تستی", "description": "Surname (see legacy documentation)" }, "FathersName": { "type": "string", "example": "اصغر", "description": "FathersName (see legacy documentation)" }, "DateOfBirth": { "type": "string", "example": "1987-09-02T19:30:00Z", "description": "DateOfBirth (see legacy documentation)" }, "PlaceOfBirth": { "type": "string", "example": "54002", "description": "PlaceOfBirth (see legacy documentation)" }, "Lookups.Gender": { "type": "string", "example": "Gender.Female", "description": "Lookups.Gender (see legacy documentation)" }, "Lookups.MaritalStatus": { "type": "string", "example": "MaritalStatus.Single", "description": "Lookups.MaritalStatus (see legacy documentation)" } }, "description": "PersonalInformation (see legacy documentation)" }, "AddressAndContactInformation": { "type": "object", "properties": { "HomeAddress": { "type": "string", "example": "اطلاعات هدف مندي", "description": "HomeAddress (see legacy documentation)" }, "MobilePhones": { "type": "object", "properties": { "MobilePhone": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "ContactValue": { "type": "string", "example": "09190000754", "description": "ContactValue (see legacy documentation)" } }, "description": "MobilePhone (see legacy documentation)" } }, "description": "MobilePhones (see legacy documentation)" }, "HomePhones": { "type": "object", "properties": { "HomePhone": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "ContactValue": { "type": "string", "example": "-", "description": "ContactValue (see legacy documentation)" } }, "description": "HomePhone (see legacy documentation)" } }, "description": "HomePhones (see legacy documentation)" } }, "description": "AddressAndContactInformation (see legacy documentation)" }, "ContractsSummary": { "type": "object", "properties": { "Contracts": { "type": "object", "properties": { "ContractRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.TypeOfContract": { "type": "string", "example": "TypeOfContract.Instalment", "description": "Lookups.TypeOfContract (see legacy documentation)" }, "Products.Types.Subscriber": { "type": "string", "example": "Melli", "description": "Products.Types.Subscriber (see legacy documentation)" }, "Products.Types.SubscriberLocalName": { "type": "string", "example": "بانک ملی", "description": "Products.Types.SubscriberLocalName (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "NumberOfOpenContracts": { "type": "string", "example": "1", "description": "NumberOfOpenContracts (see legacy documentation)" }, "NumberOfTerminatedContracts": { "type": "string", "example": "0", "description": "NumberOfTerminatedContracts (see legacy documentation)" }, "OutstandingAmount": { "type": "string", "example": "39583333.0000", "description": "OutstandingAmount (see legacy documentation)" }, "OverdueAmount": { "type": "string", "example": "0.0000", "description": "OverdueAmount (see legacy documentation)" } }, "description": "ContractRecord (see legacy documentation)" }, "description": "ContractRecord (see legacy documentation)" }, "TotalRecord": { "type": "object", "properties": { "_key": { "type": "string", "example": "2", "description": "_key (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "NumberOfOpenContracts": { "type": "string", "example": "1", "description": "NumberOfOpenContracts (see legacy documentation)" }, "NumberOfTerminatedContracts": { "type": "string", "example": "1", "description": "NumberOfTerminatedContracts (see legacy documentation)" }, "OutstandingAmount": { "type": "string", "example": "39583333.0000", "description": "OutstandingAmount (see legacy documentation)" }, "OverdueAmount": { "type": "string", "example": "0.0000", "description": "OverdueAmount (see legacy documentation)" } }, "description": "TotalRecord (see legacy documentation)" } }, "description": "Contracts (see legacy documentation)" } }, "description": "ContractsSummary (see legacy documentation)" }, "SubjectRoles": { "type": "object", "properties": { "SubjectRoleRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.DebtorMainApplicant", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" }, "NumberOfContracts": { "type": "string", "example": "1", "description": "NumberOfContracts (see legacy documentation)" } }, "description": "SubjectRoleRecord (see legacy documentation)" }, "description": "SubjectRoleRecord (see legacy documentation)" } }, "description": "SubjectRoles (see legacy documentation)" }, "ReportDate": { "type": "string", "example": "2019-09-22T10:23:07.7213052Z", "description": "ReportDate (see legacy documentation)" } }, "description": "Reports.SummaryReport (see legacy documentation)" } }, "description": "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.StandardIndividualReport.Response (see legacy documentation)" } }, "description": "Command (see legacy documentation)" } }, "description": "Commands (see legacy documentation)" } }, "description": "Report (see legacy documentation)" }, "Errors": { "type": "string", "example": "", "description": "Errors (see legacy documentation)" } }, "description": "آبجکتی از پاسخ سرویس شامل:" } }, "description": "آبجکتی از پاسخ سرویس شامل:" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_info_get_get_hiddenResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "getUserinfo876543", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "cif": { "type": "string", "example": "0019150564", "description": "شماره مشتری کاربر" }, "nid": { "type": "string", "example": "0999876577", "description": "کد ملی کاربر" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_advanced_reliability_get_sms_getResponse": { "type": "object", "properties": { "_identifier": { "type": "string", "example": "1", "description": "_identifier (see legacy documentation)" }, "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.AdvancedIndividualReport.Response": { "type": "object", "properties": { "Reports.EmptyIndividualData": { "type": "object", "properties": { "Types.Subject.Individual.PersonalCode": { "type": "string", "example": "1754217982", "description": "Types.Subject.Individual.PersonalCode (see legacy documentation)" } }, "description": "Reports.EmptyIndividualData (see legacy documentation)" }, "Reports.BasicIndividualData": { "type": "object", "properties": { "Relations.Subjects.PersonalData": { "type": "object", "properties": { "Types.Subject.Individual.FarthersName": { "type": "string", "example": "-", "description": "Types.Subject.Individual.FarthersName (see legacy documentation)" }, "Types.Subject.Individual.FirstName": { "type": "string", "example": "مژگان", "description": "Types.Subject.Individual.FirstName (see legacy documentation)" }, "Types.Subject.Individual.Surname": { "type": "string", "example": "چراغچي", "description": "Types.Subject.Individual.Surname (see legacy documentation)" }, "Lookups.Gender": { "type": "string", "example": "Gender.Female", "description": "Lookups.Gender (see legacy documentation)" }, "Lookups.MaritalStatus": { "type": "string", "example": "MaritalStatus.Married", "description": "Lookups.MaritalStatus (see legacy documentation)" }, "Lookups.BorrowerClassification": { "type": "string", "example": "BorrowerClassification.Individual", "description": "Lookups.BorrowerClassification (see legacy documentation)" } }, "description": "Relations.Subjects.PersonalData (see legacy documentation)" }, "Relations.Subjects.BirthData": { "type": "object", "properties": { "Types.Subject.BirthData.BirthSurname": { "type": "string", "example": "چراغچي", "description": "Types.Subject.BirthData.BirthSurname (see legacy documentation)" }, "Types.Subject.BirthData.DateOfBirth": { "type": "string", "example": "1971-01-28T20:30:00Z", "description": "Types.Subject.BirthData.DateOfBirth (see legacy documentation)" }, "Types.Subject.BirthData.PlaceOfBirth": { "type": "string", "example": "65001", "description": "Types.Subject.BirthData.PlaceOfBirth (see legacy documentation)" }, "Lookups.CountryOfBirth": { "type": "string", "example": "CountryCodes.IR", "description": "Lookups.CountryOfBirth (see legacy documentation)" } }, "description": "Relations.Subjects.BirthData (see legacy documentation)" }, "Reports.SubjectData.Current.NegativeSubjectStatus": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "00", "description": "_key (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2012-12-20T08:00:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Lookups.NegativeSubjectStatus": { "type": "string", "example": "NegativeStatusOfSubject.NoNegativeStatus", "description": "Lookups.NegativeSubjectStatus (see legacy documentation)" }, "Reports.Creditor": { "type": "string", "example": "بانک قرض الحسنه مهر", "description": "Reports.Creditor (see legacy documentation)" } }, "description": "Reports.SubjectData.Current.NegativeSubjectStatus (see legacy documentation)" }, "description": "Reports.SubjectData.Current.NegativeSubjectStatus (see legacy documentation)" } }, "description": "Reports.BasicIndividualData (see legacy documentation)" }, "Reports.AdvancedIndividualData": { "type": "object", "properties": { "Relations.Subjects.AdditionalData": { "type": "object", "properties": { "Relations.Subjects.Employment": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Relations.Subjects.Employment (see legacy documentation)" } }, "description": "Relations.Subjects.AdditionalData (see legacy documentation)" } }, "description": "Reports.AdvancedIndividualData (see legacy documentation)" }, "Reports.SubjectData.AddressesIndividual": { "type": "object", "properties": { "Reports.Addresses.PermanentAddress": { "type": "object", "properties": { "_key": { "type": "string", "example": "1", "description": "_key (see legacy documentation)" }, "Relations.Addresses.AddressTypeChoice": { "type": "object", "properties": { "Relations.Addresses.TextAddress": { "type": "object", "properties": { "Types.Subject.Address.TextAddress": { "type": "string", "example": "-", "description": "Types.Subject.Address.TextAddress (see legacy documentation)" } }, "description": "Relations.Addresses.TextAddress (see legacy documentation)" } }, "description": "Relations.Addresses.AddressTypeChoice (see legacy documentation)" } }, "description": "Reports.Addresses.PermanentAddress (see legacy documentation)" } }, "description": "Reports.SubjectData.AddressesIndividual (see legacy documentation)" }, "Reports.SubjectData.Contacts": { "type": "object", "properties": { "Reports.Contacts.Cellular": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Types.Subject.Communication.ContactNumber": { "type": "string", "example": "09335846393", "description": "Types.Subject.Communication.ContactNumber (see legacy documentation)" } }, "description": "Reports.Contacts.Cellular (see legacy documentation)" }, "Reports.Contacts.Phone": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Types.Subject.Communication.ContactNumber": { "type": "string", "example": "-", "description": "Types.Subject.Communication.ContactNumber (see legacy documentation)" } }, "description": "Reports.Contacts.Phone (see legacy documentation)" }, "description": "Reports.Contacts.Phone (see legacy documentation)" } }, "description": "Reports.SubjectData.Contacts (see legacy documentation)" }, "Reports.Inquiries": { "type": "object", "properties": { "Reports.Inquiries.LastMonth": { "type": "string", "example": "0", "description": "Reports.Inquiries.LastMonth (see legacy documentation)" }, "Reports.Inquiries.ThreeMonths": { "type": "string", "example": "4", "description": "Reports.Inquiries.ThreeMonths (see legacy documentation)" }, "Reports.Inquiries.SixMonths": { "type": "string", "example": "20", "description": "Reports.Inquiries.SixMonths (see legacy documentation)" }, "Reports.Inquiries.TwelveMonths": { "type": "string", "example": "20", "description": "Reports.Inquiries.TwelveMonths (see legacy documentation)" } }, "description": "Reports.Inquiries (see legacy documentation)" }, "Reports.Summary": { "type": "object", "properties": { "Reports.Summary.TotalDebtOverdue": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "64548258.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalDebtOverdue (see legacy documentation)" }, "Reports.Summary.TotalNumberOfUnpaidInstalments": { "type": "string", "example": "43", "description": "Reports.Summary.TotalNumberOfUnpaidInstalments (see legacy documentation)" }, "Reports.Summary.TotalOutstandingAmount": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "118843991.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalOutstandingAmount (see legacy documentation)" }, "Reports.Summary.NumberOfExistingOperations": { "type": "string", "example": "1", "description": "Reports.Summary.NumberOfExistingOperations (see legacy documentation)" }, "Reports.Summary.NumberOfTerminatedOperations": { "type": "string", "example": "1", "description": "Reports.Summary.NumberOfTerminatedOperations (see legacy documentation)" }, "Reports.Summary.NegativeStatusReported": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "00", "description": "_key (see legacy documentation)" }, "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.DoubtfulDebt", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2019-05-20T19:30:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Reports.Creditor": { "type": "string", "example": "بانک مسکن", "description": "Reports.Creditor (see legacy documentation)" } }, "description": "Reports.Summary.NegativeStatusReported (see legacy documentation)" }, "description": "Reports.Summary.NegativeStatusReported (see legacy documentation)" } }, "description": "Reports.Summary (see legacy documentation)" }, "Reports.SummaryCreditors": { "type": "object", "properties": { "Reports.SummaryCreditor": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "14", "description": "_key (see legacy documentation)" }, "Reports.Creditor": { "type": "string", "example": "بانک قرض الحسنه مهر", "description": "Reports.Creditor (see legacy documentation)" }, "Reports.Summary.TotalDebtOverdue": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalDebtOverdue (see legacy documentation)" }, "Reports.Summary.TotalNumberOfUnpaidInstalments": { "type": "string", "example": "0", "description": "Reports.Summary.TotalNumberOfUnpaidInstalments (see legacy documentation)" }, "Reports.Summary.TotalOutstandingAmount": { "type": "object", "properties": { "_key": { "type": "string", "example": "IRR", "description": "_key (see legacy documentation)" }, "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Reports.Summary.TotalOutstandingAmount (see legacy documentation)" }, "Reports.Summary.NumberOfExistingOperations": { "type": "string", "example": "0", "description": "Reports.Summary.NumberOfExistingOperations (see legacy documentation)" }, "Reports.Summary.NumberOfTerminatedOperations": { "type": "string", "example": "1", "description": "Reports.Summary.NumberOfTerminatedOperations (see legacy documentation)" } }, "description": "Reports.SummaryCreditor (see legacy documentation)" }, "description": "Reports.SummaryCreditor (see legacy documentation)" } }, "description": "Reports.SummaryCreditors (see legacy documentation)" }, "Reports.BaseDataOperations": { "type": "object", "properties": { "Reports.ContractData.ExistingOperationsDebtor": { "type": "object", "properties": { "Reports.ContractData.Instalments": { "type": "object", "properties": { "Reports.ContractData.Instalment": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Relations.Contracts.InstalmentDetails": { "type": "object", "properties": { "Lookups.TypeOfFinancingInstalments": { "type": "string", "example": "TypeOfFinancingInstalments.InstallmentSales", "description": "Lookups.TypeOfFinancingInstalments (see legacy documentation)" }, "Lookups.TypeOfInstalments": { "type": "string", "example": "TypeOfInstalments.Fixed", "description": "Lookups.TypeOfInstalments (see legacy documentation)" }, "Lookups.PeriodicityOfPayments": { "type": "string", "example": "PeriodicityOfPayments.MonthlyInstalments30Days", "description": "Lookups.PeriodicityOfPayments (see legacy documentation)" }, "Lookups.MethodOfPayment": { "type": "string", "example": "MethodOfPayment.BankingReceipt", "description": "Lookups.MethodOfPayment (see legacy documentation)" }, "Relations.Amounts.TotalCredit": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "120000000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.TotalCredit (see legacy documentation)" }, "Types.Contract.NumberOfInstalments": { "type": "string", "example": "144", "description": "Types.Contract.NumberOfInstalments (see legacy documentation)" }, "Relations.Amounts.StandardPeriodicalInstalment": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "1508000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.StandardPeriodicalInstalment (see legacy documentation)" }, "Types.Contract.OverdueInstalments": { "type": "string", "example": "43", "description": "Types.Contract.OverdueInstalments (see legacy documentation)" }, "Relations.Amounts.Overdue": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "64548258.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Overdue (see legacy documentation)" }, "Types.Contract.OutstandingInstalments": { "type": "string", "example": "65", "description": "Types.Contract.OutstandingInstalments (see legacy documentation)" }, "Relations.Amounts.Outstanding": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "118843991.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Outstanding (see legacy documentation)" } }, "description": "Relations.Contracts.InstalmentDetails (see legacy documentation)" }, "Reports.HistoricalCalendar.Instalment": { "type": "object", "properties": { "Reports.HistoricalCalendar.InstalmentRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "139703", "description": "_key (see legacy documentation)" }, "Types.Contract.OverdueInstalments": { "type": "string", "example": "32", "description": "Types.Contract.OverdueInstalments (see legacy documentation)" }, "Relations.Amounts.Overdue": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "47960258.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Overdue (see legacy documentation)" }, "Reports.HistoricalCalendar.Month": { "type": "string", "example": "3", "description": "Reports.HistoricalCalendar.Month (see legacy documentation)" }, "Reports.HistoricalCalendar.Year": { "type": "string", "example": "1397", "description": "Reports.HistoricalCalendar.Year (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.Instalment (see legacy documentation)" }, "Reports.ContractData.GeneralInformation": { "type": "object", "properties": { "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.DoubtfulDebt", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Relations.Contracts.Dates": { "type": "object", "properties": { "Types.Contract.Dates.Start": { "type": "string", "example": "2009-02-24T20:30:00Z", "description": "Types.Contract.Dates.Start (see legacy documentation)" }, "Types.Contract.Dates.ExpectedEnd": { "type": "string", "example": "2021-02-24T20:30:00Z", "description": "Types.Contract.Dates.ExpectedEnd (see legacy documentation)" } }, "description": "Relations.Contracts.Dates (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "Lookups.PurposeOfTheCredit": { "type": "string", "example": "PurposeOfTheCredit.Others", "description": "Lookups.PurposeOfTheCredit (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.DebtorMainApplicant", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" }, "Reports.ContractData.Creditor": { "type": "string", "example": "بانک مسکن", "description": "Reports.ContractData.Creditor (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2019-05-20T00:00:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Lookups.PhaseOfOperation": { "type": "string", "example": "PhaseOfOperation.Existing", "description": "Lookups.PhaseOfOperation (see legacy documentation)" } }, "description": "Reports.ContractData.GeneralInformation (see legacy documentation)" }, "Reports.ContractData.ConnectedSubjects": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Reports.ContractData.ConnectedSubjects (see legacy documentation)" }, "Reports.ContractData.Collaterals": { "type": "object", "properties": { "Reports.ContractData.Collateral": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.TypeOfGuarantee": { "type": "string", "example": "GuaranteeType.PersonalRealProperty", "description": "Lookups.TypeOfGuarantee (see legacy documentation)" }, "Relations.Amounts.Guarantee": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "180000000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Guarantee (see legacy documentation)" } }, "description": "Reports.ContractData.Collateral (see legacy documentation)" } }, "description": "Reports.ContractData.Collaterals (see legacy documentation)" } }, "description": "Reports.ContractData.Instalment (see legacy documentation)" } }, "description": "Reports.ContractData.Instalments (see legacy documentation)" } }, "description": "Reports.ContractData.ExistingOperationsDebtor (see legacy documentation)" }, "Reports.ContractData.ExistingOperationsGuarantor": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Reports.ContractData.ExistingOperationsGuarantor (see legacy documentation)" }, "Reports.ContractData.TerminatedOperationsDebtor": { "type": "object", "properties": { "Reports.ContractData.Instalments": { "type": "object", "properties": { "Reports.ContractData.Instalment": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Relations.Contracts.InstalmentDetails": { "type": "object", "properties": { "Lookups.TypeOfFinancingInstalments": { "type": "string", "example": "TypeOfFinancingInstalments.QarzAlHassaneh", "description": "Lookups.TypeOfFinancingInstalments (see legacy documentation)" }, "Lookups.TypeOfInstalments": { "type": "string", "example": "TypeOfInstalments.Fixed", "description": "Lookups.TypeOfInstalments (see legacy documentation)" }, "Lookups.PeriodicityOfPayments": { "type": "string", "example": "PeriodicityOfPayments.MonthlyInstalments30Days", "description": "Lookups.PeriodicityOfPayments (see legacy documentation)" }, "Lookups.MethodOfPayment": { "type": "string", "example": "MethodOfPayment.DirectRemittance", "description": "Lookups.MethodOfPayment (see legacy documentation)" }, "Relations.Amounts.TotalCredit": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "53999840.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.TotalCredit (see legacy documentation)" }, "Types.Contract.NumberOfInstalments": { "type": "string", "example": "36", "description": "Types.Contract.NumberOfInstalments (see legacy documentation)" }, "Relations.Amounts.StandardPeriodicalInstalment": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "50111000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.StandardPeriodicalInstalment (see legacy documentation)" }, "Relations.Amounts.Overdue": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Overdue (see legacy documentation)" }, "Relations.Amounts.Outstanding": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Outstanding (see legacy documentation)" } }, "description": "Relations.Contracts.InstalmentDetails (see legacy documentation)" }, "Reports.HistoricalCalendar.Instalment": { "type": "object", "properties": { "Reports.HistoricalCalendar.InstalmentRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "139703", "description": "_key (see legacy documentation)" }, "Reports.HistoricalCalendar.Month": { "type": "string", "example": "3", "description": "Reports.HistoricalCalendar.Month (see legacy documentation)" }, "Reports.HistoricalCalendar.Year": { "type": "string", "example": "1397", "description": "Reports.HistoricalCalendar.Year (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.Instalment (see legacy documentation)" }, "Reports.ContractData.GeneralInformation": { "type": "object", "properties": { "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.NoNegativeStatus", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Relations.Contracts.Dates": { "type": "object", "properties": { "Types.Contract.Dates.Start": { "type": "string", "example": "2012-12-05T20:30:00Z", "description": "Types.Contract.Dates.Start (see legacy documentation)" }, "Types.Contract.Dates.ExpectedEnd": { "type": "string", "example": "2015-12-06T20:30:00Z", "description": "Types.Contract.Dates.ExpectedEnd (see legacy documentation)" }, "Types.Contract.Dates.RealEnd": { "type": "string", "example": "2015-11-18T20:30:00Z", "description": "Types.Contract.Dates.RealEnd (see legacy documentation)" } }, "description": "Relations.Contracts.Dates (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "Lookups.PurposeOfTheCredit": { "type": "string", "example": "PurposeOfTheCredit.Construct", "description": "Lookups.PurposeOfTheCredit (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.DebtorMainApplicant", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" }, "Reports.ContractData.Creditor": { "type": "string", "example": "بانک قرض الحسنه مهر", "description": "Reports.ContractData.Creditor (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2016-01-19T00:00:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Lookups.PhaseOfOperation": { "type": "string", "example": "PhaseOfOperation.TerminatedAccordingTheContract", "description": "Lookups.PhaseOfOperation (see legacy documentation)" } }, "description": "Reports.ContractData.GeneralInformation (see legacy documentation)" }, "Reports.ContractData.ConnectedSubjects": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Reports.ContractData.ConnectedSubjects (see legacy documentation)" }, "Reports.ContractData.Collaterals": { "type": "object", "properties": { "Reports.ContractData.Collateral": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.TypeOfGuarantee": { "type": "string", "example": "GuaranteeType.CollaterisedBySecuritiesAndPreciousMetals", "description": "Lookups.TypeOfGuarantee (see legacy documentation)" }, "Relations.Amounts.Guarantee": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "60000000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Guarantee (see legacy documentation)" } }, "description": "Reports.ContractData.Collateral (see legacy documentation)" } }, "description": "Reports.ContractData.Collaterals (see legacy documentation)" } }, "description": "Reports.ContractData.Instalment (see legacy documentation)" } }, "description": "Reports.ContractData.Instalments (see legacy documentation)" } }, "description": "Reports.ContractData.TerminatedOperationsDebtor (see legacy documentation)" }, "Reports.ContractData.TerminatedOperationsGuarantor": { "type": "object", "properties": { "Reports.ContractData.Instalments": { "type": "object", "properties": { "Reports.ContractData.Instalment": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Relations.Contracts.InstalmentDetails": { "type": "object", "properties": { "Lookups.TypeOfFinancingInstalments": { "type": "string", "example": "TypeOfFinancingInstalments.QarzAlHassaneh", "description": "Lookups.TypeOfFinancingInstalments (see legacy documentation)" }, "Lookups.TypeOfInstalments": { "type": "string", "example": "TypeOfInstalments.Fixed", "description": "Lookups.TypeOfInstalments (see legacy documentation)" }, "Lookups.PeriodicityOfPayments": { "type": "string", "example": "PeriodicityOfPayments.MonthlyInstalments30Days", "description": "Lookups.PeriodicityOfPayments (see legacy documentation)" }, "Lookups.MethodOfPayment": { "type": "string", "example": "MethodOfPayment.DirectRemittance", "description": "Lookups.MethodOfPayment (see legacy documentation)" }, "Relations.Amounts.TotalCredit": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "53999840.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.TotalCredit (see legacy documentation)" }, "Relations.Amounts.StandardPeriodicalInstalment": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "50111000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.StandardPeriodicalInstalment (see legacy documentation)" }, "Relations.Amounts.Overdue": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Overdue (see legacy documentation)" }, "Relations.Amounts.Outstanding": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "0.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Outstanding (see legacy documentation)" } }, "description": "Relations.Contracts.InstalmentDetails (see legacy documentation)" }, "Reports.HistoricalCalendar.Instalment": { "type": "object", "properties": { "Reports.HistoricalCalendar.InstalmentRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "139703", "description": "_key (see legacy documentation)" }, "Reports.HistoricalCalendar.Month": { "type": "string", "example": "3", "description": "Reports.HistoricalCalendar.Month (see legacy documentation)" }, "Reports.HistoricalCalendar.Year": { "type": "string", "example": "1397", "description": "Reports.HistoricalCalendar.Year (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" }, "description": "Reports.HistoricalCalendar.InstalmentRecord (see legacy documentation)" } }, "description": "Reports.HistoricalCalendar.Instalment (see legacy documentation)" }, "Reports.ContractData.GeneralInformation": { "type": "object", "properties": { "Lookups.NegativeContractStatus": { "type": "string", "example": "NegativeContractStatus.NoNegativeStatus", "description": "Lookups.NegativeContractStatus (see legacy documentation)" }, "Relations.Contracts.Dates": { "type": "object", "properties": { "Types.Contract.Dates.Start": { "type": "string", "example": "2013-05-29T19:30:00Z", "description": "Types.Contract.Dates.Start (see legacy documentation)" }, "Types.Contract.Dates.ExpectedEnd": { "type": "string", "example": "2016-05-28T19:30:00Z", "description": "Types.Contract.Dates.ExpectedEnd (see legacy documentation)" }, "Types.Contract.Dates.RealEnd": { "type": "string", "example": "2016-06-18T19:30:00Z", "description": "Types.Contract.Dates.RealEnd (see legacy documentation)" } }, "description": "Relations.Contracts.Dates (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "Lookups.PurposeOfTheCredit": { "type": "string", "example": "PurposeOfTheCredit.Construct", "description": "Lookups.PurposeOfTheCredit (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.Guarantor", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" }, "Reports.ContractData.Creditor": { "type": "string", "example": "بانک قرض الحسنه مهر", "description": "Reports.ContractData.Creditor (see legacy documentation)" }, "Reports.LastUpdate": { "type": "string", "example": "2017-09-21T00:00:00Z", "description": "Reports.LastUpdate (see legacy documentation)" }, "Lookups.PhaseOfOperation": { "type": "string", "example": "PhaseOfOperation.TerminatedAccordingTheContract", "description": "Lookups.PhaseOfOperation (see legacy documentation)" } }, "description": "Reports.ContractData.GeneralInformation (see legacy documentation)" }, "Reports.ContractData.ConnectedSubjects": { "type": "object", "properties": { "Reports.ContractData.ConnectedSubject": { "type": "object", "properties": { "_key": { "type": "string", "example": "1", "description": "_key (see legacy documentation)" }, "Reports.ContractData.ConnectedIndividuals": { "type": "object", "properties": { "Types.Subject.Individual.PersonalCode": { "type": "string", "example": "1741548993", "description": "Types.Subject.Individual.PersonalCode (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.DebtorMainApplicant", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" } }, "description": "Reports.ContractData.ConnectedIndividuals (see legacy documentation)" } }, "description": "Reports.ContractData.ConnectedSubject (see legacy documentation)" } }, "description": "Reports.ContractData.ConnectedSubjects (see legacy documentation)" }, "Reports.ContractData.Collaterals": { "type": "object", "properties": { "Reports.ContractData.Collateral": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.TypeOfGuarantee": { "type": "string", "example": "GuaranteeType.CollaterisedBySecuritiesAndPreciousMetals", "description": "Lookups.TypeOfGuarantee (see legacy documentation)" }, "Relations.Amounts.Guarantee": { "type": "object", "properties": { "Types.Amount": { "type": "string", "example": "60000000.0000", "description": "Types.Amount (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" } }, "description": "Relations.Amounts.Guarantee (see legacy documentation)" } }, "description": "Reports.ContractData.Collateral (see legacy documentation)" }, "description": "Reports.ContractData.Collateral (see legacy documentation)" } }, "description": "Reports.ContractData.Collaterals (see legacy documentation)" } }, "description": "Reports.ContractData.Instalment (see legacy documentation)" } }, "description": "Reports.ContractData.Instalments (see legacy documentation)" } }, "description": "Reports.ContractData.TerminatedOperationsGuarantor (see legacy documentation)" } }, "description": "Reports.BaseDataOperations (see legacy documentation)" }, "Reports.SubjectData.IDs": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Reports.SubjectData.IDs (see legacy documentation)" }, "Reports.Lookups.ReportStatus": { "type": "string", "example": "ReportStatus.OK", "description": "Reports.Lookups.ReportStatus (see legacy documentation)" }, "Reports.SummaryReport": { "type": "object", "properties": { "Reports.Lookups.ReportStatus": { "type": "string", "example": "ReportStatus.OK", "description": "Reports.Lookups.ReportStatus (see legacy documentation)" }, "NegativeStatusesAndInquiries": { "type": "object", "properties": { "NumberOfInquiries": { "type": "object", "properties": { "NumberOfInquiriesRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "Bank", "description": "_key (see legacy documentation)" }, "Lookups.SubscriberType": { "type": "string", "example": "SubscriberType.Bank", "description": "Lookups.SubscriberType (see legacy documentation)" }, "Last1Month": { "type": "string", "example": "0", "description": "Last1Month (see legacy documentation)" }, "Last1Year": { "type": "string", "example": "0", "description": "Last1Year (see legacy documentation)" } }, "description": "NumberOfInquiriesRecord (see legacy documentation)" }, "description": "NumberOfInquiriesRecord (see legacy documentation)" } }, "description": "NumberOfInquiries (see legacy documentation)" }, "CurrentNegativeStatusesSubject": { "type": "object", "properties": { "CurrentNegativeStatusesSubjectRecord": { "type": "object", "properties": { "_key": { "type": "string", "example": "CentralBank", "description": "_key (see legacy documentation)" }, "Lookups.NegativeInfoReportingSubscriber": { "type": "string", "example": "NegativeInfoReportingSubscriber.CentralBank", "description": "Lookups.NegativeInfoReportingSubscriber (see legacy documentation)" }, "NegativeStatusDate": { "type": "string", "example": "2017-05-07T19:30:00Z", "description": "NegativeStatusDate (see legacy documentation)" }, "Lookups.IsNegative": { "type": "string", "example": "IsNegative.Yes", "description": "Lookups.IsNegative (see legacy documentation)" } }, "description": "CurrentNegativeStatusesSubjectRecord (see legacy documentation)" } }, "description": "CurrentNegativeStatusesSubject (see legacy documentation)" }, "CurrentNegativeStatusesContract": { "type": "object", "properties": { "CurrentNegativeStatusesContractRecord": { "type": "object", "properties": { "_key": { "type": "string", "example": "Bank", "description": "_key (see legacy documentation)" }, "Lookups.SubscriberType": { "type": "string", "example": "SubscriberType.Bank", "description": "Lookups.SubscriberType (see legacy documentation)" }, "NegativeStatusCount": { "type": "string", "example": "1", "description": "NegativeStatusCount (see legacy documentation)" } }, "description": "CurrentNegativeStatusesContractRecord (see legacy documentation)" } }, "description": "CurrentNegativeStatusesContract (see legacy documentation)" } }, "description": "NegativeStatusesAndInquiries (see legacy documentation)" }, "PersonalInformation": { "type": "object", "properties": { "PersonalCode": { "type": "string", "example": "1754217982", "description": "PersonalCode (see legacy documentation)" }, "FirstName": { "type": "string", "example": "مژگان", "description": "FirstName (see legacy documentation)" }, "Surname": { "type": "string", "example": "چراغچي", "description": "Surname (see legacy documentation)" }, "FathersName": { "type": "string", "example": "-", "description": "FathersName (see legacy documentation)" }, "DateOfBirth": { "type": "string", "example": "1971-01-28T20:30:00Z", "description": "DateOfBirth (see legacy documentation)" }, "PlaceOfBirth": { "type": "string", "example": "65001", "description": "PlaceOfBirth (see legacy documentation)" }, "Lookups.Gender": { "type": "string", "example": "Gender.Female", "description": "Lookups.Gender (see legacy documentation)" }, "Lookups.MaritalStatus": { "type": "string", "example": "MaritalStatus.Married", "description": "Lookups.MaritalStatus (see legacy documentation)" } }, "description": "PersonalInformation (see legacy documentation)" }, "AddressAndContactInformation": { "type": "object", "properties": { "HomeAddress": { "type": "string", "example": "-", "description": "HomeAddress (see legacy documentation)" }, "MobilePhones": { "type": "object", "properties": { "MobilePhone": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "ContactValue": { "type": "string", "example": "09335846393", "description": "ContactValue (see legacy documentation)" } }, "description": "MobilePhone (see legacy documentation)" } }, "description": "MobilePhones (see legacy documentation)" }, "HomePhones": { "type": "object", "properties": { "HomePhone": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "ContactValue": { "type": "string", "example": "-", "description": "ContactValue (see legacy documentation)" } }, "description": "HomePhone (see legacy documentation)" }, "description": "HomePhone (see legacy documentation)" } }, "description": "HomePhones (see legacy documentation)" } }, "description": "AddressAndContactInformation (see legacy documentation)" }, "ContractsSummary": { "type": "object", "properties": { "Contracts": { "type": "object", "properties": { "ContractRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.TypeOfContract": { "type": "string", "example": "TypeOfContract.Instalment", "description": "Lookups.TypeOfContract (see legacy documentation)" }, "Products.Types.Subscriber": { "type": "string", "example": "Maskan", "description": "Products.Types.Subscriber (see legacy documentation)" }, "Products.Types.SubscriberLocalName": { "type": "string", "example": "بانک مسکن", "description": "Products.Types.SubscriberLocalName (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "NumberOfOpenContracts": { "type": "string", "example": "1", "description": "NumberOfOpenContracts (see legacy documentation)" }, "NumberOfTerminatedContracts": { "type": "string", "example": "0", "description": "NumberOfTerminatedContracts (see legacy documentation)" }, "OutstandingAmount": { "type": "string", "example": "118843991.0000", "description": "OutstandingAmount (see legacy documentation)" }, "OverdueAmount": { "type": "string", "example": "64548258.0000", "description": "OverdueAmount (see legacy documentation)" } }, "description": "ContractRecord (see legacy documentation)" }, "description": "ContractRecord (see legacy documentation)" }, "TotalRecord": { "type": "object", "properties": { "_key": { "type": "string", "example": "2", "description": "_key (see legacy documentation)" }, "Lookups.CurrencyCodes": { "type": "string", "example": "CurrencyCodes.IRR", "description": "Lookups.CurrencyCodes (see legacy documentation)" }, "NumberOfOpenContracts": { "type": "string", "example": "1", "description": "NumberOfOpenContracts (see legacy documentation)" }, "NumberOfTerminatedContracts": { "type": "string", "example": "1", "description": "NumberOfTerminatedContracts (see legacy documentation)" }, "OutstandingAmount": { "type": "string", "example": "118843991.0000", "description": "OutstandingAmount (see legacy documentation)" }, "OverdueAmount": { "type": "string", "example": "64548258.0000", "description": "OverdueAmount (see legacy documentation)" } }, "description": "TotalRecord (see legacy documentation)" } }, "description": "Contracts (see legacy documentation)" } }, "description": "ContractsSummary (see legacy documentation)" }, "SubjectRoles": { "type": "object", "properties": { "SubjectRoleRecord": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "0", "description": "_key (see legacy documentation)" }, "Lookups.RoleOfConnectedSubject": { "type": "string", "example": "RoleOfConnectedSubject.DebtorMainApplicant", "description": "Lookups.RoleOfConnectedSubject (see legacy documentation)" }, "NumberOfContracts": { "type": "string", "example": "1", "description": "NumberOfContracts (see legacy documentation)" } }, "description": "SubjectRoleRecord (see legacy documentation)" }, "description": "SubjectRoleRecord (see legacy documentation)" } }, "description": "SubjectRoles (see legacy documentation)" }, "ReportDate": { "type": "string", "example": "2019-06-11T07:06:15.3567973Z", "description": "ReportDate (see legacy documentation)" } }, "description": "Reports.SummaryReport (see legacy documentation)" } }, "description": "Cis.CB4.Projects.IR.IranCreditScoring.Reports.Body.Products.AdvancedIndividualReport.Response (see legacy documentation)" }, "score": { "type": "string", "example": "250", "description": "آرایه‌ای از رتبه‌بندی کاربر" }, "riskGrade": { "type": "string", "example": "RiskGrade.E3", "description": "riskGrade (see legacy documentation)" }, "scoreRange": { "type": "string", "example": "250 - 419", "description": "scoreRange (see legacy documentation)" }, "scoreDescription": { "type": "string", "example": "VeryHighRisk", "description": "scoreDescription (see legacy documentation)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_basic_reliability_get_sms_getResponse": { "type": "object", "properties": { "firstName": { "type": "string", "example": "رضا", "description": "firstName (see legacy documentation)" }, "lastName": { "type": "string", "example": "حسینی نژاد", "description": "lastName (see legacy documentation)" }, "fatherName": { "type": "string", "example": "مرتضی", "description": "fatherName (see legacy documentation)" }, "maritalStatus": { "type": "string", "example": "Married", "description": "maritalStatus (see legacy documentation)" }, "gender": { "type": "string", "example": "Male", "description": "gender (see legacy documentation)" }, "mobile": { "type": "string", "example": "09122718615", "description": "mobile (see legacy documentation)" }, "homeAddress": { "type": "string", "example": "تهران خ ايران ك فياض بخش ك كرمي ك شفيعي پ4", "description": "homeAddress (see legacy documentation)" }, "numberOfInquiry": { "type": "array", "items": { "type": "object", "properties": { "subscriberType": { "type": "string", "example": "Bank", "description": "subscriberType (see legacy documentation)" }, "last1Month": { "type": "string", "example": "0", "description": "last1Month (see legacy documentation)" }, "last1Year": { "type": "string", "example": "0", "description": "last1Year (see legacy documentation)" } }, "description": "numberOfInquiry (see legacy documentation)" }, "description": "numberOfInquiry (see legacy documentation)" }, "reportDate": { "type": "string", "example": "2019-06-11T05:03:19.8233736Z", "description": "reportDate (see legacy documentation)" }, "score": { "type": "string", "example": "-1", "description": "آرایه‌ای از رتبه‌بندی کاربر" }, "riskGrade": { "type": "string", "example": "RiskGrade.XX", "description": "riskGrade (see legacy documentation)" }, "scoreRange": { "type": "string", "example": "-1", "description": "scoreRange (see legacy documentation)" }, "scoreDescription": { "type": "string", "example": "ExcludedFromScoring", "description": "scoreDescription (see legacy documentation)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "AsyncBillingInquirySubmitRequest": { "type": "object", "required": [ "type", "parameter" ], "properties": { "type": { "type": "string", "description": "Bill type.\n\n| type | Description (نوع قبض) |\n| --- | --- |\n| `Water` | Water bill (آب) |\n| `Electricity` | Electricity bill (برق) |\n| `Electricity-standard` | Electricity bill — fallback provider (برق پشتیبان) |\n| `Gas` | Gas bill by subscription number (گاز) |\n| `GasByBillId` | Gas bill by bill ID (گاز با شماره قبض) |\n| `Tel` | Landline — end of period (تلفن ثابت، پایان دوره) |\n| `TelNow` | Landline — current (تلفن ثابت، بروز) |\n| `Mobile` | Mobile — end of period (تلفن همراه، پایان دوره) |\n| `MobileNow` | Mobile — current (تلفن همراه، بروز) |\n", "enum": [ "Water", "Electricity", "Electricity-standard", "Gas", "GasByBillId", "Tel", "TelNow", "Mobile", "MobileNow" ], "example": "Mobile" }, "parameter": { "type": "string", "description": "Value to inquire, depending on `type`:\n- `Water`, `Electricity`, `Electricity-standard`: bill ID (شناسه قبض)\n- `Gas`: subscription number (شماره اشتراک)\n- `GasByBillId`: bill number (شماره قبض)\n- `Tel`, `TelNow`: landline number with area code (شماره تلفن به همراه کد)\n- `Mobile`, `MobileNow`: mobile number (شماره تلفن همراه)\n", "example": "09222223344" }, "secondParameter": { "type": "string", "description": "Mobile operator when the number was ported to another carrier.\nRequired for Irancell (`MTN`) and Rightel (`RIGHTEL`) mobile bills.\n\n| Value | Operator (اپراتور) |\n| --- | --- |\n| `MCI` | Hamrah-e Aval / MCI (همراه اول) |\n| `MTN` | Irancell (ایرانسل) |\n| `RIGHTEL` | Rightel (رایتل) |\n", "enum": [ "MCI", "MTN", "RIGHTEL" ], "example": "MCI" } } }, "AsyncBillingInquirySubmitResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "description": "Response code returned by the service" }, "trackId": { "type": "string", "description": "Correlation ID — echoed from the request or auto-generated" }, "status": { "type": "string", "enum": [ "DONE", "FAILED" ], "description": "Overall API call status (وضعیت فراخوانی سرویس)" }, "result": { "type": "object", "properties": { "requestId": { "type": "string", "description": "Unique request ID — use in the status step (شناسه درخواست)" }, "status": { "type": "string", "enum": [ "PENDING" ], "description": "Current inquiry status (وضعیت فعلی استعلام)" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "AsyncBillingInquiryStatusRequest": { "type": "object", "required": [ "requestId" ], "properties": { "requestId": { "type": "string", "description": "Request ID from the submit step (شناسه دریافتی از مرحله اول)", "example": "e3e9fa28-ed42-42b1-b15a-c55bb0961b92" } } }, "AsyncBillingInquiryData": { "type": "object", "description": "Bill inquiry result when `status` is `SUCCESS`", "properties": { "amount": { "type": "string", "description": "Bill amount in Rials (مبلغ قبض)", "example": "3613000" }, "billId": { "type": "string", "description": "Bill identifier (شناسه قبض)", "example": "9480837904123" }, "payId": { "type": "string", "description": "Payment identifier (شناسه پرداخت)", "example": "361350182" }, "date": { "type": "string", "description": "Payment deadline — Jalali date (مهلت پرداخت)", "example": "1405/03/05" } } }, "AsyncBillingInquiryResult": { "type": "object", "properties": { "requestId": { "type": "string", "description": "Request ID (شناسه درخواست)" }, "status": { "type": "string", "enum": [ "PENDING", "SUCCESS", "FAILED" ], "description": "Current inquiry status (وضعیت فعلی استعلام)" }, "data": { "$ref": "#/components/schemas/AsyncBillingInquiryData" }, "error": { "type": "object", "description": "Inquiry-level error when `status` is `FAILED`", "properties": { "code": { "type": "string", "description": "Error code (کد خطا)" }, "message": { "type": "string", "description": "Error message (پیغام خطا)" } } } } }, "AsyncBillingInquiryStatusResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "description": "Response code returned by the service" }, "trackId": { "type": "string", "description": "Correlation ID — echoed from the request or auto-generated" }, "status": { "type": "string", "enum": [ "DONE", "FAILED" ], "description": "Overall API call status (وضعیت فراخوانی سرویس)" }, "result": { "$ref": "#/components/schemas/AsyncBillingInquiryResult" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "BillResult": { "type": "object", "properties": { "Amount": { "type": "integer" }, "BillId": { "type": "integer" }, "PayId": { "type": "integer" }, "Date": { "type": "string" } } }, "BillingInquiryResponse": { "type": "object", "properties": { "trackId": { "type": "string" }, "status": { "type": "string", "enum": [ "DONE", "FAILED" ] }, "result": { "$ref": "#/components/schemas/BillResult" } } }, "BillingDetailInquiryInfo": { "type": "object", "description": "جزئیات قبض (در صورت وجود اطلاعات)", "properties": { "CompanyName": { "type": "string", "description": "نام شرکت توزیع" }, "CustomerName": { "type": "string", "description": "نام مشترک" }, "CustomerFamily": { "type": "string", "description": "نام خانوادگی مشترک" }, "CustomerType": { "type": "string", "description": "نوع مشترک" }, "Address": { "type": "string", "description": "آدرس" }, "PostalCode": { "type": "string", "description": "کدپستی" }, "FileNumber": { "type": "string", "description": "شماره پرونده" }, "ComputerPassword": { "type": "string", "description": "رمز رایانه" }, "IdentificationNumber": { "type": "string", "description": "شماره شناسایی" }, "TariffType": { "type": "string", "description": "نوع تعرفه" }, "Phase": { "type": "string", "description": "فاز" }, "Amper": { "type": "string", "description": "آمپراژ" }, "VoltageType": { "type": "string", "description": "نوع ولتاژ" }, "ContractDemand": { "type": "string", "description": "قدرت" }, "Year": { "type": "string", "description": "سال" }, "Period": { "type": "string", "description": "دوره" }, "PreviousReadingDate": { "type": "string", "description": "تاریخ قرائت قبلی" }, "CurrentReadingDate": { "type": "string", "description": "تاریخ قرائت فعلی" }, "BillExportationDate": { "type": "string", "description": "تاریخ صدور" }, "RejectDate": { "type": "string", "description": "تاریخ عدم قبول" }, "NormalConsumption": { "type": "string", "description": "مصرف میان‌باری" }, "PeakConsumption": { "type": "string", "description": "مصرف اوج بار" }, "LowConsumption": { "type": "string", "description": "مصرف کم‌باری" }, "FridayConsumption": { "type": "string", "description": "مصرف روز جمعه" }, "ReactiveConsumption": { "type": "string", "description": "مصرف راکتیو" }, "DemandRead": { "type": "string", "description": "تقاضای قرائت" }, "AverageConsumption": { "type": "string", "description": "میانگین مصرف" }, "BillPayableAmount": { "type": "string", "description": "مبلغ قابل پرداخت" }, "PeriodAmount": { "type": "string", "description": "مبلغ دوره" }, "InsuranceAmount": { "type": "string", "description": "مبلغ بیمه" }, "TaxAmount": { "type": "string", "description": "مبلغ مالیات" }, "PaytollAmount": { "type": "string", "description": "مبلغ عوارض" }, "ElectricityTaxAmount": { "type": "string", "description": "مبلغ عوارض برق" }, "PreviousDebt": { "type": "string", "description": "بدهی پیشین" }, "EnergyAmount": { "type": "string", "description": "مبلغ انرژی" }, "ReactiveAmount": { "type": "string", "description": "مبلغ راکتیو" }, "DemandAmount": { "type": "string", "description": "مبلغ تقاضا" }, "SubscriptionAmount": { "type": "string", "description": "آبونمان" }, "SeasonAmount": { "type": "string", "description": "مبلغ فصل" }, "FreeAmount": { "type": "string", "description": "مبلغ رایگان" }, "GasDiscountAmount": { "type": "string", "description": "مبلغ تخفیف گاز" }, "DiscountAmount": { "type": "string", "description": "مبلغ تخفیف" }, "WarmDaysCount": { "type": "string", "description": "تعداد روز گرم" }, "ColdDaysCount": { "type": "string", "description": "تعداد روز سرد" }, "TotalDaysCount": { "type": "string", "description": "تعداد روز" }, "ConsumptionDebtAmount": { "type": "string", "description": "مبلغ بدهی مصرف" }, "OtherDebtAmount": { "type": "string", "description": "مبلغ بدهی سایر خدمات" }, "BranchDebtAmount": { "type": "string", "description": "مبلغ بدهی انشعاب" } } }, "BillingDetailInquiryResponse": { "type": "object", "properties": { "trackId": { "type": "string", "description": "کد پیگیری" }, "status": { "type": "string", "enum": [ "DONE", "FAILED" ], "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "description": "آبجکت پاسخ سرویس", "properties": { "Amount": { "type": "string", "description": "مبلغ قبض" }, "BillId": { "type": "string", "description": "شناسه قبض" }, "PayId": { "type": "string", "description": "شناسه پرداخت" }, "Date": { "type": "string", "description": "مهلت پرداخت" }, "Info": { "$ref": "#/components/schemas/BillingDetailInquiryInfo" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "BillingBillHistoryInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string", "enum": [ "DONE", "FAILED" ] }, "result": { "type": "object", "properties": { "bills": { "type": "array", "items": { "type": "object", "properties": { "billId": { "type": "string", "description": "شناسه قبض" }, "payId": { "type": "string", "description": "شناسه پرداخت" }, "amount": { "type": "string", "description": "مبلغ قبض" }, "date": { "type": "string", "description": "مهلت پرداخت" }, "info": { "type": "object", "additionalProperties": true, "description": "سایر اطلاعات قبض (فیلدها بسته به نوع برق یا گاز متفاوت است)" } } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycIdentificationInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "firstName": { "type": "string", "description": "نام" }, "lastName": { "type": "string", "description": "نام خانوادگی" }, "birthDate": { "type": "string", "description": "تاریخ تولد" }, "fatherName": { "type": "string", "description": "نام پدر" }, "deathStatus": { "type": "string", "description": "وضعیت حیات — زنده یا مرده" }, "nationalId": { "type": "string", "description": "کد ملی" }, "gender": { "type": "string", "description": "جنسیت — زن/مرد" }, "identityNo": { "type": "integer", "description": "شماره شناسنامه" }, "identitySeri": { "type": "string", "description": "سری شناسنامه" }, "identitySerial": { "type": "string", "description": "سریال شناسنامه" }, "officeName": { "type": "string", "description": "محل صدور" }, "officeCode": { "type": "string", "description": "کد اداره صادرکننده" }, "trackingCode": { "type": [ "string", "null" ], "description": "کد رهگیری ثبت احوال" }, "operationStatus": { "type": [ "string", "null" ], "description": "وضعیت درخواست" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycIbanOwnerVerificationResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "isValid": { "type": "string", "enum": [ "yes", "no" ], "description": "وضعیت تطابق شبا و کد ملی" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycCardOwnerVerificationRequest": { "type": "object", "required": [ "card", "nid" ], "properties": { "card": { "type": "string", "description": "شماره کارت" }, "nid": { "type": "string", "description": "کد ملی" } } }, "KycCardOwnerVerificationResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "isValid": { "type": "boolean", "description": "وضعیت تطابق کارت و کد ملی" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycIbanOwnerBirthdateVerificationResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "isValid": { "type": "string", "enum": [ "yes", "no", "most_possible" ], "description": "وضعیت تطابق — yes، no یا most_possible" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycThirdPartyInsuranceInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "additionalProperties": true, "properties": { "carGroupCode": { "type": "integer", "description": "کد گروه خودرو" }, "companyCode": { "type": "string", "description": "کد شرکت بیمه" }, "companyName": { "type": "string", "description": "نام شرکت بیمه" }, "countLossAmount": { "type": "integer", "description": "تعداد خسارات" }, "endDate": { "type": "string", "description": "تاریخ پایان بیمه‌نامه" }, "issueDate": { "type": "string", "description": "تاریخ صدور" }, "mapUsageName": { "type": "string", "description": "کاربری وسیله" }, "mapVehicleSystemName": { "type": "string", "description": "نام سیستم وسیله" }, "modelCii": { "type": "integer", "description": "سال ساخت" }, "plk1": { "type": "integer", "description": "دو رقم سمت چپ پلاک" }, "plk2": { "type": "integer", "description": "حرف وسط پلاک" }, "plk3": { "type": "integer", "description": "سه رقم سمت راست" }, "plkSrl": { "type": "integer", "description": "سریال پلاک" }, "thirdPolicyCode": { "type": "integer", "description": "کد یکتای بیمه‌نامه" }, "vin": { "type": "string", "description": "شناسه VIN" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycOcrVerificationResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "nationalCode": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fatherName": { "type": "string" }, "birthDate": { "type": "string" }, "expirationDate": { "type": "string" }, "serial": { "type": "string", "description": "سریال پشت کارت ملی" }, "docType": { "type": "string", "enum": [ "national-card-front", "national-card-back" ] } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycCompareVideoWithNationalCardImageResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string", "description": "کد پیگیری؛ اگر ارسال شده باشد همان مقدار برگردانده می‌شود" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "faceVerification": { "type": "number", "description": "درصد تشابه عکس کارت ملی و ویدیوی ارسالی. حد آستانه ۰٫۹ است.\nاگر مقدار بیشتر از ۰٫۹ باشد، چهره فرد در ویدیو و عکس کارت ملی مطابقت دارند.\n" }, "trackingCode": { "type": "string", "description": "کد پیگیری ثبت احوال" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycCompareLiveVideoWithNationalCardResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string", "description": "کد پیگیری؛ اگر ارسال شده باشد همان مقدار برگردانده می‌شود و در غیر این صورت یک رشته تصادفی تولید می‌شود" }, "status": { "type": "string", "description": "وضعیت فراخوانی — DONE یا FAILED" }, "result": { "type": "object", "properties": { "faceVerification": { "type": "number", "description": "درصد تشابه عکس کارت ملی و ویدیوی ارسالی. حد آستانه ۰٫۹ است.\nاگر مقدار بیشتر از ۰٫۹ باشد، چهره فرد در ویدیو و عکس کارت ملی مطابقت دارند.\n" }, "liveness": { "type": "number", "description": "درصد لایو بودن ویدیوی ارسالی. حد آستانه ۰٫۰۰۱ است.\nاگر مقدار از ۰٫۰۰۱ بیشتر باشد، ویدیوی ارسالی لایو است.\n" }, "speechSimilarity": { "type": "number", "description": "درصد تشابه متن خوانده‌شده در ویدیو با متن مورد انتظار در ورودی.\nفقط وقتی برمی‌گردد که `speechText` در ورودی ارسال شده باشد. حد آستانه ۰٫۵ است.\nاگر مقدار از ۰٫۵ بزرگ‌تر باشد، متن ویدیو با متن ورودی مطابقت دارد.\n" }, "printLiveness": { "type": "string", "description": "احتمال اینکه ویدیو از روی عکس گرفته شده باشد" }, "replayLiveness": { "type": "string", "description": "احتمال اینکه ویدیو از روی ویدیو گرفته شده باشد" }, "trackingCode": { "type": "string", "description": "کد پیگیری ثبت احوال" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycMobileCardVerificationRequest": { "type": "object", "required": [ "mobile", "card" ], "properties": { "mobile": { "type": "string", "description": "شماره موبایل" }, "card": { "type": "string", "description": "شماره کارت" } } }, "KycMobileCardVerificationResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "isValid": { "type": "boolean", "description": "نتیجه تطبیق کارت و موبایل" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycMilitaryInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "conversationId": { "type": "string" }, "type": { "type": "string", "enum": [ "EXCEPTION", "ORDINARY" ] }, "isAllowed": { "type": "boolean" }, "condition": { "type": "string", "enum": [ "NOT_ALLOWED", "ALLOWED" ] }, "conditionDescription": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycSanaInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "registered": { "type": "string", "enum": [ "true", "false" ] }, "message": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycTaxInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "nationalId": { "type": "string", "description": "کد ملی" }, "debts": { "type": "array", "description": "لیست بدهی‌های مالیاتی", "items": { "type": "object", "properties": { "followCode": { "type": "string", "nullable": true, "description": "کد پیگیری بدهی" }, "nationalId": { "type": "string", "description": "کد ملی" }, "taxYear": { "type": "number", "description": "سال مالیاتی" }, "taxPeriod": { "type": "number", "description": "دوره مالیاتی" }, "taxOffice": { "type": "string", "description": "کد اداره مالیات" }, "taxTypeTitle": { "type": "string", "description": "عنوان نوع مالیات" }, "liabilityTypeTitle": { "type": "string", "description": "عنوان نوع بدهی" }, "liabilitySourceTitle": { "type": "string", "description": "عنوان منبع بدهی" }, "amount": { "type": "number", "description": "مبلغ" }, "creditAmount": { "type": "number", "description": "مبلغ بستانکاری" }, "debtAmount": { "type": "number", "description": "مبلغ بدهی" } } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycLicenseCheckInquiryRequest": { "type": "object", "required": [ "nationalID", "mobile" ], "properties": { "nationalID": { "type": "string", "description": "کد ملی" }, "mobile": { "type": "string", "description": "شماره موبایل" } } }, "KycLicenseCheckInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "licenses": { "type": "array", "items": { "type": "object", "properties": { "barCode": { "type": "string" }, "issueDate": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "nationalCode": { "type": "string" }, "licenseNumber": { "type": "string" }, "licenseStatus": { "type": "string" }, "licenseType": { "type": "string" }, "licenseValidityPeriod": { "type": "string" } } } }, "licenseStatus": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycDeathStatusInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "deathStatus": { "type": "string", "description": "زنده یا مرده" }, "trackingCode": { "type": "string", "description": "کد رهگیری ثبت احوال" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycForeignerIdInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "firstName": { "type": "string", "description": "نام" }, "lastName": { "type": "string", "description": "نام خانوادگی" }, "fullName": { "type": "string", "description": "نام کامل" }, "fatherName": { "type": "string", "description": "نام پدر" }, "ancestorName": { "type": "string", "description": "نام پدربزرگ (جد)" }, "gender": { "type": "string", "description": "جنسیت" }, "nationality": { "type": "string", "description": "ملیت" }, "identificationDocumentTypeTitle": { "type": "string", "description": "عنوان سند شناسایی" }, "identificationDocumentNumber": { "type": "string", "description": "شماره سند شناسایی" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycDriversRiskInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "score": { "type": "number", "description": "ریسک راننده" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycTransactionCreditInquiryRequestResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "message": { "type": "string", "description": "توضیحات موفق یا ناموفق بودن پاسخ" }, "inquiryTrackId": { "type": "string", "description": "شناسه پیگیری استعلام (برای مرحله صحت‌سنجی)" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycTransactionCreditInquiryVerifyRequest": { "type": "object", "required": [ "nationalCode", "otp", "inquiryTrackId" ], "properties": { "nationalCode": { "type": "string", "description": "کد ملی", "example": "11111111111" }, "otp": { "type": "string", "description": "رمز یکبار مصرف", "example": "12345" }, "inquiryTrackId": { "type": "string", "description": "کد پیگیری مرحله اول", "example": "00000" } } }, "KycTransactionCreditInquiryVerifyResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "inquiryTrackId": { "type": "string", "description": "شناسه پیگیری استعلام (برای مرحله دریافت گزارش)" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KycTransactionCreditInquiryReportResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "message": { "type": "string", "description": "وضعیت اعتبار معاملاتی فرد" }, "hasHistory": { "type": "boolean", "description": "آیا شخص دارای محکومیت مالی است" }, "title": { "type": "string", "description": "عنوان وضعیت (مثلاً محکومیت مالی، ممنوع‌المعامله، معسر)" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_ac_sayadIssueCheque_post_cheque_postResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "7b244-3c01-44f1-b395-e3aeaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "message": { "type": "string", "example": "ثبت چک با موفقیت انجام شد", "description": "پیغام مبتنی بر ثبت چک" }, "referenceId": { "type": "string", "example": "6546542684564", "description": "کد رهگیری" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_ac_sayadTransferCheque_post_cheque_postResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "7b244-3c01-44f1-b395-e3aeaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "message": { "type": "string", "example": "ثبت چک با موفقیت انجام شد", "description": "پیغام مبتنی بر ثبت چک" }, "referenceId": { "type": "string", "example": "6546542684564", "description": "کد رهگیری" }, "resultCode": { "type": "string", "example": "1", "description": "کد رهگیری" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_chequeColorInquiryLegal_get_credit_chequeColorInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20003700000", "description": "ریسپانس‌ کد مربوط به این فراخوانی" }, "trackId": { "type": "string", "example": "1ccdb-4924-4ab4-9a61-9ed6573", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "chequeColor": { "type": "string", "example": "2", "description": "کد رنگ چک\n\n- `1`: وضعیت سفید به این معناست که صادرکننده چک فاقد هرگونه سابقه چک برگشتی بوده یا در صورت وجود سابقه، تمامی موارد رفع سوء اثر شده است.\n- `2`: وضعیت زرد به معنای داشتن یک فقره چک برگشتی یا حداکثر مبلغ 50 میلیون ریال تعهد برگشتی است.\n- `3`: وضعیت نارنجی نشان می دهد که صادرکننده چک دارای دو الی چهار فقره چک برگشتی یا حداکثر مبلغ 200 میلیون ریال تعهد برگشتی است.\n- `4`: وضعیت قهوه ای از این حکایت دارد که صادرکننده چک دارای پنج تا ده فقره چک برگشتی یا حداکثر مبلغ 500 میلیون ریال تعهد برگشتی است.\n- `5`: وضعیت قرمز نیز حاکی از این است که صادرکننده چک دارای بیش از ده فقره چک برگشتی یا بیش از مبلغ 500 میلیون ریال تعهد برگشتی است." } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_chequeColorInquiry_get_chequeColorInquiry_getResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTFH-20099900000", "description": "Response code (کد پاسخ)" }, "trackId": { "type": "string", "example": "1ccdb-4924-4ab4-9a61-9ed6573", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "chequeColor": { "type": "string", "example": "2", "description": "کد رنگ چک\n\n- `1`: وضعیت سفید به این معناست که صادرکننده چک فاقد هرگونه سابقه چک برگشتی بوده یا در صورت وجود سابقه، تمامی موارد رفع سوء اثر شده است.\n- `2`: وضعیت زرد به معنای داشتن یک فقره چک برگشتی یا حداکثر مبلغ 50 میلیون ریال تعهد برگشتی است.\n- `3`: وضعیت نارنجی نشان می دهد که صادرکننده چک دارای دو الی چهار فقره چک برگشتی یا حداکثر مبلغ 200 میلیون ریال تعهد برگشتی است.\n- `4`: وضعیت قهوه ای از این حکایت دارد که صادرکننده چک دارای پنج تا ده فقره چک برگشتی یا حداکثر مبلغ 500 میلیون ریال تعهد برگشتی است.\n- `5`: وضعیت قرمز نیز حاکی از این است که صادرکننده چک دارای بیش از ده فقره چک برگشتی یا بیش از مبلغ 500 میلیون ریال تعهد برگشتی است." } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_clearedCheque_get_clearedCheque_getResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "clearedCheque12312", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "firstName": { "type": "string", "example": "علی", "description": "نام" }, "lastName": { "type": "string", "example": "محمدی", "description": "نام خانوادگی" }, "nid": { "type": "string", "example": "6780026883", "description": "کد ملی یا شناسه ملی" }, "personType": { "type": "integer", "example": 1, "description": "نوع شخص (۱ حقیقی، ۲ حقوقی)" }, "chequeList": { "type": "array", "description": "فهرست چک‌های رفع سو اثر شده", "items": { "type": "object", "properties": { "clearingBankCode": { "type": "string", "example": "15", "description": "کد بانک رفع سوء" }, "clearingBranchCode": { "type": "string", "example": "1234", "description": "کد شعبه رفع سوء" }, "clearingBranchName": { "type": "string", "example": "شعبه مرکزی", "description": "نام شعبه رفع سوء" }, "clearedDate": { "type": "string", "example": "14030101", "description": "تاریخ رفع سوء" }, "clearedType": { "type": "string", "example": "2", "description": "نوع رفع سوء (جدول ClearedType)" }, "bouncedAtBranchName": { "type": "string", "example": "شعبه برگشت‌زننده", "description": "نام شعبه برگشت‌زننده" }, "customerType": { "type": "string", "example": "1", "description": "نوع مشتری" }, "idCheque": { "type": "string", "example": "99881234", "description": "کد رهگیری چک" }, "originBranchName": { "type": "string", "example": "شعبه افتتاح‌کننده", "description": "نام شعبه افتتاح‌کننده" }, "amount": { "type": "string", "example": "1000000", "description": "مبلغ چک" }, "bankCode": { "type": "string", "example": "15", "description": "کد بانک" }, "bouncedAmount": { "type": "string", "example": "500000", "description": "مبلغ برگشتی" }, "bouncedDate": { "type": "string", "example": "14021201", "description": "تاریخ برگشت" }, "dishonorReasons": { "type": "array", "items": { "type": "string", "example": "402" }, "description": "دلایل برگشت (جدول BouncedReason)" }, "bouncedAtBranchCode": { "type": "string", "example": "2211", "description": "کد شعبه برگشت‌زننده" }, "originBranchCode": { "type": "string", "example": "1100", "description": "کد شعبه افتتاح‌کننده" }, "channelKind": { "type": "string", "example": "1", "description": "نحوه ارائه چک" }, "currencyCode": { "type": "string", "example": "IRR", "description": "کد ارز" }, "currencyRate": { "type": "string", "example": "1", "description": "نرخ ارز" }, "deadlineDate": { "type": "string", "example": "14021101", "description": "تاریخ سررسید" }, "iban": { "type": "string", "example": "IR120170000000100123456001", "description": "شماره شبای چک" }, "chequeSerialNumber": { "type": "string", "example": "0012345678", "description": "شماره چک" } } } } }, "description": "پاسخ استعلام چک رفع سو اثر شده" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_smsClearedCheque_get_smsClearedCheque_getResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "smsClearedCheque12312", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "responseCode": { "type": "string", "example": "FN-CTKZ-20004100000" }, "result": { "type": "object", "properties": { "firstName": { "type": "string", "example": "علی", "description": "نام" }, "lastName": { "type": "string", "example": "محمدی", "description": "نام خانوادگی" }, "nid": { "type": "string", "example": "6780026883", "description": "کد ملی یا شناسه ملی" }, "personType": { "type": "integer", "example": 1, "description": "نوع شخص (۱ حقیقی، ۲ حقوقی)" }, "chequeList": { "type": "array", "description": "فهرست چک‌های رفع سو اثر شده", "items": { "type": "object", "properties": { "clearingBankCode": { "type": "string", "example": "15", "description": "کد بانک رفع سوء" }, "clearingBranchCode": { "type": "string", "example": "1234", "description": "کد شعبه رفع سوء" }, "clearingBranchName": { "type": "string", "example": "شعبه مرکزی", "description": "نام شعبه رفع سوء" }, "clearedDate": { "type": "string", "example": "14030101", "description": "تاریخ رفع سوء" }, "clearedType": { "type": "string", "example": "2", "description": "نوع رفع سوء (جدول ClearedType)" }, "bouncedAtBranchName": { "type": "string", "example": "شعبه برگشت‌زننده", "description": "نام شعبه برگشت‌زننده" }, "customerType": { "type": "string", "example": "1", "description": "نوع مشتری" }, "idCheque": { "type": "string", "example": "99881234", "description": "کد رهگیری چک" }, "originBranchName": { "type": "string", "example": "شعبه افتتاح‌کننده", "description": "نام شعبه افتتاح‌کننده" }, "amount": { "type": "string", "example": "1000000", "description": "مبلغ چک" }, "bankCode": { "type": "string", "example": "15", "description": "کد بانک" }, "bouncedAmount": { "type": "string", "example": "500000", "description": "مبلغ برگشتی" }, "bouncedDate": { "type": "string", "example": "14021201", "description": "تاریخ برگشت" }, "dishonorReasons": { "type": "array", "items": { "type": "string", "example": "402" }, "description": "دلایل برگشت (جدول BouncedReason)" }, "bouncedAtBranchCode": { "type": "string", "example": "2211", "description": "کد شعبه برگشت‌زننده" }, "originBranchCode": { "type": "string", "example": "1100", "description": "کد شعبه افتتاح‌کننده" }, "channelKind": { "type": "string", "example": "1", "description": "نحوه ارائه چک" }, "currencyCode": { "type": "string", "example": "IRR", "description": "کد ارز" }, "currencyRate": { "type": "string", "example": "1", "description": "نرخ ارز" }, "deadlineDate": { "type": "string", "example": "14021101", "description": "تاریخ سررسید" }, "iban": { "type": "string", "example": "IR120170000000100123456001", "description": "شماره شبای چک" }, "chequeSerialNumber": { "type": "string", "example": "0012345678", "description": "شماره چک" } } } } }, "description": "پاسخ استعلام چک رفع سو اثر شده (پیامکی)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_chequeStatusInquiry_post_inquiry_postResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20003300000", "description": "کد پاسخ فینوتک" }, "trackId": { "type": "string", "example": "aaaaaaaa-8802-4321-bed4-aaaaaaaaaaaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "onGoing": { "type": "integer", "example": 180229920122, "description": "onGoing (see legacy documentation)" }, "ownersInfo": { "type": "array", "items": { "type": "object", "properties": { "idCode": { "type": "string", "example": "1234567890", "description": "نوع کد شناسایی: 1:مشتری حقیقی 2:مشتری حقوقی" }, "idType": { "type": "integer", "example": 2, "description": "نوع شخص: 1: صادرکننده چک 2: گیرنده چک (دریافت کننده چک) 3: گیرنده انتقال" }, "bounced": { "type": "integer", "example": 0, "description": "مجموع مبالغ چک‌های برگشت خورده مشتری صاحب حساب" }, "cleared": { "type": "integer", "example": 64776521323, "description": "مجموع مبالغ چک‌های رفع سو اثر شده مشتری صاحب حساب" } }, "description": "لیستی از اطلاعات مربوط به مشتری عهده چک مطابق با شناسه صیادی" }, "description": "لیستی از اطلاعات مربوط به مشتری عهده چک مطابق با شناسه صیادی" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_chequebookInquiry_get_chequebookInquiry_getResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20002800000", "description": "Response code (کد پاسخ)" }, "trackId": { "type": "string", "example": "abf04237-9ee7-87150f1efada", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار برگردانده میشود و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "chequeDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNo": { "type": "string", "example": "0101252337009", "description": "شماره حساب جاری" }, "branchCodeAndName": { "type": "string", "example": "0127/گاندی - بیمه رازی", "description": "کد و نام شعبه ثبت درخواست" }, "branchCode": { "type": "string", "example": "0127", "description": "کد شعبه" }, "branchName": { "type": "string", "example": "گاندی-بیمه رازی", "description": "نام شعبه" }, "approvedDate": { "type": "string", "example": "1401/09/23", "description": "تاریخ ثبت درخواست" }, "customerName": { "type": "string", "example": "محمدعلي دى پير", "description": "نام و نام خانوادگی صاحب دسته چک" }, "customerNo": { "type": "string", "example": "0053682167", "description": "شماره مشتری" }, "customerType": { "type": "string", "example": "1", "description": "نوع مشتری" }, "deliveryBranchCode": { "type": "string", "example": "0297", "description": "کدشعبه دریافت دسته چک" }, "expireDate": { "type": "string", "example": "14040923", "description": "تاریخ انقضای دسته چک" }, "isABunch": { "type": "string", "example": "false", "description": "وضعیت دسته چک" }, "issuanceDate": { "type": "string", "example": "14010923", "description": "تاریخ ثبت درخواست" }, "mediaType": { "type": "string", "example": "BANS", "description": "نوع دسته چک" }, "nationalCode": { "type": "string", "example": "0010009007", "description": "کد ملی" }, "serialNoFrom": { "type": "string", "example": "8785410145586299", "description": "شماره سریال اولین برگ از دسته چک" }, "serialNoTo": { "type": "string", "example": "6480010145586308", "description": "شماره سریال آخرین برگ از دسته چک" }, "serialNumbers": { "type": "string", "example": "868401016546299,4768013265586300,17270101467986301,4482064535586302,4098010174126303,2807589645586304,1959010146356305,5199010145326306,3737452145586307,6480058795586308", "description": "مجموعه همه سریال های دسته چک" }, "iban": { "type": "string", "example": "IR600620000000101276454009", "description": "شماره شبا" }, "sheetCount": { "type": "string", "example": "10", "description": "تعداد برگ های دسته چک" }, "stateDescription": { "type": "string", "example": "دسته چک چاپ شد ", "description": "stateDescription (see legacy documentation)" } }, "description": "جزئیات دسته چک" }, "description": "جزئیات دسته چک" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_guaranteeCollaterals_get_guarantee_collateralsResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "get-guarantee-collaterals-029", "description": "‌ کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "retCodeDescription": { "type": [ "string", "null" ], "description": "توضیح کد بازگشتی از سرویس زیرساختی" }, "guaranteeId": { "type": "string", "example": "6000034390000", "description": "شناسه ضمانت نامه" }, "collaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralId": { "type": "string", "example": "6545645646", "description": "شماره وثیقه" }, "collateralTypeCode": { "type": "string", "example": "01", "description": "کد نوع وثیقه" }, "centralBankCollateralTypeCode": { "type": "string", "example": "02", "description": "کد وثیفه در بانک مرکزی" }, "collateralTypeDescription": { "type": "string", "example": "شرح", "description": "شرح نوع وثیقه" }, "evaluatedAmount": { "type": "string", "example": "10000", "description": "مبلغ ارزیابی وثیقه" }, "debtAmount": { "type": "string", "example": "10000", "description": "مبلغ ترهینی وثیقه" }, "interestRate": { "type": "string", "example": "000.21", "description": "درصد سود وثیقه" }, "receiveDate": { "type": "string", "example": "14000101", "description": "تاریخ دریافت وثیقه" }, "issueDate": { "type": "string", "example": "13991202", "description": "تاریخ ثبت وثیقه" }, "assignDate": { "type": "string", "example": "14000203", "description": "تاریخ تخصیص وثیقه" } }, "description": "لیست وثایق" }, "description": "لیست وثایق" }, "alertCode": { "type": "string", "example": "00000", "description": "alertCode (see legacy documentation)" }, "messageOut": { "type": [ "string", "null" ], "description": "messageOut (see legacy documentation)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_guaranteeDetails_get_credit_guaranteeDetailsResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "feba236a-d4b5-4f93-97e9-0b0f8e993d2a", "description": "‌ کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "retCodeDescription": { "type": [ "string", "null" ], "description": "توضیح کد بازگشتی از سرویس زیرساختی" }, "guaranteeId": { "type": "string", "example": "6000034392235", "description": "شماره ضمانت نامه" }, "sepamId": { "type": "string", "example": "0297665987813241", "description": "شماره سپام" }, "branchCode": { "type": "string", "example": "0387", "description": "کد شعبه اعطا کننده" }, "centralBankTypeCode": { "type": "string", "example": "02", "description": "کد نوع ضمانه نامه (بانک مرکزی)" }, "guaranteeSubTypeCode": { "type": "string", "example": "0632", "description": "کد زیر نوع ضمانت نامه" }, "guaranteeSubTypeDesc": { "type": "string", "example": "ضمانتنامه‌حسن‌‌اجر‌ای‌تعهدخدمات‌", "description": "شرح زیر نوع ضمانت نامه" }, "cif": { "type": "string", "example": "0031254687", "description": "شماره مشتری" }, "debtAmount": { "type": "string", "example": "500000000", "description": "مبلغ ضمانت نامه" }, "issueDate": { "type": "string", "example": "14000824", "description": "تاریخ صدور ضمانت نامه" }, "maturityDate": { "type": "string", "example": "14010301", "description": "تاریخ سررسید ضمانت نامه" }, "renewDate": { "type": "string", "example": " ", "description": "تاریخ تمدید ضمانت نامه" }, "companyPreDebtAmount": { "type": "string", "example": " ", "description": "مبلغ ودیعه دریافتی از شرکت" }, "issueChargeAmount": { "type": "string", "example": "600000", "description": "مبلغ کارمزد صدور (بدون تخفیف)" }, "lastRenewChargeAmount": { "type": "string", "example": " ", "description": "مبلغ کارمزد آخرین تمدید (در صورتی که تمدید شده باشد)" }, "totalCharge": { "type": "string", "example": "600000", "description": "مجموع کارمزد دریافت شده" }, "guaranteeStatusCode": { "type": "string", "example": "1", "description": "کد وضعیت ضمانت نامه" }, "guaranteeStatusDescription": { "type": "string", "example": " وضعیت تع‌هد", "description": "شرح وضعیت ضمانت نامه" }, "economicDesc": { "type": "string", "example": "بخش‌ خدمات‌", "description": "شرح بخش اقتصادی" }, "economicSubsectionDesc": { "type": "string", "example": "بخش‌ خدمات‌-سایر", "description": "شرح زیر بخش" } }, "description": "Service result payload (نتیجه سرویس)" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_macnaInquiry_get_inquiry_getResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20002200000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "feba236a-d4b5-4f93-97e9-0b0f8e993d2a", "description": "کد پیگیری که در فراخوانی سرویس فرستاده شده است." }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "array", "items": { "type": "object", "properties": { "trace": { "type": "integer", "example": 14645, "description": "کد پیگیری ارسال شده" }, "firstName": { "type": "string", "example": "محمد", "description": "نام" }, "lastName": { "type": "string", "example": "قریشی", "description": "نام خانوادگی" }, "nationalCode": { "type": "string", "example": "2132131323", "description": "کدملی" }, "remain": { "type": "object", "properties": { "iran": { "type": "integer", "example": 100000000, "description": "مانده کارت اعتباری خرید کالای ایرانی" }, "bank": { "type": "integer", "example": 2000000000, "description": "مانده کارت اعتباری بانکی" } }, "description": "باقیمانده اعتبار" }, "history": { "type": "array", "items": { "type": "object", "properties": { "macnaCode": { "type": "string", "example": "1113810072693", "description": "کد مکنا" }, "issueDate": { "type": "string", "example": "2011-08-17", "description": "تاریخ ایجاد" }, "updated": { "type": "string", "example": "2015-08-23", "description": "تاریخ ویرایش" }, "cardType": { "type": "integer", "example": 2, "description": "نوع کارت" }, "pan": { "type": "string", "example": "636214******0256", "description": "شماره کارت" }, "bankCode": { "type": "integer", "example": 62, "description": "کد بانک" }, "bankName": { "type": "string", "example": "بانک تات", "description": "نام بانک" }, "stateCode": { "type": "integer", "example": 3, "description": "کد وضعیت" }, "stateDescription": { "type": "string", "example": "باطل", "description": "شرح وضعیت" }, "messageCode": { "type": "integer", "example": 14, "description": "کد پیام" }, "messageDescription": { "type": "string", "example": "درخواست المثنی", "description": "متن پیام" } }, "description": "مشخصات" }, "description": "مشخصات" } }, "description": "ارایه ای از پاسخ سرویس شامل:" }, "description": "ارایه ای از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_sayadSerialInquiry_get_inquiry_getResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "7b244-3c01-44f1-moho-e3aeaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "iban": { "type": "string", "example": "IR020620000000100925869001", "description": "شماره شبا دارنده چک" }, "issuedDate": { "type": "string", "example": "14000803", "description": "تاریخ صدور دسته چک" }, "expirationDate": { "type": "string", "example": "null", "description": "تاریخ انقضای دسته چک" }, "serialNo": { "type": "string", "example": "878535", "description": "شماره سریال" }, "seriesNo": { "type": "string", "example": "1234", "description": "شماره سری" }, "mediaType": { "type": "string", "example": "BANS", "description": "نوع چک" }, "branchCode": { "type": "string", "example": "6299996", "description": "کد شعبه" }, "name": { "type": "string", "example": "کامران تفتی", "description": "نام و نام خانوادگی دارنده دسته چک" }, "returnedCheques": { "type": [ "string", "null" ], "description": "چک بازگشتی" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_sayadTransfersChainInquiry_post_inquiry_postResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20003200000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "cf1da6d1-8775-406a-moho-48228891bdd0", "description": "کد پیگیری که در فراخوانی سرویس فرستاده شده است." }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "chain": { "type": "array", "items": { "type": "object", "properties": { "customers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "یعقوب یعقوبی", "description": "در صورت وجود نام مشتری ذینفع در زنجیره انتقالات چک، در صورت عدم وجود مقدار خالی برگردانده می شود" }, "idCode": { "type": "string", "example": "1111111111", "description": "کد شناسایی دارنده چک مشتری حقیقی: کد ملی مشتری حقوقی: شناسه ملی شرکت" }, "idType": { "type": "integer", "example": 1, "description": "نوع کد شناسایی: 1:مشتری حقیقی 2:مشتری حقوقی 3: اتباع بیگانه حقیقی 4: اتباع بیگانه حقوقی" } }, "description": "در صورت وجود نام مشتری ذینفع در زنجیره انتقالات چک، در صورت عدم وجود مقدار خالی برگردانده می شود" }, "description": "در صورت وجود نام مشتری ذینفع در زنجیره انتقالات چک، در صورت عدم وجود مقدار خالی برگردانده می شود" }, "roleType": { "type": "integer", "example": 1, "description": "نوع شخص" } }, "description": "لیست اطلاعات هویتی فرد/افراد موجود در یک زنجیره از انتقالات چک که در جدول مشخصات افراد موجود در زنجیره انتقالات چک شرح داده شده است." }, "description": "لیست اطلاعات هویتی فرد/افراد موجود در یک زنجیره از انتقالات چک که در جدول مشخصات افراد موجود در زنجیره انتقالات چک شرح داده شده است." } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_sms_chequeColorInquiry_get_inquiry_getResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20002700000", "description": "Response code (کد پاسخ)" }, "trackId": { "type": "string", "example": "1ccdb-4924-4ab4-moho-9ed6573", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "chequeColor": { "type": "string", "example": "4", "description": "کد رنگ چک\n\n- `1`: وضعیت سفید به این معناست که صادرکننده چک فاقد هرگونه سابقه چک برگشتی بوده یا در صورت وجود سابقه، تمامی موارد رفع سوء اثر شده است.\n- `2`: وضعیت زرد به معنای داشتن یک فقره چک برگشتی یا حداکثر مبلغ 50 میلیون ریال تعهد برگشتی است.\n- `3`: وضعیت نارنجی نشان می دهد که صادرکننده چک دارای دو الی چهار فقره چک برگشتی یا حداکثر مبلغ 200 میلیون ریال تعهد برگشتی است.\n- `4`: وضعیت قهوه ای نشان می دهد که صادرکننده چک دارای پنج تا ده فقره چک برگشتی یا حداکثر مبلغ 500 میلیون ریال تعهد برگشتی است.\n- `5`: وضعیت قرمز نیز حاکی از این است که صادرکننده چک دارای بیش از ده فقره چک برگشتی یا بیش از مبلغ 500 میلیون ریال تعهد برگشتی است." } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_sms_chequeStatusInquiry_post_inquiry_postResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20003300000", "description": "کد پاسخ فینوتک" }, "trackId": { "type": "string", "example": "aaaaaaaa-8802-4321-bed4-aaaaaaaaaaaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "onGoing": { "type": "integer", "example": 180229920122, "description": "onGoing (see legacy documentation)" }, "ownersInfo": { "type": "array", "items": { "type": "object", "properties": { "idCode": { "type": "string", "example": "1234567890", "description": "نوع کد شناسایی: 1:مشتری حقیقی 2:مشتری حقوقی" }, "idType": { "type": "integer", "example": 2, "description": "نوع شخص: 1: صادرکننده چک 2: گیرنده چک (دریافت کننده چک) 3: گیرنده انتقال" }, "bounced": { "type": "integer", "example": 0, "description": "مجموع مبالغ چک‌های برگشت خورده مشتری صاحب حساب" }, "cleared": { "type": "integer", "example": 64776521323, "description": "مجموع مبالغ چک‌های رفع سو اثر شده مشتری صاحب حساب" } }, "description": "لیستی از اطلاعات مربوط به مشتری عهده چک مطابق با شناسه صیادی" }, "description": "لیستی از اطلاعات مربوط به مشتری عهده چک مطابق با شناسه صیادی" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_sms_sayadTransferCheque_post_legal_postResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTFH-20002600000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "7b244-3c01-44f1-moho-e3aeaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "message": { "type": "string", "example": "ثبت چک با موفقیت انجام شد", "description": "پیغام مبتنی بر ثبت چک" }, "referenceId": { "type": "string", "example": "6546542684564", "description": "کد رهگیری" }, "resultCode": { "type": "string", "example": "1", "description": "کد رهگیری" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_sms_sayadTransfersChainInquiry_post_inquiry_postResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20003200000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "cf1da6d1-8775-406a-moho-48228891bdd0", "description": "کد پیگیری که در فراخوانی سرویس فرستاده شده است." }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "chain": { "type": "array", "items": { "type": "object", "properties": { "customers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "یعقوب یعقوبی", "description": "در صورت وجود نام مشتری ذینفع در زنجیره انتقالات چک، در صورت عدم وجود مقدار خالی برگردانده می شود" }, "idCode": { "type": "string", "example": "1111111111", "description": "کد شناسایی دارنده چک مشتری حقیقی: کد ملی مشتری حقوقی: شناسه ملی شرکت" }, "idType": { "type": "integer", "example": 1, "description": "نوع کد شناسایی: 1:مشتری حقیقی 2:مشتری حقوقی 3: اتباع بیگانه حقیقی 4: اتباع بیگانه حقوقی" } }, "description": "در صورت وجود نام مشتری ذینفع در زنجیره انتقالات چک، در صورت عدم وجود مقدار خالی برگردانده می شود" }, "description": "در صورت وجود نام مشتری ذینفع در زنجیره انتقالات چک، در صورت عدم وجود مقدار خالی برگردانده می شود" }, "roleType": { "type": "integer", "example": 1, "description": "نوع شخص" } }, "description": "لیست اطلاعات هویتی فرد/افراد موجود در یک زنجیره از انتقالات چک که در جدول مشخصات افراد موجود در زنجیره انتقالات چک شرح داده شده است." }, "description": "لیست اطلاعات هویتی فرد/افراد موجود در یک زنجیره از انتقالات چک که در جدول مشخصات افراد موجود در زنجیره انتقالات چک شرح داده شده است." } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_nid_sms_guarantyInquiry_get_inquiry_getResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20002300000", "description": "ریسپانس‌ کد مربوط به این فراخوانی" }, "trackId": { "type": "string", "example": "0705ae6c-ac95-4574-moho-0e85d149d9bf", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "guarantyFirstName": { "type": "string", "example": "امیرمحمد", "description": "نام ضامن" }, "guarantyLastName": { "type": "string", "example": "اسد", "description": "نام خانوادگی ضامن" }, "guarantyNationalCode": { "type": "string", "example": "1234567890", "description": "کد ملی ضامن" }, "guarantyLegalId": { "type": [ "string", "null" ], "description": "شناسه حقوقی گارانتی" }, "inquiryResultId": { "type": "string", "example": "12345678", "description": "شناسه پاسخ استعلام" }, "debtorList": { "type": "array", "items": { "type": "object", "properties": { "debtorFirstName": { "type": "string", "example": "اکبر", "description": "نام وام‌گیرنده" }, "debtorLastName": { "type": "string", "example": "اکبری", "description": "نام خانوادگی وام‌گیرنده" }, "totalAmount": { "type": "string", "example": "97488736", "description": "مانده کلی بدهی" }, "benefitAmount": { "type": "string", "example": "90445871", "description": "‫سود‬ ‫مبلغ‬" }, "obligationAmount": { "type": "string", "example": "0", "description": "مبلغ وجه التزام" }, "suspiciousAmount": { "type": "string", "example": "0", "description": "مانده مشکوک الوصول" }, "deferredAmount": { "type": "string", "example": "0", "description": "مانده معوقه" }, "orginalAmount": { "type": "string", "example": "300000000", "description": "اصل مبلغ تسهیلات" }, "pastExpiredAmount": { "type": "string", "example": "0", "description": "مانده سررسید گذشته" }, "bankCode": { "type": "string", "example": "13", "description": "کد بانک" }, "setDate": { "type": "string", "example": "13980521", "description": "تاریخ تنظیم قرارداد" }, "endDate": { "type": "string", "example": "14010621", "description": "تاریخ سررسید نهایی" }, "guarantyPercent": { "type": "string", "example": "100", "description": "درصد ضمانت ضامن در این وام" }, "requestNumber": { "type": "string", "example": "2222222222222222", "description": "شماره درخواست" }, "requestType": { "type": "string", "example": "3", "description": "نوع درخواست" }, "branchCode": { "type": "string", "example": "00144", "description": "کد شعبه بانک" }, "branchDescription": { "type": "string", "example": "بانک صادرات - شعبه شهید نامجو", "description": "نام و شعبه بانک صادر کننده تسهیلات" }, "guarantyIdNumber": { "type": "string", "example": "0123456789", "description": "شماره ملي اشخاص حقيقي ضمانت شده" }, "guarantyLegalId": { "type": "string", "example": "0", "description": "شناسه حقوقی گارانتی" }, "defunctAmount": { "type": [ "string", "null" ], "description": "مانده سوخت شده" }, "commitmentBalanceAmount": { "type": "string", "example": "0", "description": "مانده تعهد" }, "latePenaltyAmount": { "type": "string", "example": "0", "description": "جریمه دیرکرد" } }, "description": "لیست وام‌هایی که فرد ضامن آن‌ها بوده است." }, "description": "لیست وام‌هایی که فرد ضامن آن‌ها بوده است." } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_backChequesLegal_get_legal_getResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20003000000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "getBackCheques12312", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "nid": { "type": [ "string", "null" ], "description": "کد ملی کاربر" }, "legalId": { "type": "string", "example": "14001111111", "description": "شناسه حقوقی" }, "name": { "type": "string", "example": "فینوتک پارس", "description": "نام و نام خانوادگی کاربر" }, "chequeList": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "example": "000000000013152586", "description": "شماره حساب مربوط به چک" }, "amount": { "type": "string", "example": "900000000", "description": "مبلغ چک برگشتی" }, "backDate": { "type": "string", "example": "13960310", "description": "تاریخ برگشت چک" }, "bankCode": { "type": "string", "example": "18", "description": "bankCode (see legacy documentation)" }, "branchCode": { "type": "string", "example": "00167", "description": "کد شعبه صادر کننده چک" }, "branchDescription": { "type": "string", "example": "بانک تجارت - فخررازي", "description": "نام و شعبه بانک صادر کننده چک" }, "date": { "type": "string", "example": "13960310", "description": "تاریخ وصول چک" }, "id": { "type": "string", "example": "090922111", "description": "شناسه چک" }, "number": { "type": "string", "example": "0000887329", "description": "شماره چک" } }, "description": "لیست چک های برگشتی کاربر" }, "description": "لیست چک های برگشتی کاربر" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_backCheques_get_cheques_getResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "getBackCheques12312", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "nid": { "type": "string", "example": "0012345678", "description": "کد ملی کاربر" }, "name": { "type": "string", "example": "سپهر صبور", "description": "نام و نام خانوادگی کاربر" }, "chequeList": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "example": "000000000013152586", "description": "شماره حساب مربوط به چک" }, "amount": { "type": "integer", "example": 900000000, "description": "مبلغ چک برگشتی" }, "bankCode": { "type": "integer", "example": 17, "description": "کد بانک صادر کننده چک" }, "backDate": { "type": "string", "example": "13960610", "description": "تاریخ برگشت چک" }, "date": { "type": "string", "example": "13960310", "description": "تاریخ وصول چک" }, "branchCode": { "type": "string", "example": "00151", "description": "کد شعبه صادر کننده چک" }, "dishonoringBranchName": { "type": "string", "example": "بانک تجارت - فخررازي", "description": "نام شعبه برگشت زننده" }, "branchDescription": { "type": "string", "example": "بانک تجارت - فخررازي", "description": "نام و شعبه بانک صادر کننده چک" }, "dishonorReason": { "type": "string", "example": "حساب داراي كسر موجودي است.", "description": "دلیل برگشت" }, "branchBounced": { "type": "string", "example": "00151", "description": "کد شعبه برگشت زننده" }, "id": { "type": "string", "example": "090922111", "description": "کد رهگیری چک" }, "number": { "type": "string", "example": "0000887329", "description": "شماره چک" } }, "description": "لیست چک های برگشتی کاربر" }, "description": "لیست چک های برگشتی کاربر" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_facilityInquiryLegal_get_legal_getResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20003500000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "getfacility213454", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "user": { "type": [ "string", "null" ], "description": "کد ملی کاربر" }, "legalId": { "type": "string", "example": "14001111111", "description": "شناسه حقوقی" }, "name": { "type": "string", "example": "فینوتک پارس", "description": "نام و نام خانوادگی کاربر" }, "facilityTotalAmount": { "type": "string", "example": "324921522", "description": "مجموع مبلغ تسهیلات" }, "facilityDebtTotalAmount": { "type": "string", "example": "101017180", "description": "مجموع تسهیلات مانده" }, "facilityPastExpiredTotalAmount": { "type": "string", "example": "0", "description": "facilityPastExpiredTotalAmount (see legacy documentation)" }, "facilityDeferredTotalAmount": { "type": "string", "example": "0", "description": "مانده معوق" }, "facilitySuspiciousTotalAmount": { "type": "string", "example": "0", "description": "مانده مشکوک الوصول" }, "dishonored": { "type": "string", "example": "", "description": "بدحسابی" }, "facilityList": { "type": "array", "items": { "type": "object", "properties": { "bankCode": { "type": "string", "example": "14", "description": "کد بانک" }, "branchCode": { "type": "string", "example": "91182", "description": "شعبه بانک" }, "branchDescription": { "type": "string", "example": "بانک مسکن - مسکن - تهران - پارک دانشجوتهران", "description": "نام و شعبه بانک صادر کننده تسهیلات" }, "pastExpiredAmount": { "type": "string", "example": "0", "description": "مانده سررسید گذشته" }, "deferredAmount": { "type": "string", "example": "0", "description": "مانده معوقه" }, "suspiciousAmount": { "type": "string", "example": "0", "description": "مانده مشکوک الوصول" }, "debtorTotalAmount": { "type": "string", "example": "101017180", "description": "مانده کلی بدهی" }, "type": { "type": "string", "example": "18", "description": "نوع قرارداد" }, "amountOrginal": { "type": "string", "example": "180000000", "description": "‫اصل‬ ‫مبلغ‬" }, "benefitAmount": { "type": "string", "example": "101017180", "description": "‫سود‬ ‫مبلغ‬" }, "FacilityBankCode": { "type": "string", "example": "14", "description": "کد بانک" }, "FacilityBranchCode": { "type": "string", "example": "02159", "description": "کد شعبه بانک" }, "FacilityBranch": { "type": "string", "example": "بانک مسکن - شهیدنامجوی تهران", "description": "شعبه بانک" }, "FacilityRequestNo": { "type": "string", "example": "0215997049192414", "description": "شماره درخواست" }, "FacilityRequestType": { "type": "string", "example": "3", "description": "نوع درخواست" }, "FacilityCurrencyCode": { "type": "string", "example": "IRR", "description": "\"IRR\"" }, "FacilityPastExpiredAmount": { "type": "string", "example": "0", "description": "مانده سررسید گذشته" }, "FacilityDeferredAmount": { "type": "string", "example": "0", "description": "مانده معوقه" }, "FacilitySuspiciousAmount": { "type": "string", "example": "0", "description": "مانده مشکوک الوصول" }, "FacilityDebtorTotalAmount": { "type": "string", "example": "1151155953", "description": "مانده کل بدهی" }, "FacilityType": { "type": "string", "example": "18", "description": "نوع عقد قرارداد تسهيلات" }, "FacilityStatus": { "type": "string", "example": "جاری", "description": "وضعیت" }, "FacilityAmountOrginal": { "type": "string", "example": "600000000", "description": "اصل مبلغ تسهیلات" }, "FacilityBenefitAmount": { "type": "string", "example": "752873056", "description": "سود مبلغ تسهیلات" }, "FacilitySetDate": { "type": "string", "example": "13970430", "description": "تاریخ تنظیم قرارداد" }, "FacilityEndDate": { "type": "string", "example": "14090430", "description": "تاریخ سررسید نهایی" }, "FacilityAmountObligation": { "type": "string", "example": "0", "description": "مبلغ وجه التزام" }, "FacilityGroup": { "type": "string", "example": "اصلي", "description": "دسته بندی" }, "FacilityMoratoriumDate": { "type": "string", "example": "0", "description": "تاریخ" } }, "description": "لیست تسهیلات مشتری" }, "description": "لیست تسهیلات مشتری" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_facilityInquiry_get_inquiry_getResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "getfacility213454", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "user": { "type": "string", "example": "007133195", "description": "کد ملی کاربر" }, "name": { "type": "string", "example": "امیر قریشی مقدم", "description": "نام و نام خانوادگی کاربر" }, "facilityTotalAmount": { "type": "string", "example": "324921522", "description": "مجموع مبلغ تسهیلات" }, "facilityDebtTotalAmount": { "type": "string", "example": "101017180", "description": "مجموع تسهیلات مانده" }, "facilityPastExpiredTotalAmount": { "type": "string", "example": "0", "description": "facilityPastExpiredTotalAmount (see legacy documentation)" }, "facilityDeferredTotalAmount": { "type": "string", "example": "0", "description": "مانده معوق" }, "facilitySuspiciousTotalAmount": { "type": "string", "example": "0", "description": "مانده مشکوک الوصول" }, "dishonored": { "type": "string", "example": "", "description": "بدحسابی" }, "facilityList": { "type": "array", "items": { "type": "object", "properties": { "bankCode": { "type": "string", "example": "14", "description": "کد بانک" }, "branchCode": { "type": "string", "example": "91182", "description": "شعبه بانک" }, "branchDescription": { "type": "string", "example": "بانک مسکن - مسکن - تهران - پارک دانشجوتهران", "description": "نام و شعبه بانک صادر کننده تسهیلات" }, "pastExpiredAmount": { "type": "string", "example": "0", "description": "مانده سررسید گذشته" }, "deferredAmount": { "type": "string", "example": "0", "description": "مانده معوقه" }, "suspiciousAmount": { "type": "string", "example": "0", "description": "مانده مشکوک الوصول" }, "debtorTotalAmount": { "type": "string", "example": "101017180", "description": "مانده کلی بدهی" }, "type": { "type": "string", "example": "18", "description": "نوع قرارداد" }, "amountOrginal": { "type": "string", "example": "180000000", "description": "‫اصل‬ ‫مبلغ‬" }, "benefitAmount": { "type": "string", "example": "101017180", "description": "‫سود‬ ‫مبلغ‬" }, "FacilityBankCode": { "type": "string", "example": "14", "description": "کد بانک" }, "FacilityBranchCode": { "type": "string", "example": "02159", "description": "کد شعبه بانک" }, "FacilityBranch": { "type": "string", "example": "بانک مسکن - شهیدنامجوی تهران", "description": "شعبه بانک" }, "FacilityRequestNo": { "type": "string", "example": "0215997049192414", "description": "شماره درخواست" }, "FacilityRequestType": { "type": "string", "example": "3", "description": "نوع درخواست" }, "FacilityCurrencyCode": { "type": "string", "example": "IRR", "description": "\"IRR\"" }, "FacilityPastExpiredAmount": { "type": "string", "example": "0", "description": "مانده سررسید گذشته" }, "FacilityDeferredAmount": { "type": "string", "example": "0", "description": "مانده معوقه" }, "FacilitySuspiciousAmount": { "type": "string", "example": "0", "description": "مانده مشکوک الوصول" }, "FacilityDebtorTotalAmount": { "type": "string", "example": "1151155953", "description": "مانده کل بدهی" }, "FacilityType": { "type": "string", "example": "18", "description": "نوع عقد قرارداد تسهيلات" }, "FacilityStatus": { "type": "string", "example": "جاری", "description": "وضعیت" }, "FacilityAmountOrginal": { "type": "string", "example": "600000000", "description": "اصل مبلغ تسهیلات" }, "FacilityBenefitAmount": { "type": "string", "example": "752873056", "description": "سود مبلغ تسهیلات" }, "FacilitySetDate": { "type": "string", "example": "13970430", "description": "تاریخ تنظیم قرارداد" }, "FacilityEndDate": { "type": "string", "example": "14090430", "description": "تاریخ سررسید نهایی" }, "FacilityAmountObligation": { "type": "string", "example": "0", "description": "مبلغ وجه التزام" }, "FacilityGroup": { "type": "string", "example": "اصلي", "description": "دسته بندی" }, "FacilityMoratoriumDate": { "type": "string", "example": "0", "description": "تاریخ" } }, "description": "لیست تسهیلات مشتری" }, "description": "لیست تسهیلات مشتری" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_backCheques_get_cheques_getResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20000500000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "ae2ecba2-0d62-486f-moho-deec782f1f55", "description": "کد پیگیری که در فراخوانی سرویس فرستاده شده است." }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "nid": { "type": "string", "example": "0012345678", "description": "کد ملی کاربر" }, "legalId": { "type": [ "string", "null" ], "description": "شناسه حقوقی کاربر" }, "name": { "type": "string", "example": "سپهر صبور", "description": "نام و نام خانوادگی کاربر" }, "chequeList": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "example": "000000000013152586", "description": "شماره حساب مربوط به چک" }, "amount": { "type": "integer", "example": 900000000, "description": "مبلغ چک برگشتی" }, "bankCode": { "type": "integer", "example": 17, "description": "کد بانک صادر کننده چک" }, "branchCode": { "type": "string", "example": "00151", "description": "کد شعبه صادر کننده چک" }, "branchDescription": { "type": "string", "example": "بانک تجارت - فخررازي", "description": "نام و شعبه بانک صادر کننده چک" }, "dishonoringBranchName": { "type": "string", "example": "بانک تجارت - فخررازي", "description": "نام شعبه برگشت زننده" }, "dishonorReason": { "type": "string", "example": "حساب داراي كسر موجودي است.", "description": "دلیل برگشت" }, "branchBounced": { "type": "string", "example": "00151", "description": "کد شعبه برگشت زننده" }, "date": { "type": "string", "example": "13960310", "description": "تاریخ وصول چک" }, "backDate": { "type": "string", "example": "13960610", "description": "تاریخ برگشت چک" }, "id": { "type": "string", "example": "090922111", "description": "کد رهگیری چک" }, "number": { "type": "string", "example": "0000887329", "description": "شماره چک" } }, "description": "لیست چک های برگشتی کاربر" }, "description": "لیست چک های برگشتی کاربر" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_facilityInquiry_get_inquiry_getResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTKZ-20000100000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "95d682a0-9c48-4927-moho-ecc70e134272", "description": "کد پیگیری که در فراخوانی سرویس فرستاده شده است." }, "status": { "type": "string", "example": "DONE", "description": "DONE/FAILED" }, "result": { "type": "object", "properties": { "user": { "type": "string", "example": "0012345678", "description": "کد ملی کاربر" }, "legalId": { "type": [ "string", "null" ], "description": "شناسه حقوقی" }, "name": { "type": "string", "example": "حسین رحمتی شادان", "description": "نام و نام خانوادگی کاربر" }, "facilityTotalAmount": { "type": "string", "example": "324921522", "description": "مجموع مبلغ تسهیلات" }, "facilityDebtTotalAmount": { "type": "string", "example": "101017180", "description": "مجموع تسهیلات مانده" }, "facilityPastExpiredTotalAmount": { "type": "string", "example": "0", "description": "facilityPastExpiredTotalAmount (see legacy documentation)" }, "facilityDeferredTotalAmount": { "type": "string", "example": "0", "description": "مانده معوق" }, "facilitySuspiciousTotalAmount": { "type": "string", "example": "0", "description": "مانده مشکوک الوصول" }, "dishonored": { "type": "string", "example": "", "description": "بدحسابی" }, "facilityList": { "type": "array", "items": { "type": "object", "properties": { "bankCode": { "type": "string", "example": "14", "description": "bankCode (see legacy documentation)" }, "branchCode": { "type": "string", "example": "91182", "description": "branchCode (see legacy documentation)" }, "branchDescription": { "type": "string", "example": "بانک مسکن - مسکن - تهران - پارک دانشجوتهران", "description": "branchDescription (see legacy documentation)" }, "pastExpiredAmount": { "type": "string", "example": "0", "description": "pastExpiredAmount (see legacy documentation)" }, "deferredAmount": { "type": "string", "example": "0", "description": "deferredAmount (see legacy documentation)" }, "suspiciousAmount": { "type": "string", "example": "0", "description": "suspiciousAmount (see legacy documentation)" }, "debtorTotalAmount": { "type": "string", "example": "101017180", "description": "debtorTotalAmount (see legacy documentation)" }, "type": { "type": "string", "example": "18", "description": "type (see legacy documentation)" }, "amountOrginal": { "type": "string", "example": "180000000", "description": "amountOrginal (see legacy documentation)" }, "benefitAmount": { "type": "string", "example": "101017180", "description": "benefitAmount (see legacy documentation)" }, "FacilityBankCode": { "type": "string", "example": "14", "description": "کد بانک" }, "FacilityBranchCode": { "type": "string", "example": "02159", "description": "کد شعبه بانک" }, "FacilityBranch": { "type": "string", "example": "بانک مسکن - شهیدنامجوی تهران", "description": "شعبه بانک" }, "FacilityRequestNo": { "type": "string", "example": "0215997049192414", "description": "شماره درخواست" }, "FacilityRequestType": { "type": "string", "example": "3", "description": "نوع درخواست" }, "FacilityCurrencyCode": { "type": "string", "example": "IRR", "description": "\"IRR\"" }, "FacilityPastExpiredAmount": { "type": "string", "example": "0", "description": "مانده سررسید گذشته" }, "FacilityDeferredAmount": { "type": "string", "example": "0", "description": "مانده معوقه" }, "FacilitySuspiciousAmount": { "type": "string", "example": "0", "description": "مانده مشکوک الوصول" }, "FacilityDebtorTotalAmount": { "type": "string", "example": "1151155953", "description": "مانده کل بدهی" }, "FacilityType": { "type": "string", "example": "18", "description": "نوع عقد قرارداد تسهيلات" }, "FacilityStatus": { "type": "string", "example": "جاری", "description": "وضعیت" }, "FacilityAmountOrginal": { "type": "string", "example": "600000000", "description": "اصل مبلغ تسهیلات" }, "FacilityBenefitAmount": { "type": "string", "example": "752873056", "description": "سود مبلغ تسهیلات" }, "FacilitySetDate": { "type": "string", "example": "13970430", "description": "تاریخ تنظیم قرارداد" }, "FacilityEndDate": { "type": "string", "example": "14090430", "description": "تاریخ سررسید نهایی" }, "FacilityAmountObligation": { "type": "string", "example": "0", "description": "مبلغ وجه التزام" }, "FacilityGroup": { "type": "string", "example": "اصلي", "description": "دسته بندی" }, "FacilityMoratoriumDate": { "type": "string", "example": "0", "description": "تاریخ" } }, "description": "لیست تسهیلات مشتری" }, "description": "لیست تسهیلات مشتری" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_sayadAcceptCheque_post_sms_postResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "7113b244-3c01-44f1-b395-e3ab464cfeaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "message": { "type": "string", "example": "تایید چک با موفقیت انجام شد", "description": "پیغام مبنی بر تایید چک" }, "referenceId": { "type": "string", "example": "11111111111111", "description": "کد رهگیری" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_sayadCancelCheque_post_sms_postResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "7113b244-3c01-44f1-b395-e3ab464cfeaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "message": { "type": "string", "example": "لغو چک با موفقیت انجام شد", "description": "پیغام مبنی بر لغو چک" }, "referenceId": { "type": "string", "example": "11111111111111", "description": "کد رهگیری" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_sayadChequeInquiry_get_sms_getResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "7113b244-3c01-44f1-b395-e3ab464cfeaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "message": { "type": "string", "example": "استعلام چک با موفقیت انجام شد", "description": "پیغام مبنی بر ستعلام چک" }, "referenceId": { "type": "string", "example": "25161234064321", "description": "کد رهگیری" }, "sayadId": { "type": "string", "example": "0000000000000000", "description": "شناسه صیاد چک" }, "branchCode": { "type": "string", "example": "5502227", "description": "کد شعبه عهده چک" }, "bankCode": { "type": "string", "example": "57", "description": "کد بانک عهده" }, "amount": { "type": "integer", "example": 100000, "description": "مبلغ چک" }, "dueDate": { "type": "string", "example": "14001027", "description": "تاریخ خورشیدی سررسید چک" }, "description": { "type": "string", "example": "تست ", "description": "شرح چک" }, "serialNo": { "type": "string", "example": "283331", "description": "شماره سریال چک" }, "seriesNo": { "type": "string", "example": "9999", "description": "شماره سری چک" }, "fromIban": { "type": "string", "example": "IR550770000000104272127001", "description": "کد شبا حساب عهده" }, "reason": { "type": "string", "example": "POSA", "description": "reason (see legacy documentation)" }, "currency": { "type": "integer", "example": 1, "description": "نوع ارز چک" }, "chequeStatus": { "type": "integer", "example": 1, "description": "chequeStatus (see legacy documentation)" }, "chequeType": { "type": "integer", "example": 1, "description": "نوع چک" }, "chequeMedia": { "type": "integer", "example": 1, "description": "chequeMedia (see legacy documentation)" }, "blockStatus": { "type": "integer", "example": 0, "description": "وضعیت مسدودی چک" }, "guaranteeStatus": { "type": "integer", "example": 1, "description": "وضعیت ضمانت چک" }, "locked": { "type": "integer", "example": 0, "description": "locked (see legacy documentation)" }, "holders": { "type": "array", "items": { "type": "object", "properties": { "idCode": { "type": "string", "example": "0050000039", "description": "کد شناسایی دارنده چک" }, "idType": { "type": "integer", "example": 1, "description": "نوع کد شناسایی با ملاحظات زیر:" }, "name": { "type": "string", "example": "چارلز بوکوفسکی", "description": "نام دارندگان چک" } }, "description": "لیست دارندگان چک" }, "description": "لیست دارندگان چک" }, "signers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "آلبرکامو", "description": "نام دارندگان چک" }, "legalStamp": { "type": "integer", "example": 0, "description": "آیا این امضا به معنای مهر حقوقی میماند یا خیر" } }, "description": "لیست امضاکنندگان" }, "description": "لیست امضاکنندگان" }, "lockerBankCode": { "type": "string", "example": "", "description": "کد بانک لاک کننده چک در صورتی که چک به بانک ارائه شده باشد." }, "lockerBranchCode": { "type": "string", "example": "", "description": "کد شعبه لاک کننده چک در صورتی که چک به بانک ارائه شده باشد." }, "issueDate": { "type": "string", "example": "14001025143237", "description": "تاریخ و ساعت ثبت اولیه چک در سامانه" }, "toIban": { "type": [ "string", "null" ], "description": "شماره شبا حساب مقصد. در چک تضمینی این فیلد حاوی شماره شبای ذینفع چک قطعا دارای مقدار می باشد." } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "Credit_v2_clients_clientId_users_user_sms_sayadIssuerInquiryCheque_post_inquiry_Response": { "type": "object", "properties": { "trackId": { "type": "string", "example": "7113b244-3c01-44f1-b395-e3ab464cfeaa", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "referenceId": { "type": "string", "example": "11111111111111", "description": "کد رهگیری" }, "inquiryResult": { "type": "object", "properties": { "sayadId": { "type": "string", "example": "5000000000000000", "description": "شناسه صیاد چک" }, "branchCode": { "type": "string", "example": "0000000", "description": "کد شعبه عهده چک" }, "bankCode": { "type": "string", "example": "62", "description": "کد بانک عهده" }, "amount": { "type": "integer", "example": 0, "description": "مبلغ چک" }, "dueDate": { "type": "string", "example": "00000000", "description": "تاریخ خورشیدی سررسید چک" }, "description": { "type": "string", "example": " جهت تست سرویس ", "description": "توضیحات" }, "serialNo": { "type": "string", "example": "000000", "description": "شماره سریال چک" }, "seriesNo": { "type": "string", "example": "0000", "description": "شماره سری چک" }, "fromIban": { "type": "string", "example": "IR000000000000000000000000", "description": "کد شبا حساب عهده" }, "reason": { "type": [ "string", "null" ], "description": "بابت چک یا در صورتیکه انتقال داشته باشد بابت آخرین انتقال" }, "currency": { "type": "integer", "example": 1, "description": "نوع ارز چک" }, "chequeStatus": { "type": "integer", "example": 1, "description": "وضعیت چک" }, "chequeType": { "type": "integer", "example": 1, "description": "نوع چک" }, "chequeMedia": { "type": "integer", "example": 1, "description": "chequeMedia (see legacy documentation)" }, "blockStatus": { "type": "integer", "example": 0, "description": "blockStatus (see legacy documentation)" }, "guaranteeStatus": { "type": "integer", "example": 1, "description": "وضعیت ضمانت چک" }, "locked": { "type": "integer", "example": 0, "description": "locked (see legacy documentation)" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "idCode": { "type": "string", "example": "0000000000", "description": "کد شناسایی" }, "idType": { "type": "integer", "example": 1, "description": "نوع کد شناسایی با ملاحظات زیر" }, "name": { "type": "string", "example": "چارلز دیکنز", "description": "نام" } }, "description": "لیست گیرندگان چک" }, "description": "لیست گیرندگان چک" }, "issueDate": { "type": "string", "example": "14001218095015", "description": "تاریخ ثبت" } }, "description": "inquiryResult (see legacy documentation)" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "CreditAssessmentSubmitResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTFH-20003800000", "description": "کد پاسخ فینوتک" }, "trackId": { "type": "string", "description": "کد پیگیری؛ اگر ارسال شده باشد همان مقدار و در غیر این صورت یک رشته تصادفی" }, "assessmentId": { "type": "string", "example": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f", "description": "شناسه گزارش. در مرحله دریافت نتیجه همین مقدار را بفرستید. وضعیت و مرحله فقط در inquiry برمی‌گردد." } }, "required": [ "assessmentId", "responseCode" ] }, "CreditAssessmentReportData": { "type": "object", "description": "گزارش JSON. اعداد به صورت رشته لاتین هستند.\nدر سطح `base` فیلد `facilityList` برابر `null` است.\nفیلدهای ضمانت فقط در سطح `advance` می‌آیند.\n", "properties": { "reportInformation": { "type": "object", "properties": { "reportLevel": { "type": "string", "enum": [ "basic", "standard", "advanced" ], "description": "سطح گزارش در خروجی JSON" }, "reportLevelDescription": { "type": "string", "description": "عنوان فارسی سطح گزارش (پایه / استاندارد / پیشرفته)" }, "reportId": { "type": "string", "description": "شناسه یکتای گزارش" }, "reportDate": { "type": "string", "description": "تاریخ تهیه گزارش (شمسی)" } } }, "user": { "type": "object", "properties": { "name": { "type": "string" }, "nationalCode": { "type": "string" }, "fatherName": { "type": "string" }, "birthDate": { "type": "string" }, "birthPlace": { "type": "string" }, "gender": { "type": "string" }, "maritalStatus": { "type": "string" }, "mobile": { "type": "string" }, "address": { "type": "string" } } }, "creditScore": { "type": "object", "properties": { "score": { "type": "string", "description": "امتیاز اعتباری (رشته لاتین)" }, "risk": { "type": "string", "description": "کد ریسک (مثل A2)" }, "riskDescription": { "type": "string" }, "minLimit": { "type": "string" }, "maxLimit": { "type": "string" }, "scoreFactorList": { "type": "array", "items": { "type": "object", "properties": { "indicator": { "type": "string" }, "description": { "type": "string" }, "changeRate": { "type": "string" }, "score": { "type": "string" } } } }, "scoreReasonList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "string" } } } } } }, "positiveSignalList": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } } }, "attentionSignalList": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } } }, "inquirySummaryList": { "type": "array", "items": { "type": "object", "properties": { "organizationType": { "type": "string" }, "lastMonthInquiryCount": { "type": "string" }, "lastYearInquiryCount": { "type": "string" }, "personNegativeStatusCount": { "type": "string" }, "contractNegativeStatusCount": { "type": "string" } } } }, "inquiryList": { "type": "array", "items": { "type": "object", "properties": { "bankCode": { "type": "string" }, "bankName": { "type": "string" }, "inquiryDate": { "type": "string" } } } }, "facilityTotalAmount": { "type": "string", "description": "مجموع مبلغ تسهیلات (ریال، رشته لاتین)" }, "facilityDebtTotalAmount": { "type": "string" }, "facilityPastExpiredTotalAmount": { "type": "string" }, "facilityDeferredTotalAmount": { "type": "string" }, "facilitySuspiciousTotalAmount": { "type": "string" }, "facilitySummaryList": { "type": "array", "items": { "type": "object", "properties": { "bankCode": { "type": "string" }, "bankName": { "type": "string" }, "facilityTotalAmount": { "type": "string" }, "facilityDebtTotalAmount": { "type": "string" }, "facilityPastExpiredTotalAmount": { "type": "string" }, "inProgressFacilityCount": { "type": "string" }, "terminatedFacilityCount": { "type": "string" }, "currency": { "type": "string" } } } }, "facilityList": { "description": "لیست تسهیلات. در سطح پایه `null` است", "type": "array", "items": { "type": "object", "properties": { "bankCode": { "type": "string" }, "bankName": { "type": "string" }, "branchCode": { "type": "string" }, "pastExpiredAmount": { "type": "string" }, "deferredAmount": { "type": "string" }, "suspiciousAmount": { "type": "string" }, "debtorTotalAmount": { "type": "string" }, "type": { "type": "string" }, "amountOrginal": { "type": "string" }, "benefitAmount": { "type": "string" }, "FacilityRequestNo": { "type": "string" }, "FacilityType": { "type": "string" }, "FacilityStatus": { "type": "string" }, "FacilityAmountOrginal": { "type": "string" }, "FacilitySetDate": { "type": "string" }, "FacilityEndDate": { "type": "string" }, "FacilityAmountObligation": { "type": "string" }, "role": { "type": "string" }, "purpose": { "type": "string" }, "paymentMethod": { "type": "string" }, "paymentPeriodicity": { "type": "string" }, "negativeStatus": { "type": "string" }, "collateralList": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "relatedPersonList": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string" }, "nationalCode": { "type": "string", "description": "کد ملی ماسک‌شده" }, "name": { "type": "string" } } } }, "repaymentList": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "dishonored": { "type": "object", "properties": { "hasActiveDishonored": { "type": "boolean" }, "dishonoredCount": { "type": "string" }, "dishonoredTotalAmount": { "type": "string" }, "dishonoredList": { "type": "array", "items": { "type": "object", "properties": { "chequeId": { "type": "string", "description": "شناسه چک ماسک‌شده" }, "bankName": { "type": "string" }, "amount": { "type": "string" }, "bouncedDate": { "type": "string" }, "clearedDate": { "type": "string" } } } }, "realCheque": { "type": "object", "properties": { "score": { "type": "string" }, "rank": { "type": "string" }, "hasPenalty": { "type": "boolean" }, "possibilityBouncedCheck": { "type": "string" }, "summaryList": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "reasonList": { "type": "array", "items": { "type": "string" } }, "noticeList": { "type": "array", "items": { "type": "string" } } } } } }, "taxList": { "type": "array", "items": { "type": "object", "properties": { "taxYear": { "type": "string" }, "accountingDate": { "type": "string" }, "declaredIncomeAmount": { "type": "string" }, "declaredTaxAmount": { "type": "string" }, "assessedTaxAmount": { "type": "string" }, "finalTaxAmount": { "type": "string" }, "collectedTaxAmount": { "type": "string" }, "penaltyAmount": { "type": "string" }, "performanceTaxDebtAmount": { "type": "string" }, "performanceTaxPenaltyAmount": { "type": "string" }, "employeeSalaryTaxAmount": { "type": "string" }, "employerSalaryTaxAmount": { "type": "string" }, "isOnTime": { "description": "آیا مالیات در موعد پرداخت شده است", "type": "boolean" } } } }, "reportedStatusList": { "type": "array", "items": { "type": "object", "properties": { "organizationName": { "type": "string" }, "organizationType": { "type": "string" }, "status": { "type": "string" }, "statusDate": { "type": "string" }, "facilityRequestNo": { "type": "string" } } } }, "historyList": { "type": "array", "items": { "type": "object", "properties": { "historyType": { "type": "string" }, "historySubType": { "type": "string" }, "value": { "type": "string" }, "organizationName": { "type": "string" }, "historyDate": { "type": "string" }, "description": { "type": "string" } } } }, "dataQuality": { "type": "object", "properties": { "dataLimitationList": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "description": { "type": "string" } } } } } }, "guaranteeTotalAmount": { "type": "string", "description": "فقط سطح پیشرفته" }, "guaranteeDebtTotalAmount": { "type": "string", "description": "فقط سطح پیشرفته" }, "guaranteePastExpiredTotalAmount": { "type": "string", "description": "فقط سطح پیشرفته" }, "guaranteeList": { "type": "array", "description": "فقط سطح پیشرفته", "items": { "type": "object", "properties": { "guaranteeBankCode": { "type": "string" }, "guaranteeBankName": { "type": "string" }, "GuaranteeRequestNo": { "type": "string" }, "GuaranteeType": { "type": "string" }, "GuaranteeStatus": { "type": "string" }, "GuaranteeAmountOrginal": { "type": "string" }, "GuaranteeDebtAmount": { "type": "string" }, "GuaranteePastExpiredAmount": { "type": "string" }, "GuaranteeSetDate": { "type": "string" }, "GuaranteeEndDate": { "type": "string" }, "role": { "type": "string" } } } } } }, "CreditAssessmentInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-CTFH-20003900000", "description": "کد پاسخ فینوتک" }, "trackId": { "type": "string", "description": "کد پیگیری؛ اگر ارسال شده باشد همان مقدار و در غیر این صورت یک رشته تصادفی" }, "assessmentId": { "type": "string", "example": "8f3c1a2e-4b90-4d11-9c2a-1a2b3c4d5e6f", "description": "شناسه گزارش" }, "status": { "type": "string", "enum": [ "IN_PROGRESS", "DONE" ], "description": "`IN_PROGRESS` یعنی گزارش هنوز آماده نیست؛ دوباره استعلام کنید.\n`DONE` یعنی گزارش کامل در `data` است.\n" }, "stage": { "type": "string", "description": "مرحله فعلی (فقط وقتی status برابر IN_PROGRESS است)", "enum": [ "CREATED", "ACCESS_INQUIRY", "MAIN_SUBMIT", "MAIN_POLL", "BOUNCED_CHEQUE", "SCORE_SUBMIT", "SCORE_POLL", "HISTORY_SUBMIT", "HISTORY_POLL", "TAX_FETCH", "CHEQUE_BASE_SUBMIT", "CHEQUE_BASE_POLL", "DONE", "FAILED" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100, "example": 65, "description": "درصد پیشرفت تقریبی (فقط در IN_PROGRESS)" }, "level": { "type": "string", "enum": [ "base", "standard", "advance" ], "description": "سطح گزارش" }, "outputType": { "type": "string", "enum": [ "json", "pdf" ], "description": "نوع خروجی ذخیره‌شده در مرحله ثبت درخواست؛ `json` یا `pdf` (فقط در DONE)" }, "data": { "description": "بدنه گزارش JSON (فقط وقتی status برابر DONE و outputType برابر json است)", "allOf": [ { "$ref": "#/components/schemas/CreditAssessmentReportData" } ] }, "fileName": { "type": "string", "example": "FinnotechAssessmentReport-6780026883-1405-06-17.pdf", "description": "نام فایل PDF (فقط وقتی status برابر DONE و outputType برابر pdf است)" }, "contentBase64": { "type": "string", "description": "محتوای PDF به‌صورت Base64 (فقط وقتی status برابر DONE و outputType برابر pdf است؛ بدون data)" } }, "required": [ "assessmentId", "status", "responseCode" ] }, "KybMatchLegalIdWithMembersResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "isMatched": { "type": "boolean", "description": "نتیجه انطباق شناسه شرکت با اعضا" }, "positions": { "type": "array", "items": { "type": "object", "properties": { "positionName": { "type": "string" }, "issueTrackingNo": { "type": "string" }, "rrkNewsPaperDate": { "type": "string" }, "rrkNewsPaperNumber": { "type": "string" }, "rrkPageNumber": { "type": "string" } } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KybCompanyInfoResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "additionalProperties": true, "properties": { "companyId": { "type": "integer" }, "registrationNo": { "type": "string" }, "title": { "type": "string" }, "registrationDate": { "type": "string" }, "capital": { "type": "integer" }, "address": { "type": "string" }, "postalCode": { "type": "string" }, "taxNumber": { "type": "string" }, "lat": { "type": "number" }, "lng": { "type": "number" }, "status": { "type": "string" }, "registrationTypeTitle": { "type": "string" }, "persianRegistrationDate": { "type": "string" }, "knowledgeBasedState": { "type": "string" }, "knowledgeBasedCategory": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KybCorporateJournalGetResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "array", "items": { "type": "object", "properties": { "newsId": { "type": "integer" }, "title": { "type": "integer" }, "description": { "type": "string" }, "companyId": { "type": "integer" }, "capitalTo": { "type": "integer" }, "newspaperDate": { "type": "string" }, "newsletterDate": { "type": "string" }, "newspaperNumber": { "type": "string" }, "newspaperCity": { "type": "string" }, "pageNumber": { "type": "integer" }, "indicatorNumber": { "type": "string" } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KybBoardMembersResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "boardMembers": { "type": "array", "items": { "type": "object", "properties": { "nationalId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "roleCode": { "type": "integer" }, "roleName": { "type": "string" } } } }, "shareHolders": { "type": "array", "items": { "type": "object", "properties": { "nationalId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "percentage": { "type": "number" } } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KybEnamadInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "licenseHolder": { "type": "string" }, "registeredDate": { "type": "string" }, "expirationDate": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KybCompanyLicenseItem": { "type": "object", "properties": { "type": { "type": "string", "description": "نوع مجوز" }, "title": { "type": "string", "description": "عنوان مجوز" }, "rawType": { "type": "string", "description": "مقدار اصلی نوع مجوز که از مرجع دریافت شده است." }, "status": { "type": "string", "description": "وضعیت مجوز" }, "isActive": { "type": "boolean", "description": "فعال بودن" }, "certificateNumber": { "type": "string", "description": "شماره یا شناسه مجوز" }, "issueDate": { "type": "string", "description": "تاریخ صدور" }, "expireDate": { "type": [ "string", "null" ], "description": "تاریخ انقضا" }, "issuer": { "type": "string", "description": "مرجع صادرکننده" }, "issuerDivision": { "type": "string", "description": "واحد صادرکننده" }, "category": { "type": "string", "description": "گروه یا دسته مجوز" }, "website": { "type": [ "string", "null" ], "description": "وب‌سایت مرجع" }, "categoryId": { "type": "integer", "description": "شناسه دسته‌بندی مجوز" }, "certificateIssuerId": { "type": "integer", "description": "شناسه مرجع صادرکننده" }, "certificateTypeTitle": { "type": "string", "description": "عنوان نوع مجوز" }, "isLatestForType": { "type": "boolean", "description": "مشخص می‌کند این مجوز جدیدترین مجوز از این نوع برای شرکت است یا خیر" } } }, "KybCompanyLicensesResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "description": "کد پیگیری" }, "status": { "type": "string", "description": "وضعیت فراخوانی — DONE یا FAILED" }, "result": { "type": "object", "description": "آبجکت پاسخ سرویس", "properties": { "enamadLicenses": { "type": "array", "description": "مجوزهای اینماد", "items": { "$ref": "#/components/schemas/KybCompanyLicenseItem" } }, "knowledgeBasedLicenses": { "type": "array", "description": "مجوزهای دانش‌بنیان", "items": { "$ref": "#/components/schemas/KybCompanyLicenseItem" } }, "licenseIrLicenses": { "type": "array", "description": "مجوزهای مجوز.آی‌آر", "items": { "$ref": "#/components/schemas/KybCompanyLicenseItem" } }, "productionLicenses": { "type": "array", "description": "مجوزهای تولید", "items": { "$ref": "#/components/schemas/KybCompanyLicenseItem" } }, "otherLicenses": { "type": "array", "description": "سایر مجوزها", "items": { "$ref": "#/components/schemas/KybCompanyLicenseItem" } }, "totalLicenses": { "type": "integer", "description": "مجموعه مجوز های شرکت به عدد" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "KybSignholdersGroup": { "type": "object", "properties": { "holders": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "obligatoryStatus": { "type": "string" }, "normalStatus": { "type": "string" }, "nationalId": { "type": "string" } } } }, "relationships": { "type": "array", "items": { "type": "object" } } } }, "KybAuthorizedSignatoriesResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "additionalProperties": true, "properties": { "newsId": { "type": "string" }, "allowedTopics": { "type": [ "string", "null" ] }, "signatureItemFullText": { "type": "string" }, "newspaperDate": { "type": "string" }, "newsletterDate": { "type": "string" }, "lastNewspaperDate": { "type": "string" }, "companyTitle": { "type": "string" }, "signholdersStatus": { "type": "object", "properties": { "obligatorySignature": { "$ref": "#/components/schemas/KybSignholdersGroup" }, "normalSignature": { "$ref": "#/components/schemas/KybSignholdersGroup" }, "obligatoryAndNormalSignature": { "$ref": "#/components/schemas/KybSignholdersGroup" } } }, "boardMembers": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "CorporateJournalSigner": { "type": "object", "required": [ "nationalId" ], "properties": { "nationalId": { "type": "string", "description": "Signer national ID (کد ملی)", "example": "0451448413" } } }, "CorporateJournalSubmitRequest": { "type": "object", "required": [ "requestId", "companyId", "signers", "documentType", "conditions" ], "properties": { "requestId": { "type": "string", "description": "Idempotency key and correlation ID for inquiry polling", "example": "req-003" }, "companyId": { "type": "string", "description": "Company national ID (شناسه ملی شرکت)", "example": "14007651115" }, "signers": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/CorporateJournalSigner" } }, "documentType": { "type": "string", "enum": [ "administrative", "financial" ], "description": "Document type — administrative or financial" }, "conditions": { "type": "string", "enum": [ "normal", "absence of CEO" ], "description": "Signing conditions — CEO present or absent" } } }, "CorporateJournalSubmitResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-KBRO-20200400000" }, "trackId": { "type": "string" }, "requestId": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING" ] }, "inquiryUrl": { "type": "string", "example": "/kyb/v2/clients/{clientId}/corporateJournal/inquiry" } } }, "CorporateJournalInquiryRequest": { "type": "object", "required": [ "requestId" ], "properties": { "requestId": { "type": "string", "description": "Request ID from the submit step", "example": "req-003" } } }, "CorporateJournalMatchingRule": { "type": "object", "properties": { "documentType": { "type": "string", "enum": [ "administrative", "financial" ] }, "conditions": { "type": "string", "enum": [ "normal", "absence of CEO" ] }, "signatories": { "type": "array", "items": { "type": "string" }, "description": "Required roles per the gazette rule" }, "signatureMode": { "type": "string", "enum": [ "single", "joint" ] }, "requiresSeal": { "type": "boolean" }, "expirationDate": { "type": "string", "description": "Jalali expiry date of the authorization rule", "example": "1405/06/28" } } }, "CorporateJournalVerifiedSigner": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "nationalId": { "type": "string" } } }, "CorporateJournalVerificationDetails": { "type": "object", "properties": { "allRequiredPresent": { "type": "boolean" }, "allSignersValid": { "type": "boolean" }, "ruleNotExpired": { "type": "boolean" }, "conditionsMatch": { "type": "boolean" } } }, "CorporateJournalMissingSigners": { "type": "object", "properties": { "requiredRoles": { "type": "array", "items": { "type": "string" } }, "message": { "type": "string" } } }, "CorporateJournalUnverifiedSigner": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "reason": { "type": "string" } } }, "CorporateJournalVerificationResult": { "type": "object", "properties": { "valid": { "type": "boolean", "description": "Overall pass/fail for the submitted signer set" }, "companyId": { "type": "string" }, "companyName": { "type": "string" }, "matchingRule": { "$ref": "#/components/schemas/CorporateJournalMatchingRule" }, "verifiedSigners": { "type": "array", "items": { "$ref": "#/components/schemas/CorporateJournalVerifiedSigner" } }, "verificationDetails": { "$ref": "#/components/schemas/CorporateJournalVerificationDetails" }, "missingSigners": { "$ref": "#/components/schemas/CorporateJournalMissingSigners" }, "unverifiedSigners": { "type": "array", "items": { "$ref": "#/components/schemas/CorporateJournalUnverifiedSigner" } }, "reason": { "type": "string", "description": "Present when no matching rule or company not found" } } }, "CorporateJournalInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "requestId": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "result": { "$ref": "#/components/schemas/CorporateJournalVerificationResult" }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } }, "ClientCredentialTokenRequest": { "type": "object", "required": [ "grant_type", "nid", "scopes" ], "properties": { "grant_type": { "type": "string", "enum": [ "client_credentials" ], "description": "باید برابر `client_credentials` باشد" }, "nid": { "type": "string", "description": "کد ملی ۱۰ رقمی فراخواننده که به کلاینت دسترسی دارد", "example": "0123456789" }, "scopes": { "type": "string", "description": "اسکوپ‌های درخواستی، با کاما از هم جدا می‌شوند", "example": "oak:deposit-to-iban:get" }, "bank": { "type": "string", "description": "کد بانک (برای برخی بانک‌ها الزامی)", "example": "054" }, "additionalInfo": { "type": "object", "description": "اطلاعات تکمیلی بانک (پارسیان، تجارت، رفاه)", "additionalProperties": true, "properties": { "deposit": { "type": "string", "description": "شماره حساب مبدا" }, "cif": { "type": "string", "description": "شماره مشتری (پارسیان)" }, "username": { "type": "string" }, "password": { "type": "string" }, "apikey": { "type": "string", "description": "کلید API (تجارت)" }, "firstPassword": { "type": "string", "description": "رمز اول (رفاه)" }, "secondPassword": { "type": "string", "description": "رمز دوم (رفاه)" } } } } }, "ClientCredentialTokenResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "description": "کد پاسخ" }, "status": { "type": "string", "enum": [ "DONE", "FAILED" ] }, "result": { "type": "object", "properties": { "value": { "type": "string", "description": "access token" }, "scopes": { "type": "array", "items": { "type": "string" } }, "lifeTime": { "type": "integer", "description": "عمر توکن (میلی‌ثانیه)" }, "creationDate": { "type": "string", "description": "تاریخ شمسی YYYYMMDDHHmmss" }, "refreshToken": { "type": "string" }, "_id": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "SmsAuthorizeResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "DONE", "FAILED" ] }, "result": { "type": "object", "properties": { "smsSent": { "type": "boolean" }, "trackId": { "type": "string", "description": "شناسه پیگیری برای مرحله verify" } } } } }, "SmsVerifyRequest": { "type": "object", "required": [ "mobile", "otp", "nid", "trackId" ], "properties": { "mobile": { "type": "string", "description": "شماره موبایل دریافت‌کننده OTP", "example": "09300000000" }, "otp": { "type": "string", "description": "کد دریافتی از پیامک", "example": "qMeQs" }, "nid": { "type": "string", "description": "کد ملی دریافت‌کننده OTP", "example": "0011674144" }, "trackId": { "type": "string", "description": "شناسه پیگیری مرحله authorize", "example": "3c35adb9-0164-4b5jjj6-9259-70022cff51e9" }, "legalId": { "type": "string", "description": "شناسه حقوقی (برای توکن حقوقی الزامی است)", "example": "10001110010" } } }, "SmsVerifyResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "DONE", "FAILED" ] }, "result": { "type": "object", "properties": { "code": { "type": "string", "description": "کد برای مرحله دریافت توکن" } } } } }, "SmsAuthorizationCodeTokenRequest": { "type": "object", "required": [ "grant_type", "code", "auth_type", "redirect_uri" ], "properties": { "grant_type": { "type": "string", "enum": [ "authorization_code" ] }, "code": { "type": "string", "description": "کد دریافتی از مرحله verify" }, "auth_type": { "type": "string", "enum": [ "SMS" ] }, "redirect_uri": { "type": "string", "format": "uri", "description": "باید با redirect_uri مرحله authorize یکسان باشد" }, "bank": { "type": "string", "description": "کد بانک" } } }, "SmsAuthorizationCodeTokenResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "DONE", "FAILED" ] }, "result": { "type": "object", "properties": { "tokenId": { "type": "string" }, "clientId": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "deposits": { "type": "array", "items": { "type": "string" } }, "lifeTime": { "type": "integer", "description": "عمر توکن (میلی‌ثانیه)" }, "bank": { "type": "string" }, "type": { "type": "string", "example": "CODE" }, "creationDate": { "type": "string", "description": "تاریخ شمسی YYYYMMDDHHmmss" }, "userId": { "type": "string" }, "maxAmountPerTransaction": { "type": "integer" }, "monthlyCallLimitation": { "type": "integer" }, "auth_type": { "type": "string", "example": "SMS" }, "refreshToken": { "type": "string" }, "legalId": { "type": "string", "description": "شناسه حقوقی (فقط توکن حقوقی)" }, "value": { "type": "string", "description": "access token" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "RefreshTokenRequest": { "type": "object", "required": [ "grant_type", "token_type", "refresh_token" ], "properties": { "grant_type": { "type": "string", "enum": [ "refresh_token" ], "description": "باید برابر `refresh_token` باشد" }, "token_type": { "type": "string", "enum": [ "CODE", "CLIENT-CREDENTIAL" ], "description": "نوع توکن (CLIENT-CREDENTIAL یا CODE)" }, "refresh_token": { "type": "string", "description": "رفرش توکن" }, "auth_type": { "type": "string", "enum": [ "SMS" ], "description": "در صورت رفرش توکن نوع SMS، ارسال این فیلد با مقدار SMS الزامی است" }, "bank": { "type": "string", "description": "کد بانک مقصد. برای توکن CODE غیر SMS و برای توکن کشاورزی الزامی است.\nبرای توکن SMS یا CLIENT_CREDENTIAL بدون حساب نیازی به ارسال نیست.\n", "example": "062" }, "deposit": { "type": "string", "description": "شماره حساب (برای رفرش توکن بانک کشاورزی الزامی است)" } } }, "RefreshTokenResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "DONE", "FAILED" ] }, "result": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" }, "description": "آرایه‌ای از اسکوپ‌های مجاز توکن" }, "monthlyCallLimitation": { "type": "integer", "description": "حداکثر تعداد تراکنش ماهانه به ازای یک توکن (تنها برای بانک کشاورزی)" }, "maxAmountPerTransaction": { "type": "integer", "description": "حداکثر مبلغ هر تراکنش به ریال (تنها برای بانک کشاورزی)" }, "userId": { "type": "string", "description": "کد ملی کاربر" }, "creationDate": { "type": "string", "description": "زمان ساخت توکن به صورت تاریخ شمسی YYYYMMDDHHmmss" }, "type": { "type": "string", "description": "نوع توکن", "example": "CODE" }, "bank": { "type": "string", "description": "کد بانک فرستاده شده" }, "lifeTime": { "type": "integer", "description": "عمر توکن به میلی‌ثانیه" }, "deposits": { "type": "array", "items": { "type": "string" }, "description": "شماره حساب‌های مجاز (تنها برای بانک کشاورزی)" }, "clientId": { "type": "string", "description": "نام اپلیکیشن" }, "value": { "type": "string", "description": "access token برای فراخوانی سرویس‌ها" }, "refreshToken": { "type": "string", "description": "رفرش توکن جدید؛ پس از هر refresh از مقدار جدید استفاده کنید" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "VehicleActivePlateNumbersResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "plateNumbers": { "type": "array", "items": { "type": "object", "properties": { "nationalId": { "type": "string" }, "plateNumber": { "type": "string" }, "revoked": { "type": "boolean" }, "revokedDateTime": { "type": [ "string", "null" ] }, "revokedDescription": { "type": [ "string", "null" ] }, "serialNumber": { "type": "string" } } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "VehicleMatchingVehicleOwnershipResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "vehicleType": { "type": "string" }, "vehicleTip": { "type": "string" }, "vehicleModel": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "VehiclePlateNumberHistoryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "plateHistory": { "type": "array", "items": { "type": "object", "properties": { "vehicleSystem": { "type": "string" }, "vehicleType": { "type": "string" }, "installDate": { "type": "string" }, "detachDate": { "type": "string" }, "vehicleModel": { "type": "string" } } } }, "plateStatus": { "type": "string" }, "tracePlate": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "VehicleTrafficTollInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "plateNumber": { "type": "string" }, "bills": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer" }, "fee": { "type": "integer" }, "date": { "type": "string" }, "paymentStatus": { "type": "string" }, "totalAmount": { "type": "integer", "description": "مبلغ کل طرح ترافیک خودرو" }, "uniqueId": { "type": "string", "description": "شناسه یکتا" } } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "VehicleInfoInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "additionalProperties": true, "properties": { "axelNo": { "type": "string" }, "wheelNo": { "type": "string" }, "capacity": { "type": "string" }, "cylinderNo": { "type": "string" }, "mainColor": { "type": "string" }, "secondColor": { "type": "string" }, "insuranceCompanyTitle": { "type": "string" }, "insuranceCompanyCode": { "type": "integer" }, "systemByInsuranceCompany": { "type": "string" }, "tipByInsuranceCompany": { "type": "string" }, "chassisNumber": { "type": "string" }, "engineNumber": { "type": "string" }, "vin": { "type": "string" }, "beginDate": { "type": "string" }, "endDate": { "type": "string" }, "discountLifeYearPercent": { "type": "string" }, "discountPersonYearPercent": { "type": "string" }, "discountFinancialYearPercent": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "BillingDrivingOffenseGetResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "4ce7fa61-1734-4ced-b343-554a9ec5bad9", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "Bills": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "id", "description": "مشخصه پرداخت" }, "type": { "type": "string", "example": "توقف دوبله در معابر", "description": "نوع تخلف" }, "description": { "type": "string", "example": "الصاقی", "description": "شرح نوع ثبت" }, "code": { "type": "string", "example": "2085", "description": "code (see legacy documentation)" }, "price": { "type": "integer", "example": 600000, "description": "مبلغ خلافی" }, "city": { "type": [ "string", "null" ], "description": "شهر" }, "location": { "type": "string", "example": "تهران ولیعصر بهرامی", "description": "آدرس محدوده ی تخلف" }, "date": { "type": "string", "example": "1396/11/24 - 11:11", "description": "تاریخ شمسی" }, "serial": { "type": "string", "example": "999999999_99", "description": "پلاک کد شده" }, "dataValue": { "type": "string", "example": "", "description": "dataValue (see legacy documentation)" }, "barcode": { "type": [ "string", "null" ], "description": "barcode (see legacy documentation)" }, "license": { "type": "string", "example": "plateNumber", "description": "شماره پلاک خودرو" }, "billId": { "type": "integer", "example": 12345678, "description": "شناسه قبض" }, "paymentId": { "type": "integer", "example": 123456789, "description": "شناسه پرداخت" }, "normalizedDate": { "type": "string", "example": "2018-02-13 11:11:00", "description": "تاریخ میلادی" }, "isPayable": { "type": "boolean", "example": true, "description": "قابلیت پرداخت را مشخص می‌کند. در صورتی که مقدار آن برابر با true باشد آنگاه جریمه قابل پرداخت است." }, "policemanCode": { "type": [ "string", "null" ], "description": "policemanCode (see legacy documentation)" }, "hasImage": { "type": "boolean", "example": false, "description": "وضعیت ثبت تصویر توسط دوربین زا نشان می‌دهد. در صورتی که مقدار آن true باشد، آنگاه جریمه توسط دوربین ثبت شده است." } }, "description": "آرایه‌ای از خلافی‌های خودرو که هرکدام از آن‌ها دارای مبلغ، شناسه‌قبض و شناسه پرداخت می‌باشد." }, "description": "آرایه‌ای از خلافی‌های خودرو که هرکدام از آن‌ها دارای مبلغ، شناسه‌قبض و شناسه پرداخت می‌باشد." }, "TotalAmount": { "type": "integer", "example": 600000, "description": "مبلغ کل جریمه" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "BillingNegativeScoreGetResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-BGFH-20000300000", "description": "Response code (کد پاسخ)" }, "trackId": { "type": "string", "example": "266dcf92-753c-47db-b0f9-cbbe57abffdd", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "LicenseNumber": { "type": "string", "example": "9607173353", "description": "شماره گواهینامه" }, "NegativeScore": { "type": "string", "example": "0", "description": "امتیاز منفی" }, "OffenseCount": { "type": [ "string", "null" ], "description": "تعداد خلافی" }, "Rule": { "type": "string", "example": "-", "description": "Rule (see legacy documentation)" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "BillingRidingOffenseGetResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "ridingOffenceTrackId", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "Amount": { "type": "integer", "example": 19395000, "description": "مبلغ خلافی" }, "BillID": { "type": "string", "example": "8289687000196", "description": "شناسه قبض" }, "ComplaintCode": { "type": "string", "example": "0", "description": "کد شکایت" }, "ComplaintStatus": { "type": "string", "example": "شکايت ندارد", "description": "وضعیت شکایت" }, "PaymentID": { "type": "string", "example": "0001996805400", "description": "شناسه پرداخت" }, "PlateNumber": { "type": "string", "example": "12345678", "description": "شماره پلاک موتور" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "BillingTrafficOffenseImageGetResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "46d3470b-eb14-4a17-8e77-6052031527d6", "description": "کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی سرویس" }, "result": { "type": "object", "properties": { "OffenseId": { "type": "string", "example": "47691362", "description": "شناسه تخلف" }, "PlateImageUrl": { "type": "string", "example": "https://najaservices.payment.ayantech.ir/pages/files.aspx?id=37CBC84868E842FD813C123564B9A7ED", "description": "آدرس عکس پلاک" }, "VehicleImageUrl": { "type": "string", "example": "https://najaservices.payment.ayantech.ir/pages/files.aspx?id=2E1EC5139E364E4090637FF3D7E3BAC6", "description": "آدرس عکس وسیله نقلیه" } }, "description": "آبجکتی از پاسخ سرویس شامل:" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityCardToIbanV2Response": { "type": "object", "properties": { "trackId": { "type": "string", "example": "cardToIban-029", "description": "کد پیگیری" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی — DONE یا FAILED" }, "result": { "type": "object", "description": "آبجکت پاسخ سرویس", "properties": { "IBAN": { "type": "string", "example": "IR910800005000115426432001", "description": "شماره شبا" }, "bankName": { "type": "string", "example": "قرض الحسنه رسالت", "description": "نام بانک" }, "deposit": { "type": "string", "example": "10.6423499.1", "description": "شماره حساب" }, "card": { "type": "string", "example": "6362141081734437", "description": "شماره کارت" }, "depositStatus": { "type": "string", "example": "02", "description": "وضعیت حساب:\n- 02: حساب فعال\n- 03: مسدود با قابلیت واریز\n- 04: مسدود بدون قابلیت واریز\n- 05: حساب راکد\n- 06: خطا در پاسخ‌دهی\n- 07: سایر موارد" }, "depositOwners": { "type": "string", "example": "شیما کیانی", "description": "صاحبان حساب" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "CardInformationResponse": { "type": "object", "properties": { "trackId": { "type": "string", "example": "get-cardInfo-0232", "description": "کد پیگیری" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی — DONE یا FAILED" }, "result": { "type": "object", "description": "آبجکت پاسخ سرویس", "properties": { "destCard": { "type": "string", "example": "xxxx-xxxx-xxxx-3899", "description": "شماره کارت به صورت xxxx-xxxx-xxxx-{چهار رقم آخر شماره کارت}" }, "name": { "type": "string", "example": "علی آقایی", "description": "نام صاحب کارت" }, "result": { "type": "string", "example": "0", "description": "نتیجه فراخوانی سرویس" }, "description": { "type": "string", "example": "موفق", "description": "توضیحات تکمیلی در مورد نتیجه" }, "doTime": { "type": "string", "example": "1396/06/15 12:32:04", "description": "زمان انجام تراکنش" }, "bankName": { "type": "string", "example": "بانک تجارت", "description": "نام بانک" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityNationalCardImageResponse": { "type": "object", "properties": { "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "trackingCode": { "type": "string", "description": "کد پیگیری ثبت احوال" }, "image": { "type": "string", "description": "تصویر base64" }, "message": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityShahkarVerifyResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-FYVR-20001000000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "e983dc66-2585-4ee3-90f0-ff2830a0eb83", "description": "کد پیگیری" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی — DONE یا FAILED" }, "result": { "type": "object", "description": "آبجکت پاسخ سرویس", "properties": { "isValid": { "type": "boolean", "example": true, "description": "نتیجه انطباق — true اگر موبایل متعلق به کد ملی باشد" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "OakIbanInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "IBAN": { "type": "string", "description": "شماره شبا" }, "bankName": { "type": "string", "description": "نام بانک" }, "deposit": { "type": "string", "description": "شماره حساب" }, "depositStatus": { "type": "string", "description": "وضعیت حساب (۰۱ بسته، ۰۲ فعال، ۰۳ مسدود با واریز، ...)" }, "depositDescription": { "type": "string", "description": "شرح حساب" }, "depositComment": { "type": "string", "description": "توضیحات حساب" }, "depositOwners": { "type": "array", "items": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } } } }, "bankCode": { "type": "string", "description": "کد بانک" }, "errorDescription": { "type": "string", "description": "شرح خطا (در صورت وجود)" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "OakCcStatementTransaction": { "type": "object", "properties": { "recordNumber": { "type": "string", "description": "شماره ردیف" }, "balance": { "type": "string", "description": "مانده" }, "balanceSign": { "type": "string", "description": "علامت مانده" }, "transactionAmountCredit": { "type": "string", "description": "مبلغ برای تراکنش‌های واریز" }, "transactionAmountDebit": { "type": "string", "description": "مبلغ برای تراکنش‌های برداشت" }, "transactionAmount": { "type": "string", "description": "مبلغ تراکنش" }, "transactionDescription": { "type": "string", "description": "شرح تراکنش" }, "branchNo": { "type": "string", "description": "کد شعبه" }, "date": { "type": "string", "description": "تاریخ به صورت YYMMDD" }, "time": { "type": "string", "description": "زمان به صورت HHMMSS" }, "fullDate": { "type": "string", "description": "تاریخ کامل" }, "requestDate": { "type": "string", "description": "تاریخ درخواست" }, "requestTime": { "type": "string", "description": "زمان درخواست" }, "originKey": { "type": "string", "description": "کد مرجع تراکنش" }, "rawOriginKey": { "type": "string", "description": "کد مرجع تراکنش (ویرایش‌نشده)" }, "additionalInformation": { "type": "string", "description": "اطلاعات اضافی تراکنش" }, "optionalInformation30": { "type": "string", "description": "شرح تراکنش ۳۰ کاراکتری" }, "optionalInformation15": { "type": "string", "description": "شرح تراکنش ۱۵ کاراکتری" }, "optionalInformation1": { "type": "string", "description": "معادل شرح تراکنش ۳۰ کاراکتری" }, "optionalInformation": { "type": "string", "description": "معادل شرح تراکنش ۱۵ کاراکتری" }, "transLineNO": { "type": "string", "description": "شماره ردیف تراکنش (مخصوص بانک ملت)" }, "transNo": { "type": "string", "description": "شماره تراکنش (مخصوص بانک ملت)" }, "refCode": { "type": "string", "description": "کد پیگیری" }, "customerDescription": { "type": "string", "description": "توضیحات مشتری (بانک صادرات)" }, "sourceAccount": { "type": "string", "description": "حساب مبدأ (بانک صادرات)" }, "statementStatus": { "type": "string", "description": "وضعیت تراکنش (بانک صادرات)" }, "transactionIdentity": { "type": "string", "description": "شناسه هویتی تراکنش (بانک صادرات)" }, "transactionClass": { "type": "string", "description": "طبقه بندی تراکنش (IBAN، CARD یا LEDGER)" }, "operationCode": { "type": "object", "description": "نوع عملیات تراکنش", "properties": { "code": { "type": "string", "description": "کد نوع عملیات تراکنش" }, "message": { "type": "string", "description": "شرح نوع عملیات تراکنش" } } }, "ibanInformationMap": { "type": "object", "nullable": true, "description": "جزئیات تراکنش شبا (وقتی transactionClass برابر IBAN است)", "properties": { "branchCode": { "type": "string" }, "bankCode": { "type": "string" }, "transactionClass": { "type": "string" }, "name": { "type": "string" }, "destinationIban": { "type": "string" }, "payId": { "type": "string", "description": "شناسه پرداخت" }, "chakavakInfo": { "type": "string", "description": "اطلاعات چکاوک" }, "transactionTypeCode": { "type": "string", "description": "کد نوع تراکنش (۶۱ پایا، ۶۲ ساتنا، ۶۳ خودپرداز، ۰۳ پین‌پد، ۱۴ پوز، ۰۷ تلفن‌بانک، ۵۹ اینترنت، ۰۵ موبایل، ۱۳ و ۴۳ کیوسک اطلاعاتی، ۰۲ دفترکل)" }, "referenceId": { "type": "string", "description": "کد رهگیری" }, "reasonDescription": { "type": "string" }, "chargeAmount": { "type": "string" } } }, "cardInformationMap": { "type": "object", "nullable": true, "description": "جزئیات تراکنش کارت (وقتی transactionClass برابر CARD است)", "properties": { "branchCode": { "type": "string" }, "bankCode": { "type": "string" }, "transactionClass": { "type": "string" }, "referenceNo": { "type": "string" }, "destinationPan": { "type": "string" }, "sourcePan": { "type": "string" }, "acquiringNo": { "type": "string" }, "transactionTypeCode": { "type": "string" }, "deviceSerial": { "type": "string" }, "trace": { "type": "string" }, "billId": { "type": "string" }, "name": { "type": "string" }, "destinationIban": { "type": "string" }, "payId": { "type": "string" } } }, "ledgerInformationMap": { "type": "object", "nullable": true, "description": "جزئیات تراکنش دفترکل (وقتی transactionClass برابر LEDGER است)", "properties": { "transactionClass": { "type": "string" }, "transactionTypeCode": { "type": "string" }, "payId": { "type": "string" }, "permissionId": { "type": "string", "description": "شماره مجوز" }, "reverseIndex": { "type": "string", "description": "شاخص تراکنش؛ صرفاً برای برگشت حساب‌های کوتاه‌مدت" }, "reverseOriginKey": { "type": "string", "description": "کلید تراکنش؛ صرفاً برای برگشت حساب‌های کوتاه‌مدت" }, "reasonDescription": { "type": "string" } } } } }, "OakCcStatementResponse": { "type": "object", "properties": { "trackId": { "type": "string", "description": "کد پیگیری؛ اگر ارسال شده باشد همان مقدار و در غیر این صورت یک رشته تصادفی" }, "status": { "type": "string", "description": "وضعیت فراخوانی سرویس (DONE یا FAILED)" }, "result": { "type": "object", "properties": { "iban": { "type": "string", "description": "شماره شبا" }, "branchCode": { "type": "string", "description": "کد شعبه" }, "branchName": { "type": "string", "description": "نام شعبه" }, "accountTypeCode": { "type": "string", "description": "کد نوع حساب" }, "subTypeCode": { "type": "string", "description": "کد زیر نوع حساب" }, "customerName": { "type": "string", "description": "نام مشتری" }, "customerFamilyName": { "type": "string", "description": "نام خانوادگی مشتری" }, "backupAccountNumber": { "type": "string", "description": "شماره حساب پشتیبان" }, "accountCurrentBalance": { "type": "string", "description": "مانده جاری" }, "accountCurrentBalanceSign": { "type": "string", "description": "علامت مانده جاری (C اعتبار، D بدهکار)" }, "accountAvailableBalance": { "type": "string", "description": "مانده قابل برداشت" }, "accountAvailableBalanceSign": { "type": "string", "description": "علامت مانده قابل برداشت (C اعتبار، D بدهکار)" }, "effectiveAccountBalance": { "type": "string", "description": "مانده موثر" }, "effectiveAccountBalanceSign": { "type": "string", "description": "علامت مانده موثر" }, "transactionChain": { "type": "string", "description": "مشخصه وجود تراکنش بیشتر (M بیش از ۱۰۰ تراکنش، L عدم وجود تراکنش بیشتر)" }, "openDate": { "type": "string", "description": "تاریخ افتتاح حساب به صورت YYMMDD" }, "lastRecordNumber": { "type": "string", "description": "شماره آخرین رکورد برای صفحه‌بندی بانک آینده" }, "availableSign": { "type": "string", "description": "علامت مانده در دسترس" }, "averageBalance": { "type": "string", "description": "میانگین مانده در بازه تراکنش" }, "averageBalanceSign": { "type": "string", "description": "علامت میانگین مانده" }, "currentBalance": { "type": "string", "description": "مانده جاری" }, "currentBalanceSign": { "type": "string", "description": "علامت مانده جاری" }, "transactions": { "type": "array", "description": "آرایه‌ای از تراکنش‌ها", "items": { "$ref": "#/components/schemas/OakCcStatementTransaction" } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "OakTransferToDepositRequest": { "type": "object", "required": [ "amount", "description", "destinationNumber" ], "properties": { "amount": { "type": "number", "description": "مبلغ انتقال وجه. اجباری برای کشاورزی، آینده، پارسیان و پاسارگاد.", "example": 1 }, "description": { "type": "string", "maxLength": 30, "description": "شرح انتقال وجه (حداکثر ۳۰ کاراکتر). اجباری برای کشاورزی، آینده، پارسیان و پاسارگاد. چند کاراکتر `-` پیوسته مجاز نیست." }, "destinationFirstname": { "type": "string", "minLength": 2, "maxLength": 30, "description": "نام صاحب حساب مقصد (حداقل ۲ و حداکثر ۳۰ کاراکتر) برای انتقال پایا و ساتنا. اجباری برای کشاورزی، آینده، پارسیان و پاسارگاد." }, "destinationLastname": { "type": "string", "minLength": 2, "maxLength": 30, "description": "نام خانوادگی صاحب حساب مقصد (حداقل ۲ و حداکثر ۳۰ کاراکتر) برای انتقال پایا و ساتنا. اجباری برای کشاورزی، آینده، پارسیان و پاسارگاد." }, "destinationNumber": { "type": "string", "description": "شماره حساب مقصد یا شماره شبا (۲۶ کاراکتر). اگر شماره حساب بانک کاراکتر اضافه مانند خط تیره دارد، همان فرمت را بفرستید. اجباری برای کشاورزی، آینده، پارسیان و پاسارگاد." }, "paymentNumber": { "type": "string", "description": "شناسه پرداخت؛ در صورتحساب شما و مشتری درج می‌شود (مثلاً شماره فاکتور). حداکثر ۳۰ رقم. اجباری برای بانک آینده." }, "reasonDescription": { "type": "string", "description": "بابت. اجباری برای بانک آینده. فهرست مقادیر در [شرح بابت‌ها](/oak-reason-description.html)." }, "deposit": { "type": "string", "description": "شماره حساب مبدأ. اگر توکن انتقال چند حساب مبدأ دارد از این فیلد استفاده کنید؛ وگرنه حساب مبدأ از توکن خوانده می‌شود. اجباری برای بانک کشاورزی." }, "sourceFirstName": { "type": "string", "description": "نام صاحب حساب مبدأ برای انتقال پایا و ساتنا. اجباری برای بانک کشاورزی." }, "sourceLastName": { "type": "string", "description": "نام خانوادگی صاحب حساب مبدأ برای انتقال پایا و ساتنا. اجباری برای بانک کشاورزی." }, "secondPassword": { "type": "string", "description": "رمز انتقال وجه. اجباری برای بانک پارسیان." }, "merchantName": { "type": "string", "description": "نام پذیرنده (بانک آینده). اختیاری." }, "merchantIban": { "type": "string", "description": "شماره شبا پذیرنده (بانک آینده). اختیاری." } } }, "OakTransferToDepositResponse": { "type": "object", "properties": { "trackId": { "type": "string", "description": "کد پیگیری که در فراخوانی سرویس فرستاده شده است" }, "status": { "type": "string", "description": "وضعیت فراخوانی سرویس (DONE یا FAILED)" }, "result": { "type": "object", "properties": { "amount": { "type": "number", "description": "مبلغ تراکنش" }, "description": { "type": "string", "description": "شرح تراکنش" }, "destinationFirstname": { "type": "string", "description": "نام صاحب حساب مقصد" }, "destinationLastname": { "type": "string", "description": "نام خانوادگی صاحب حساب مقصد" }, "destinationNumber": { "type": "string", "description": "شماره حساب مقصد" }, "inquiryDate": { "type": "string", "description": "تاریخ استعلام؛ در صورت مغایرت باید به بانک ارائه شود" }, "inquirySequence": { "type": "integer", "description": "شماره توالی استعلام" }, "inquiryTime": { "type": "string", "description": "زمان استعلام؛ در صورت مغایرت باید به بانک ارائه شود" }, "message": { "type": "string", "description": "در صورت بروز خطا، پیغام خطا در این فیلد قرار می‌گیرد" }, "paymentNumber": { "type": "string", "description": "شناسه پرداخت" }, "refCode": { "type": "string", "description": "کد پیگیری انتقال وجه" }, "sourceFirstname": { "type": "string", "description": "نام صاحب حساب مبدأ" }, "sourceLastname": { "type": "string", "description": "نام خانوادگی صاحب حساب مبدأ" }, "sourceNumber": { "type": "string", "description": "شماره حساب مبدأ" }, "reasonDescription": { "type": "string", "description": "بابت" }, "type": { "type": "string", "description": "نوع انتقال وجه (internal داخلی، paya پایا)" }, "transactionId": { "type": "string", "description": "کد تراکنش (فقط بانک پاسارگاد)" }, "endToEndId": { "type": "string", "description": "شناسه یکتای تأیید درخواست (فقط بانک پاسارگاد)" }, "payaSatnaInquiryTrackId": { "type": "string", "description": "کد پیگیری تراکنش پایا و ساتنا (فقط در واریزهای پایا و ساتنا)" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityDepositToIbanResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "deposit": { "type": "string", "description": "شماره حساب" }, "accountStatus": { "type": "string", "description": "وضعیت حساب:\n- 01: بسته\n- 02: فعال\n- 03: مسدود با واریز\n- 04: مسدود بدون واریز\n- 05: راکد\n- 06: خطا\n- 07: خطای شبا\n- 08: فاقد حساب" }, "bankName": { "type": "string" }, "iban": { "type": "string" }, "depositOwners": { "type": "string", "description": "صاحبان حساب" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityCardToDepositResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "destCard": { "type": "string", "description": "شماره کارت واردشده" }, "name": { "type": "string", "description": "نام صاحب حساب" }, "result": { "type": "string", "description": "کد نتیجه فراخوانی" }, "doTime": { "type": "string", "description": "زمان انجام" }, "deposit": { "type": "string", "description": "شماره حساب" }, "description": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityShahkarSmsSendResponse": { "type": "object", "properties": { "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "smsSent": { "type": "boolean", "description": "نتیجه ارسال پیامک تأیید" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityNidInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "birthdate": { "type": "string", "description": "تاریخ تولد به صورت yyyy/mm/dd" }, "birthDate": { "type": "string", "description": "تاریخ تولد (نام جایگزین فیلد)" }, "deathStatus": { "type": "string", "description": "وضعیت حیات — زنده یا مرده" }, "nationalCode": { "type": "string", "description": "کد ملی" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fatherName": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityNidVerificationCcResponse": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "FN-FYKZ-20000400000", "description": "کد پاسخ دریافتی" }, "trackId": { "type": "string", "example": "nid-inq-9602281200", "description": "کد پیگیری" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت فراخوانی — DONE یا FAILED" }, "result": { "type": "object", "description": "آبجکت پاسخ سرویس", "properties": { "nationalCode": { "type": "string", "example": "0067408595", "description": "کد ملی" }, "birthDate": { "type": "string", "example": "1365/11/25", "description": "تاریخ تولد به صورت yyyy/mm/dd" }, "status": { "type": "string", "example": "DONE", "description": "وضعیت پردازش" }, "fullName": { "type": "string", "example": "سعید غلامی فرد", "description": "نام کامل ارسالی" }, "fullNameSimilarity": { "type": "integer", "example": 100, "description": "میزان شباهت نام کامل (۰ تا ۱۰۰)" }, "firstName": { "type": "string", "example": "سعید", "description": "نام" }, "firstNameSimilarity": { "type": "integer", "example": 100, "description": "میزان شباهت نام (۰ تا ۱۰۰)" }, "lastName": { "type": "string", "example": "غلامی فرد", "description": "نام خانوادگی" }, "lastNameSimilarity": { "type": "integer", "example": 100, "description": "میزان شباهت نام خانوادگی (۰ تا ۱۰۰)" }, "fatherName": { "type": "string", "example": "علی", "description": "نام پدر" }, "fatherNameSimilarity": { "type": "integer", "example": 100, "description": "میزان شباهت نام پدر (۰ تا ۱۰۰)" }, "deathStatus": { "type": "string", "example": "زنده", "description": "وضعیت حیات — زنده یا مرده" }, "gender": { "type": "string", "example": "مرد", "description": "جنسیت" }, "genderSimilarity": { "type": "integer", "example": 100, "description": "میزان شباهت جنسیت (۰ یا ۱۰۰)" }, "description": { "type": "string", "description": "توضیحات تکمیلی" }, "trackingCode": { "type": "string", "example": "123456", "description": "کد پیگیری ثبت احوال" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityDepositInfoResponse": { "type": "object", "properties": { "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "bankName": { "type": "string" }, "fullName": { "type": "string", "description": "نام و نام خانوادگی صاحب حساب" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityFinnotextRequest": { "type": "object", "required": [ "from", "to", "message" ], "properties": { "from": { "type": "string", "description": "سرشماره اختصاص‌یافته به کلاینت", "example": "200000" }, "to": { "type": "array", "items": { "type": "string" }, "description": "لیست شماره‌های مقصد" }, "message": { "type": "array", "items": { "type": "string" }, "description": "لیست متن پیام‌ها (تناظر یک‌به‌یک با to)" }, "templateId": { "type": "string", "description": "شناسه قالب (اختیاری)" } } }, "FacilityFinnotextResponse": { "type": "object", "properties": { "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "numberOfRecords": { "type": "string", "description": "تعداد شماره‌هایی که پیامک برای آن‌ها ارسال شده" }, "numberOfParts": { "type": "string", "description": "مجموع تعداد پیامک‌های ارسال‌شده" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityFinnotextOtpRequest": { "type": "object", "required": [ "from", "to", "message" ], "properties": { "from": { "type": "string", "description": "سرشماره" }, "to": { "type": "string", "description": "شماره مقصد" }, "message": { "type": "string", "description": "متن پیام" }, "templateId": { "type": "string", "description": "شناسه قالب (اختیاری)" } } }, "FacilityFinnotextOtpResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "numberOfRecords": { "type": "integer" }, "numberOfParts": { "type": "integer" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityFinnotextInquiryResponse": { "type": "object", "properties": { "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "messages_status": { "type": "array", "items": { "type": "object", "properties": { "to_number": { "type": "string" }, "status": { "type": "integer", "description": "کد وضعیت پیامک" } } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityReceiveSmsResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "sourceAddress": { "type": "string", "description": "مبدا پیامک" }, "destinationAddress": { "type": "string", "description": "مقصد پیامک" }, "messageText": { "type": "string", "description": "متن پیامک" }, "receiveDateTime": { "type": "string", "format": "date-time", "description": "زمان دریافت (UTC)" } } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "FacilityWebhookFinnotextStatusPayload": { "type": "object", "required": [ "Status", "NumberOfParts", "InquiryId", "TrackId", "DateTime", "ToNumber", "FromNumber" ], "properties": { "Status": { "type": "string", "description": "وضعیت پیامک" }, "NumberOfParts": { "type": "string", "description": "تعداد بخش‌های پیامک" }, "InquiryId": { "type": "string", "description": "شناسه استعلام" }, "TrackId": { "type": "string", "description": "شناسه یکتا پیام" }, "DateTime": { "type": "string", "description": "تاریخ و زمان دریافت وضعیت" }, "ToNumber": { "type": "string", "description": "شماره گیرنده" }, "FromNumber": { "type": "string", "description": "شماره ارسال‌کننده" } } }, "FacilityWebhookReceiveSmsPayload": { "type": "object", "required": [ "Text", "DateTime", "ToNumber", "FromNumber" ], "properties": { "Text": { "type": "string", "description": "متن پیام" }, "DateTime": { "type": "string", "description": "تاریخ و زمان دریافت" }, "ToNumber": { "type": "string", "description": "شماره گیرنده" }, "FromNumber": { "type": "string", "description": "شماره ارسال‌کننده" } } }, "MessagingOtpInitiateRequest": { "type": "object", "required": [ "identifier", "method" ], "properties": { "identifier": { "type": "string", "description": "شماره موبایل یا شناسه کاربر", "example": "09123456789" }, "method": { "type": "string", "enum": [ "sms", "ussd", "bot" ], "description": "متد ارسال رمز" }, "purpose": { "type": "string", "description": "هدف از ارسال (جهت گزارش‌گیری و متن پیام)", "example": "login" }, "ttl": { "type": "integer", "description": "مدت زمان اعتبار رمز به ثانیه (پیش‌فرض ۱۲۰)", "example": 120 } } }, "MessagingOtpInitiateResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "traceId": { "type": "string", "description": "شناسه تراکنش OTP (الزامی برای مرحله Verify)" }, "status": { "type": "string", "description": "وضعیت فعلی تراکنش" }, "expiresIn": { "type": "integer", "description": "زمان اعتبار کد به ثانیه" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "MessagingOtpVerifyRequest": { "type": "object", "required": [ "traceId", "otp" ], "properties": { "traceId": { "type": "string", "description": "شناسه دریافتی از مرحله Initiate", "example": "atx_88234-9912" }, "otp": { "type": "string", "description": "کد وارد شده توسط کاربر", "example": "554321" } } }, "MessagingOtpVerifyResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "verified", "rejected" ], "description": "وضعیت تایید رمز" }, "verifiedAt": { "type": "string", "description": "زمان تایید نهایی (شمسی)" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "EcityPostalCodeInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "additionalProperties": true, "properties": { "postalCode": { "type": "string" }, "street": { "type": "string" }, "LocalityName": { "type": "string" }, "Province": { "type": "string" }, "BuildingName": { "type": [ "string", "null" ] }, "Description": { "type": [ "string", "null" ] }, "Floor": { "type": "string" }, "HouseNumber": { "type": "integer" }, "LocalityType": { "type": "string" }, "street2": { "type": "string" }, "SubLocality": { "type": "string" }, "TownShip": { "type": "string" }, "Zone": { "type": "string" }, "address": { "type": "string" }, "buildingId": { "type": "integer" }, "plateName": { "type": "string" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "EcityPostalCodeInquiryCoordinatesResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "postalCode": { "type": "string" }, "localityName": { "type": "string" }, "province": { "type": "string" }, "localityType": { "type": "string" }, "subLocality": { "type": "string" }, "townShip": { "type": "string" }, "address": { "type": "string" }, "street": { "type": "string" }, "street2": { "type": "string" }, "houseNumber": { "type": "string" }, "buildingId": { "type": "string" }, "floor": { "type": "string" }, "plateName": { "type": "string" }, "zone": { "type": "string" }, "latitude": { "type": "string", "description": "عرض جغرافیایی" }, "longitude": { "type": "string", "description": "طول جغرافیایی" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "EcityPostalInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "postType": { "type": "string", "description": "نوع ارسال" }, "sourcePostOffice": { "type": "string" }, "source": { "type": "string" }, "destination": { "type": "string" }, "senderName": { "type": "string" }, "receiverName": { "type": "string" }, "sourcePostalCode": { "type": "string" }, "destinationPostalCode": { "type": "string" }, "weight": { "type": "string" }, "totalAmount": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "event": { "type": "string" }, "id": { "type": "string" }, "postalNode": { "type": "string" }, "time": { "type": "string" } } } } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } }, "EcityFreewayTollInquiryResponse": { "type": "object", "properties": { "responseCode": { "type": "string" }, "trackId": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "object", "properties": { "bills": { "type": "array", "items": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "شناسه پرداخت" }, "date": { "type": "string", "description": "تاریخ میلادی" }, "price": { "type": "integer", "description": "مبلغ عوارض" }, "gateway": { "type": "string", "description": "کد عوارضی آزادراه" }, "freeway": { "type": "string", "description": "کد آزادراه" } } } }, "totalAmount": { "type": "integer", "description": "مبلغ کل عوارض" } } }, "error": { "$ref": "#/components/schemas/ErrorDetail" } } } } } }