پرش به محتویات

استعلام اعتبار سنجی

آدرس سرویس: POST https:/carbon/v4.0/kyc_service/inquiry/etebar_inquiry


شرح

این سرویس جهت دریافت کد otp و توکن برای سرویس اعتبار سنجی مورد استفاده قرار می گیرد.

سرویس اعتبار سنجی دو مرحله می باشد اگر که مرحله اول را طی نکردید لطفا به مرحله get_otp مراجعه کنید


Headers

مقادیر زیر باید در هدر قرار بگیرد

  Authorization : Bearer {Token}
  clientAddress : client IP

توجه : برای دریافت توکن مربوطه به بخش سرویس توکن مراجعه فرمایید

توضیحات

  • Authorization : در این قسمت توکن دریافت شده از سرویس توکن را وارد نمایید
  • clientAddress : آی پی مشتری نهایی که سرویس را دریافت کرده است .

Parameters

  • request_number (نوع داده عددی) : (اجباری) این شناسه جهت پیگیری های بعدی مورد استفاده قرار می گیرد و پیشنهاد میگردد یه شناسه یکتا به ازای هر درخواست توسط سامانه مشتری تولید و به این سرویس ارسال گردد. سامانه ابری کربن هیچ کنترلی بر روی عدم تکراری بودن این مقدار انجام نمی دهد.

  • otp_code (نوع داده عددی) : (اجباری)کد ارسال شده به گوشی توسط پیامک

  • token (نوع داده رشته) : (اجباری) توکن داده شده توسط سرویس قبلی

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

curl --location --request POST 'https:/carbon/v4.0/kyc_service/inquiry/etebar_inquiry'\
--header 'Authorization: Bearer ....' \
--header 'Content-Type: application/json' \
{
    "request_number":"....",
    "otp_code":"....",
    "token":"...."
}

جواب موفق:

