استعلام کد ملی

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

---

شرح

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

---

Headers

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

  Authorization : Bearer {Token}
  clientAddress : client IP

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

توضیحات

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

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

Parameters

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

• birth_date (نوع داده عددی):(اجباری) تاریخ تولد به صورت 13750107 به ترتیب از چپ سال ، ماه ، روز

• national_id (نوع داده عددی):(اجباری) کد ملی

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

curl --location 'https:/carbon/v4.0/kyc_service/inquiry/national_id' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'clientAddress: xxx' \
--header 'Authorization: ••••••' \
--data '{
    "request_number": "202511122024",
    "birth_date": "....",
    "national_id": "...."

}'

جواب موفق:

{
    "status": "0",
    "message": "تراکنش با موفقیت انجام شد",
    "timestamp": "2025-12-10 10:06:32.932",
    "tracking_number": "859667076",
    "request_number": "202511122024",
    "result": {
        "national_id": "...",
        "first_name": "",
        "last_name": " ",
        "father_name": "",
        "birth_date": "13750107",
        "alive": "true",
        "gender": "male",
        "certificate_number": "0",
        "seri": "د15",
        "serial": "...",
        "death_date": "0"
    },
    "transaction_details": {
        "available_wallet_balance": "101958000",
        "provider_name": "Pertikan",
        "service_price": "....",
        "curency": "IRR",
        "remaining_number_of_calls": "998",
        "remaining_number_of_calls_day": "998"
    },
    "errors": {}
}

جواب ناموفق:

{
    "status": "1",
    "message": "تراکنش ناموفق",
    "timestamp": "2025-12-10 12:41:00.476",
    "tracking_number": "20251210124100474",
    "req_id": "202511122024",
    "result": {},
    "transaction_detials": {},
    "errors": {
        "error_code": "6001",
        "error_description": "invalid input parameter: national_id is not found ",
        "reference_name": "national_id",
        "original_value": ""
    }
}

• status: عدد 0 به معنی موفق و عدد 1 به معنی ناموفق می باشد
• message: پاسخ از طرف سرویس سامانه ابری کربن
• timestamp : زمان و تاریخ درخواست
• request_number: شماره پیگیری ارسال شده در زمان فراخوانی
• tracking_number: شماره پیگیری ایجاد شده توسط سامانه ابری کربن جهت بررسی های بعدی
• result: آبجکتی از پاسخ سرویس شامل:
• national_id : کد ملی
• first_name : نام
• last_name: نام خانوادگی
• father_name: نام پدر
• birth_date: تاریخ تولد
• alive: در قید حیات بودن
• gender: جنسیت
• certificate_number: شماره گواهی
• seri: شماره سری
• serial: شماره سریال
• death_date: تاریخ وفات

در صورت بروز خطا در درخواست :

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

---