# استعلام ثبت احوال با تصویر

این سرویس برای استعلام ثبت احوال با تصویر استفاده می‌شود. درخواست را با توکن معتبر ارسال کنید و نتیجه را در فیلد data پاسخ بخوانید.

:::

# ارسال اطلاعات

برای استفاده از این سرویس، پارامترهای زیر را با متد POST به آدرس مشخص‌شده ارسال کنید.

نام	نوع	الزامی	توضیحات
birthDate	رشته	بله	تاریخ تولد
nationalCode	رشته	بله	کد ملی

نکته

تمامی داده‌های برگشتی از API به صورت JSON هستند.

# آدرس سرویس

https://zarin-hub.com/api/v5/KYC/GetCivilRegistryDataIncludePersonPhoto

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

PHP
Python
Java
Node.js
Go
cURL
C#

<?php
$curl = curl_init('https://zarin-hub.com/api/v5/KYC/GetCivilRegistryDataIncludePersonPhoto');

curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer {ACCESS_TOKEN}',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{"birthDate":"1370/01/01","nationalCode":"0013546299"}',
]);

$response = curl_exec($curl);
curl_close($curl);

# پاسخ سرویس

پارامترهای پاسخ این سرویس:

نام	نوع	الزامی	توضیحات
data	شیء	خیر	داده پاسخ
meta	شیء	خیر	اطلاعات پردازش
meta.code	عدد صحیح	خیر	کد وضعیت
meta.errorMessage	رشته	خیر	پیام خطا
meta.errorType	رشته	خیر	enum name, null on success
meta.errors	آرایه<شیء>	خیر	خطاها
meta.isSuccess	بولی	خیر	موفقیت درخواست
meta.message	رشته	خیر	پیام
meta.status	رشته	خیر	وضعیت
meta.trackId	رشته	خیر	شناسه پیگیری
data.birthDate	رشته	خیر	تاریخ تولد
data.fatherName	رشته	خیر	نام پدر
data.firstName	رشته	خیر	نام
data.gender	رشته	خیر	—
data.identificationSeri	رشته	خیر	—
data.identificationSerial	رشته	خیر	—
data.identityId	رشته	خیر	—
data.image	رشته	خیر	تصویر کارت ملی
data.isAlive	بولی	خیر	—
data.lastName	رشته	خیر	نام خانوادگی
data.nationalCode	رشته	خیر	کد ملی
data.placeOfBirth	رشته	خیر	—
data.placeOfBirthCode	رشته	خیر	—

نمونه پاسخ موفق:

{
  "data": {
    "birthDate": "1370/01/01",
    "fatherName": "محمد",
    "firstName": "علی",
    "gender": "gender_value",
    "identificationSeri": "identificationSeri_value",
    "identificationSerial": "identificationSerial_value",
    "identityId": "identityId_value",
    "image": "national-card.jpg",
    "isAlive": true,
    "lastName": "رضایی",
    "nationalCode": "0013546299",
    "placeOfBirth": "placeOfBirth_value",
    "placeOfBirthCode": "placeOfBirthCode_value"
  },
  "meta": {
    "code": 0,
    "errorMessage": null,
    "errorType": null,
    "errors": [],
    "isSuccess": true,
    "message": "عملیات با موفقیت انجام شد",
    "status": "success",
    "trackId": "9b126e9a-184c-4cb0-a47e-62b9a3b7176f"
  }
}

نمونه پاسخ ناموفق:

{
  "data": {},
  "meta": {
    "trackId": null,
    "status": "error",
    "isSuccess": false,
    "code": -1,
    "message": "درخواست ناموفق بود",
    "errorMessage": "پارامترهای درخواست نامعتبر هستند",
    "errorType": "validation_error",
    "errors": []
  }
}

قبلی

استعلام اطلاعات ثبت احوال

بعدی

دریافت تصویر کارت ملی