FPT.AI Reader - Nhận diện hộ chiếu

Quy định

Ảnh đầu vào phải đủ 4 góc rõ ràng hoặc đủ các bộ phận chính của một hộ chiếu như ảnh, tiêu đề, dòng mã để máy đọc(machine readable zone - MRZ)
Các trường thông tin phải rõ ràng, so sánh khi mắt người có thể đọc được dễ dàng, không tẩy xoá, hay bị nhoè nước
Ảnh đầu vào không vượt quá 5 MB và độ phân giải tối thiểu khoảng 800x600 để đảm bảo tỉ lệ đọc chính xác
Tỉ lệ diện tích hộ chiếu phải chiếm tối thiểu ¼ tổng diện tích ảnh trở lên

Ảnh tiêu chuẩn

alt-text

Ảnh kém chất lượng

Ảnh chất lượng thấp và thiếu góc

alt-text

Ảnh chất lượng thấp và thiếu thông tin

alt-text

Request

Request Url

POST https://api.fpt.ai/vision/passport/vnm

Request Headers

Tham số	Yêu cầu	Mặc định	Mô tả
api_key	Có		api_key của bạn ( lấy từ console.fpt.ai )

Request Body

FormData chứa ảnh cần nhận dạng

Tham số	Yêu cầu	Mô tả
image	Có

Sample Request

curl -X POST https://api.fpt.ai/vision/passport/vnm -H "api-key: xxxxxx" -F "image=@path/to/image"

Response

JSON

{
    "errorCode" : x,
    "errorMessage" : "xxxx",
    "data" : [xxxx]
}

Hệ thống có khả năng trích xuất các thông tin có trên hộ chiếu của Việt Nam. Sau khi gửi request thành công, hệ thống sẽ trả về một file json bao gồm thông tin dạng text trên hộ chiếu sử dụng format như ở bên.

errorCode: giá trị bằng 0 nếu request thành công không có lỗi xảy ra
errorMessage: giá trị bằng string rỗng nếu request thành công không có lỗi xảy ra
data: bao gồm các trường thông tin có trên ảnh hộ chiếu nếu request thành công không có lỗi xảy ra hoặc trả về list rỗng [] nếu xảy ra lỗi (những trường thông tin không có sẽ có giá trị "N/A"). Ngoài ra, đi kèm với các trường thông tin là chỉ số probability cho biết mức độ đáng tin cậy của kết quả trả về.

(Chi tiết các lỗi có thể xảy ra bao gồm cả errorCode và errorMessage xem ở phần Errors))

Data

{
  "errorCode" : 0,
  "errorMessage" : "",
  "data": [
    {
      "passport_number": "xxxx",
      "passport_number_prob": "xxxx",
      "name": "xxxx",
      "name_prob": "xxxx",
      "pob": "xxxx",
      "pob_prob": "xxxx",
      "sex": "xxxx",
      "sex_prob": "xxxx",
      "id_number": "xxxx",
      "id_number_prob": "xxxx",
      "doi": "xxxx",
      "doi_prob": "xxxx",
      "doe": "xxxx",
      "doe_prob": "xxxx"
    }
  ]
}

Kết quả trả về bao gồm 8 trường thông tin:

Trường	Mô tả
id	Số Hộ Chiếu
name	Tên
dob	Ngày sinh
pob	Nơi sinh
sex	Giới tính
id_number	Sô ID
doi	Ngày cấp
doe	Ngày hết hạn

Errors

Phần này bao gồm các lỗi thường gặp và có thể xử lý bởi hệ thống, messages được trả về rõ ràng và cụ thể mục đích nhằm chỉ thị cho users sử dụng API một cách chính xác nhất.

Hệ thống sử dụng các error code như sau:

Error Code	Ý nghĩa
0	No error -- Không có lỗi
1	Invalid Parameters or Values! -- Sai thông số trong request (ví dụ không có key hoặc ảnh trong request body).
2	Failed in cropping -- CMT trong ảnh bị thiếu góc nên không thể crop về dạng chuẩn.
3	Unable to find Passport in the image -- Hệ thống không tìm thấy Hộ Chiếu trong ảnh hoặc ảnh có chất lượng kém (quá mờ, quá tối/sáng).
5	No URL in the request -- Request sử dụng key image_url nhưng giá trị bỏ trống.
6	Failed to open the URL! -- Request sử dụng key image_url nhưng hệ thống không thể mở được URL này.
7	Invalid image file -- File gửi lên không phải là file ảnh.
8	Bad data -- File ảnh gửi lên bị hỏng hoặc format không được hỗ trợ.