# استعلام تشابه اطلاعات ثبت احوال

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

:::

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

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

نام	نوع	الزامی	توضیحات
birthDate	رشته	بله	تاریخ تولد
fatherName	رشته	خیر	نام پدر
firstName	رشته	خیر	نام
fullName	رشته	خیر	نام و نام خانوادگی
lastName	رشته	خیر	نام خانوادگی
nationalCode	رشته	بله	کد ملی

نکته

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

# آدرس سرویس

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

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

PHP
Python
Java
Node.js
Go
cURL
C#

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

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","fatherName":"محمد","firstName":"علی","fullName":"علی رضایی","lastName":"رضایی","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.fatherNameSimilarityPercentage	عدد	خیر	—
data.firstNameSimilarityPercentage	عدد	خیر	—
data.fullNameSimilarityPercentage	عدد	خیر	—
data.lastNameSimilarityPercentage	عدد	خیر	—

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

{
  "data": {
    "fatherNameSimilarityPercentage": 1,
    "firstNameSimilarityPercentage": 1,
    "fullNameSimilarityPercentage": 1,
    "lastNameSimilarityPercentage": 1
  },
  "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": []
  }
}

قبلی

استعلام رنگ چک

بعدی

استعلام اطلاعات شرکت