این سرویس برای خواندن پشت کارت ملی استفاده میشود. درخواست را با توکن معتبر ارسال کنید و نتیجه را در فیلد data پاسخ بخوانید.
:::
برای استفاده از این سرویس، پارامترهای زیر را با متد POST به آدرس مشخصشده ارسال کنید.
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| image | فایل | بله | تصویر کارت ملی |
تمامی دادههای برگشتی از API به صورت JSON هستند.
https://zarin-hub.com/api/v5/KYC/NationalCardBackSideOcr
نمونه درخواست:
<?php
$curl = curl_init('https://zarin-hub.com/api/v5/KYC/NationalCardBackSideOcr');
curl_setopt_array($curl, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer {ACCESS_TOKEN}',
],
CURLOPT_POSTFIELDS => [
'image' => new CURLFile('/path/to/national-card.jpg'),
],
]);
$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.expirationDate | رشته | خیر | — |
| data.fatherName | رشته | خیر | نام پدر |
| data.firstName | رشته | خیر | نام |
| data.lastName | رشته | خیر | نام خانوادگی |
| data.nationalCode | رشته | خیر | کد ملی |
| data.result | بولی | خیر | — |
| data.serialCard | رشته | خیر | — |
نمونه پاسخ موفق:
{
"data": {
"birthDate": "1370/01/01",
"expirationDate": "expirationDate_value",
"fatherName": "محمد",
"firstName": "علی",
"lastName": "رضایی",
"nationalCode": "0013546299",
"result": true,
"serialCard": "serialCard_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": []
}
}