{
    "status": "0",
    "message": "تراکنش با موفقیت انجام شد",
    "timestamp": "2026-04-26 15:46:22.76",
    "tracking_number": "875159444",
    "request_number": "20262133",
    "result": {
        "reportTypes": [
            "Base",
            "Score",
            "Judiciary",
            "Tax"
        ],
        "score": {
            "personInformation": {
                "name": "....",
                "nationalCode": "....",
                "address": "....",
                "contacts": [],
                "hasBlockedContract": "....",
                "dateOfBirth": "....",
                "family": "....",
                "fatherName": "....",
                "maritalStatus": "....",
                "placeOfBirth": "....",
                "sex": "....",
                "companyType": "....",
                "registrationNumber": "....",
                "percent": 0,
                "gradeDescription": "...."
            },
            "scoreCodes": [],
            "score": 551,
            "errors": [
                {
                    "code": "....",
                    "type": "....",
                    "description": "...."
                },
                {
                    "code": "....",
                    "type": "....",
                    "description": "...."
                }
            ],
            "description": "....",
            "risk": "C2",
            "inquiryCreatedDate": "....",
            "perviouScoreDate": "....",
            "perviouScore": "....",
            "percent": 0,
            "scoreType": {
                "code": 3,
                "description": ".... "
            },
            "minLimit": 55.2,
            "maxLimit": 66.2
        },
        "report": {
            "personInformation": {
                "name": null,
                "nationalCode": "....",
                "address": null,
                "contacts": [],
                "hasBlockedContract": false,
                "dateOfBirth": "",
                "family": null,
                "fatherName": null,
                "maritalStatus": null,
                "placeOfBirth": null,
                "sex": null,
                "companyType": null,
                "registrationNumber": null,
                "percent": 0,
                "gradeDescription": ""
            },
            "inquiryStats": [
                {
                    "organizationType": "....",
                    "organizationTypeCode": "....",
                    "lastMonthInquiryCount": 0,
                    "lastYearInquiryCount": 0,
                    "personNegativeStatusCount": 0,
                    "contractNegativeStatusCount": 0,
                    "roleType": 0
                },
                {
                    "organizationType": "....",
                    "organizationTypeCode": "....",
                    "lastMonthInquiryCount": 0,
                    "lastYearInquiryCount": 0,
                    "personNegativeStatusCount": 0,
                    "contractNegativeStatusCount": 0,
                    "roleType": 0
                },
                {
                    "organizationType": "....",
                    "organizationTypeCode": "....",
                    "lastMonthInquiryCount": 0,
                    "lastYearInquiryCount": 0,
                    "personNegativeStatusCount": 0,
                    "contractNegativeStatusCount": 0,
                    "roleType": 0
                },
                {
                    "organizationType": "....",
                    "organizationTypeCode": "....",
                    "lastMonthInquiryCount": 0,
                    "lastYearInquiryCount": 0,
                    "personNegativeStatusCount": 0,
                    "contractNegativeStatusCount": 0,
                    "roleType": 0
                },
                {
                    "organizationType": "....",
                    "organizationTypeCode": "....",
                    "lastMonthInquiryCount": 0,
                    "lastYearInquiryCount": 0,
                    "personNegativeStatusCount": 0,
                    "contractNegativeStatusCount": 0,
                    "roleType": 0
                },
                {
                    "organizationType": "....",
                    "organizationTypeCode": "....",
                    "lastMonthInquiryCount": 0,
                    "lastYearInquiryCount": 0,
                    "personNegativeStatusCount": 0,
                    "contractNegativeStatusCount": 0,
                    "roleType": 0
                },
                {
                    "organizationType": "....",
                    "organizationTypeCode": "....",
                    "lastMonthInquiryCount": 0,
                    "lastYearInquiryCount": 0,
                    "personNegativeStatusCount": 0,
                    "contractNegativeStatusCount": 0,
                    "roleType": 0
                },
                {
                    "organizationType": "....",
                    "organizationTypeCode": "30",
                    "lastMonthInquiryCount": 0,
                    "lastYearInquiryCount": 0,
                    "personNegativeStatusCount": 0,
                    "contractNegativeStatusCount": 0,
                    "roleType": 0
                },
                {
                    "organizationType": "....",
                    "organizationTypeCode": "....",
                    "lastMonthInquiryCount": 0,
                    "lastYearInquiryCount": 0,
                    "personNegativeStatusCount": 0,
                    "contractNegativeStatusCount": 0,
                    "roleType": 0
                }
            ],
            "personRoles": [],
            "summaryInformationRelatedToContracts": [],
            "summaryInformationRelatedToContractsSum": [],
            "directContracts": [],
            "indirectContracts": [],
            "contractNegativeStatus": [],
            "personNegativeStatus": [],
            "inquiryCreatedDate": "1405/02/06 15:43:46",
            "reportUniqueId": "6000 0020 5000 0890 7109",
            "inquiryHistories": [],
            "summaryInformationRelatedToContractsWithRoleType": [],
            "summaryInformationRelatedToContractsSumWithRoleType": []
        },
        "pichak": {
            "status": "....",
            "personChequesData": null
        },
        "bouncedCheque": {
            "bouncedCheques": null,
            "status": ....
        },
        "judiciary": {
            "status": 200,
            "judiciaryData": {
                "nationalCode": "....",
                "accountingDate": "....",
                "bunkruptcyCount": 0,
                "insolvencyCount": 0,
                "insolvencySumPenalty": 0,
                "sumExecuteSumPenaltyAmount": 0,
                "sumNotExecuteSumPenaltyAmount": 0,
                "sumExecuteCount": 0,
                "sumNotExecuteCount": 0,
                "errorCode": "",
                "errorDescription": ""
            }
        },
        "tax": {
            "status": "....",
            "taxResult": [
                {
                    "nationalcode": null,
                    "accountingDate": null,
                    "year": "....",
                    "daramadEbrazi": null,
                    "maliatEbrazi": null,
                    "maliatTashkhisi": null,
                    "maliatGhati": null,
                    "maliatVosoli": null,
                    "jarayem": null,
                    "bedehiMaliatAmalkard": null,
                    "bedehiJarimehAmalkard": null,
                    "maliateHoghoghiPardakhtiKarmand": null,
                    "maliateHoghoghiPardakhtiKarfarma": null,
                    "isMaliatghatiTypeAndDate": null,
                    "isMaliatPardakhtiTypeAndDate": null,
                    "darMoed": null,
                    "etelateVosoloEjra": false
                },
                {
                    "nationalcode": null,
                    "accountingDate": null,
                    "year": "....",
                    "daramadEbrazi": null,
                    "maliatEbrazi": null,
                    "maliatTashkhisi": null,
                    "maliatGhati": null,
                    "maliatVosoli": null,
                    "jarayem": null,
                    "bedehiMaliatAmalkard": null,
                    "bedehiJarimehAmalkard": null,
                    "maliateHoghoghiPardakhtiKarmand": null,
                    "maliateHoghoghiPardakhtiKarfarma": null,
                    "isMaliatghatiTypeAndDate": null,
                    "isMaliatPardakhtiTypeAndDate": null,
                    "darMoed": null,
                    "etelateVosoloEjra": false
                },
                {
                    "nationalcode": null,
                    "accountingDate": null,
                    "year": "....",
                    "daramadEbrazi": null,
                    "maliatEbrazi": null,
                    "maliatTashkhisi": null,
                    "maliatGhati": null,
                    "maliatVosoli": null,
                    "jarayem": null,
                    "bedehiMaliatAmalkard": null,
                    "bedehiJarimehAmalkard": null,
                    "maliateHoghoghiPardakhtiKarmand": null,
                    "maliateHoghoghiPardakhtiKarfarma": null,
                    "isMaliatghatiTypeAndDate": null,
                    "isMaliatPardakhtiTypeAndDate": null,
                    "darMoed": null,
                    "etelateVosoloEjra": false
                },
                {
                    "nationalcode": null,
                    "accountingDate": null,
                    "year": "....",
                    "daramadEbrazi": null,
                    "maliatEbrazi": null,
                    "maliatTashkhisi": null,
                    "maliatGhati": null,
                    "maliatVosoli": null,
                    "jarayem": null,
                    "bedehiMaliatAmalkard": null,
                    "bedehiJarimehAmalkard": null,
                    "maliateHoghoghiPardakhtiKarmand": null,
                    "maliateHoghoghiPardakhtiKarfarma": null,
                    "isMaliatghatiTypeAndDate": null,
                    "isMaliatPardakhtiTypeAndDate": null,
                    "darMoed": null,
                    "etelateVosoloEjra": false
                },
                {
                    "nationalcode": null,
                    "accountingDate": null,
                    "year": "....",
                    "daramadEbrazi": null,
                    "maliatEbrazi": null,
                    "maliatTashkhisi": null,
                    "maliatGhati": null,
                    "maliatVosoli": null,
                    "jarayem": null,
                    "bedehiMaliatAmalkard": null,
                    "bedehiJarimehAmalkard": null,
                    "maliateHoghoghiPardakhtiKarmand": null,
                    "maliateHoghoghiPardakhtiKarfarma": null,
                    "isMaliatghatiTypeAndDate": null,
                    "isMaliatPardakhtiTypeAndDate": null,
                    "darMoed": null,
                    "etelateVosoloEjra": false
                }
            ]
        }
    },
    "transaction_details": {
        "available_wallet_balance": "98820000",
        "provider_name": "Pertikan",
        "service_price": "0",
        "curency": "IRR",
        "remaining_number_of_calls": "988",
        "remaining_number_of_calls_day": "988"
    },
    "errors": {}
}

جواب ناموفق:

{
    "status": "1",
    "message": "تراکنش ناموفق",
    "timestamp": "2026-01-12 15:58:42.364",
    "tracking_number": "875153592",
    "request_number": "2025123452026",
    "result": {},
    "transaction_details": {},
    "errors": {
        "error_code": "5002",
        "error_description": "Transaction failed : Provider  Error",
        "reference_name": "47_",
        "original_value": ""
    }
}
  • status: عدد 0 به معنی موفق و عدد 1 به معنی ناموفق می باشد
  • message: پاسخ از طرف سرویس سامانه ابری کربن
  • timestamp: زمان و تاریخ درخواست
  • request_number: شماره پیگیری ارسال شده در زمان فراخوانی
  • tracking_number: شماره پیگیری ایجاد شده توسط سامانه ابری کربن جهت بررسی های بعدی
  • result: آبجکتی از پاسخ سرویس شامل:
  • در صورت بروز خطا در درخواست :

  • errors: جزییات خطا
  • error_code: کد مربوط به خطایی که پیش آمده است
  • error_description: متن خطا
  • reference_name: اطلاعات تکمیلی خطا
  • original_value: اطلاعات تکمیلی خطا