# استعلام هویت اتباع خارجی

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

:::

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

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

نام	نوع	الزامی	توضیحات
birthDate	رشته	بله	تاریخ تولد
fida	رشته	بله	شماره فراگیر اتباع

نکته

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

# آدرس سرویس

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

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

PHP
Python
Java
Node.js
Go
cURL
C#

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

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","fida":"123456789012"}',
]);

$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.ancestorName	رشته	خیر	—
data.birthDate	رشته	خیر	تاریخ تولد
data.birthPlaceCity	رشته	خیر	—
data.birthPlaceCountry	رشته	خیر	—
data.fatherName	رشته	خیر	نام پدر
data.firstName	رشته	خیر	نام
data.gender	رشته	خیر	—
data.identificationDocuments	آرایه<شیء>	خیر	—
data.lastName	رشته	خیر	نام خانوادگی
data.nationality	رشته	خیر	—

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

{
  "data": {
    "ancestorName": "ancestorName_value",
    "birthDate": "1370/01/01",
    "birthPlaceCity": "birthPlaceCity_value",
    "birthPlaceCountry": "birthPlaceCountry_value",
    "fatherName": "محمد",
    "firstName": "علی",
    "gender": "gender_value",
    "identificationDocuments": [
      {}
    ],
    "lastName": "رضایی",
    "nationality": "nationality_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": []
  }
}

قبلی

تبدیل شماره حساب به شبا

بعدی

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