مستندات سرویس API تبدیل تصویر به متن کارت ملی
نسخه 1.0.0 - 03/12/2024
National Card OCR API Documents
فهرست مطالب
۱. مقدمه
در سرویس تبدیل تصویر به متن کارت ملی یوآیدی، با ارسال عکس کارت ملی آپلود شده کاربر، می‌توانید اطلاعات کارت ملی یوزر را دریافت نمائید.
۲. فراخوانی سرویس ocr/national-card
برای استفاده از سرویس API تبدیل تصویر به متن کارت ملی یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با عکس کارت ملی کاربر، اطلاعات کارت ملی کاربر را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/ocr/national-card
Content-Type: application/json;charset=UTF-8
{
"businessId" : "<business_id>",
"businessToken" : "<business_token>",
"imageDownloadLink" : "<IMAGE_DOWNLOAD_LINK>",
"documentType" : "<DOCUMENT_TYPE_NATIONAL_CARD_FRONT>-or-<DOCUMENT_TYPE_NATIONAL_CARD_BACK>",
}
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| imageDownloadLink | string | Required | لینک عکس کدملی کاربر |
| documentType | string – ENUM | Required | نوع استعلام |
* عکس کارت ملی کاربر توسط پذیرنده دریافت و لینک آن جهت تبدیل به متن به یوآیدی ارسال می‌شود.
* فرمت عکس مورد پذیرش در این بخش png و jpg و jpeg و حداکثر 2 مگابایت می‌باشد.
۳.۲. نمونه پاسخ
{
"responseContext": {
"status": {
}
},
"status": <OCR_STATUS_COMPLETED_WITH_FULL_DATA>,
"error": <ERROR_CODE_NO_ERROR>,
"fields": [{
"name": "FIELD_NAME_FAMILY_NAME",
"fieldData": <LAST_NAME>
}, {
"name": "FIELD_NAME_NAME",
"fieldData": <FIRST_NAME>
}, {
"name": "FIELD_NAME_BIRTH_DATE",
"fieldData": <BIRTH_DATE>
}, {
"name": "FILED_NAME_FATHER_NAME",
"fieldData": <FATHER_NAME>
}, {
"name": "FIELD_NAME_NATIONAL_CARD_EXPIRATION_DATE",
"fieldData": <EXPIRATION_DATE>
}, {
"name": "FIELD_NAME_NATIONAL_CODE",
"fieldData": <NATIONAL_CODE>
}]
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
| FIELD_NAME_FAMILY_NAME | string | نام خانوادگی |
| FIELD_NAME_NAME | string | نام |
| FIELD_NAME_BIRTH_DATE | string | تاریخ تولد |
| FILED_NAME_FATHER_NAME | string | نام پدر |
| FIELD_NAME_NATIONAL_CARD_EXPIRATION_DATE | string | تاریخ انقضای کارت ملی |
| FIELD_NAME_NATIONAL_CODE | string | کد ملی |
| FIELD_NAME_NATIONAL_CARD_SERIAL_NUMBER | string | سریال پشت کارت ملی |
| FIELD_NAME_UNDEFINED | string | خطا در خواندن فیلد (خطای ناشناخته) |
۴.۲. پارامترهای OCR_STATUS
| Field | Type | Description |
| OCR_STATUS_COMPLETED_WITH_FULL_DATA | string | اطلاعات کامل بازگشت داده شده |
| OCR_STATUS_COMPLETED_WITH_PARTIAL_DATA | string | بخشی از اطلاعات بازگشت داده شده |
| OCR_STATUS_UNDEFINED | string | خطای نامشخص |
| OCR_STATUS_FAILED | string | عدم تبدیل به متن |
۴.۲.پارامترهای OCR_STATUS_FAILED (error)
| Field | Type | Description |
| ERROR_CODE_NO_ERROR | string | موفق |
| ERROR_CODE_FAILURE_TO_DOWNLOAD_IMAGE | string | دانلود عکس با مشکل مواجه شده |
| ERROR_CODE_FAILURE_TO_READ_IMAGE | string | پردازش عکس با مشکل مواجه شده |
| ERROR_CODE_IMAGE_IS_NOT_NATIONAL_CARD_FRONT | string | عکس مربوط به جلوی کارت ملی نیست |
| ERROR_CODE_IMAGE_IS_NOT_NATIONAL_CARD_BACK | string | عکس مربوط به پشت کارت ملی نیست |
| ERROR_CODE_BAD_IMAGE_QUALITY | string | کیفیت عکس پایین است |
| ERROR_CODE_FAILURE_TO_READ_REQUIRED_FIELDS | string | خطا در پردازش اطلاعات |
| ERROR_CODE_UNDEFINED | string | خطای ناشناخته |
