CMND/CCCD/Hộ chiếu#
Cung cấp phương thức để trích xuât thông tin trên các loại giấy tờ tùy thân như:
Chứng minh nhân dân giấy 9 số.
Chứng minh nhân dân thẻ 12 số.
Căn cước công dân 12 số.
Căn cước công dân có gắn chip 12 số.
Hộ chiếu VN.
API ở mục này sẽ trả về dữ liệu trích xuất được ngay trong response của bước upload. Các thông tin có thể đọc được từ Giấy tờ tùy thân bao gồm:
Tên trường |
CMND 9 |
CMND 12 |
CCCD 12 |
CCCD chip 12 |
Hộ chiếu |
Ghi chú |
|---|---|---|---|---|---|---|
address |
✓ |
✓ |
✓ |
✓ |
Địa chỉ |
|
birthday |
✓ |
✓ |
✓ |
✓ |
✓ |
Ngày sinh |
characteristic |
✓ |
✓ |
✓ |
✓ |
Đặc điểm nhận dạng |
|
country |
✓ |
Quốc gia |
||||
ethnicity |
✓ |
Dân tộc |
||||
expiry |
✓ |
✓ |
✓ |
✓ |
Ngày hết hạn |
|
hometown |
✓ |
✓ |
✓ |
✓ |
✓ |
Quê quán |
id |
✓ |
✓ |
✓ |
✓ |
✓ |
Số ID |
id_type |
✓ |
✓ |
✓ |
✓ |
✓ |
Mặt giấy tờ tùy thân |
issue_by |
✓ |
✓ |
✓ |
✓ |
✓ |
Được cấp bởi |
issue_date |
✓ |
✓ |
✓ |
✓ |
✓ |
Được cấp ngày |
name |
✓ |
✓ |
✓ |
✓ |
✓ |
Tên |
national |
✓ |
Quốc tịch |
||||
optional_data |
✓ |
Thông tin thêm |
||||
passport_type |
✓ |
Loại Hộ chiếu |
||||
reliability |
✓ |
✓ |
✓ |
✓ |
✓ |
Độ tin tưởng của giấy tờ tùy thân, độ tin tưởng càng thấp thì khả năng giấy tờ tùy thân là ảnh chụp lại từ màn hình, bị chói hoặc bị mờ nhòe càng cao. |
religion |
✓ |
Tôn giáo |
||||
sex |
✓ |
✓ |
✓ |
✓ |
✓ |
Trả về Nam hoặc Nữ |
warning |
✓ |
Đưa ra cảnh cáo giả mạo. Kiểm tra thông tin của trên GTTT với ID xem có trùng khớp hay không. |
Các loại thông tin của các trường
Loại thông tin |
|
|---|---|
id_type |
Mặt trước: 0 Mặt sau: 1 |
sex |
Nam Nữ |
Các warning, trả về dạng danh sách nếu có nhiều warning, ví dụ:
{
"recognized_data":
{
"warning": [
"ID front-back not match",
"Province code not match",
"Year of birth code not match",
"Sex code not match"
],
"warning_code": [
113,
111,
112,
110
]
},
}
warning_code |
warning |
ghi chú |
|---|---|---|
110 |
Sex code not match |
Giới tính và thông tin trên ID không trùng khớp |
111 |
Province code not match |
Địa chỉ và thông tin trên ID không trùng khớp |
112 |
Year of birth code not match |
Năm sinh và thông tin trên ID không trùng khớp |
113 |
ID front-back not match |
Thông tin ID mặt trước và mặt sau không trùng khớp |
115 |
Image does not reach requirements |
Ảnh không đạt yêu cầu do quá xa hoặc quá tối |
Các trường hợp trả về.
Result code |
Message |
Note |
|---|---|---|
200 |
Success |
Trích xuất thông tin thành công |
101 |
Document not found |
Không tìm thấy giấy tờ tùy thân trong hình |
102 |
Request Document ID not found |
Request id cho bước 2 không tồn tại |
109 |
Too Many Document Type Exists |
Có quá nhiều loại GTTT |
Mỗi lần upload 1 ảnh#
B1. Tạo tài liệu KYC#
Request
Gọi vào API POST /kyc-documents-sync, kèm theo các thông tin tối thiểu sau:
attachment: là một cấu trúc gồm 2 field:content: Nội dung của file dưới dạng base64.name: Tên của file.
Các thông tin tự chọn bao gồm:
external_person_id: ID của nhân viên tạo tài liệu.
Ví dụ
CLI:
jo -d. attachment.content=%CCCD-truoc.jpg attachment.name=CCCD-truoc.jpg | http -a $MY_AUTH https://api-uat.unicloud.ai/ekyc/kyc-documents-sync
Response
Trường hợp thành công
{
"document_type": "identity-proof",
"id": "a72555af-4e92-42d9-822b-5f92c71aaa9c",
"linked_file_ids": [
"72948b59-5421-4700-b7d2-9ca0d060635b"
],
"process_status": "processed",
"recognized_data":
{
"address": "Số 6554, Lương Văn Can, Hà Nội",
"addressconf": "[0.9, 0.9]",
"birthday": "11/12/2013",
"birthdayconf": "[0.9]",
"document": "CHIP ID",
"documentconf": "[0.86]",
"expiry": "23/12/2034",
"expiryconf": "[0.9]",
"hometown": "Phú Mỹ, Phù Ninh, Phú Thọ",
"hometownconf": "[0.91]",
"id": "025485421546",
"id_type": "0",
"idconf": "[0.9]",
"message": "Success",
"name": "NGUYỄN DU NI",
"nameconf": "[0.91]",
"national": "Việt Nam",
"nationalconf": "[0.9]",
"reliability": "[0.98]",
"result_code": 200,
"server_tag": "sst-v1.26.0-cuda:0",
"sex": "Nữ",
"sexconf": "[0.9]"
}
}
Trường hợp ảnh GTTT không phải ảnh chụp trực tiếp sẽ được thể hiện ở trường reliability
{
...
"recognized_data":
{
...
"reliability": "[0.4]",
}
}
Trường hợp ảnh GTTT là ảnh photo, trường reliability sẽ có giá trị thứ 2 bằng -1
{
...
"recognized_data":
{
...
"reliability": "[0.0, -1.0]"
}
}
B2. Đính kèm thêm các file còn lại#
Gọi vào API POST /kyc-documents-sync/{document_id}, kèm theo các thông tin tối thiểu sau:
content: Nội dung của file dưới dạng base64.name: Tên của file.
Ví dụ
CLI:
jo -d. content=%CCCD-sau.jpg name=CCCD-sau.jpg | http -a $MY_AUTH https://api-uat.unicloud.ai/ekyc/kyc-documents-sync/a72555af-4e92-42d9-822b-5f92c71aaa9c
Response
Trường hợp thành công
{
"document_type": "identity-proof",
"id": "a72555af-4e92-42d9-822b-5f92c71aaa9c",
"linked_file_ids": [
"72948b59-5421-4700-b7d2-9ca0d060635b",
"72948b59-5421-4700-b434-9ca0d060635b"
],
"process_status": "processed",
"recognized_data":
{
"address": "Số 6554, Lương Văn Can, Hà Nội",
"addressconf": "[0.9, 0.9]",
"birthday": "11/12/2013",
"birthdayconf": "[0.9]",
"characteristics": "Nốt ruồi C:3 cm dưới đuôi mắt phải",
"document": "CHIP ID",
"documentconf": "[0.86]",
"expiry": "23/12/2034",
"expiryconf": "[0.9]",
"hometown": "Phú Mỹ, Phù Ninh, Phú Thọ",
"hometownconf": "[0.91]",
"id": "025485421546",
"id_type": "0",
"idconf": "[0.9]",
"issue_by": "CỤC TRƯỞNG CỤC CẢNH SÁT QUẢN LÝ HÀNH CHÍNH VỀ TRẬT TỰ XÃ HỘI",
"issue_by_conf": "[0.9]",
"issue_date": "13/04/2021",
"issue_date_conf": "[0.9]",
"message": "Success",
"name": "NGUYỄN DU NI",
"nameconf": "[0.91]",
"national": "Việt Nam",
"nationalconf": "[0.9]",
"reliability": "[0.98]",
"result_code": 200,
"server_tag": "sst-v1.26.0-cuda:0",
"sex": "Nữ",
"sexconf": "[0.9]"
}
}
Trường hợp có warning khi kiểm tra ID của loại Căn cước có gắn chip
{
"document_type": "identity-proof",
"id": "a72555af-4e92-42d9-822b-5f92c71aaa9c",
"linked_file_ids": [
"72948b59-5421-4700-b7d2-9ca0d060635b",
"72948b59-5421-4700-b434-9ca0d060635b"
],
"process_status": "processed",
"recognized_data":
{
"address": "Số 6554, Lương Văn Can, Hà Nội",
"addressconf": "[0.9, 0.9]",
"birthday": "11/12/2013",
"birthdayconf": "[0.9]",
"characteristics": "Nốt ruồi C:3 cm dưới đuôi mắt phải",
"document": "CHIP ID",
"documentconf": "[0.86]",
"expiry": "23/12/2034",
"expiryconf": "[0.9]",
"hometown": "Phú Mỹ, Phù Ninh, Phú Thọ",
"hometownconf": "[0.91]",
"id": "025485421546",
"id_type": "0",
"idconf": "[0.9]",
"issue_by": "CỤC TRƯỞNG CỤC CẢNH SÁT QUẢN LÝ HÀNH CHÍNH VỀ TRẬT TỰ XÃ HỘI",
"issue_by_conf": "[0.9]",
"issue_date": "13/04/2021",
"issue_date_conf": "[0.9]",
"message": "Success",
"name": "NGUYỄN DU NI",
"nameconf": "[0.91]",
"national": "Việt Nam",
"nationalconf": "[0.9]",
"reliability": "[0.98]",
"result_code": 200,
"server_tag": "sst-v1.26.0-cuda:0",
"sex": "Nữ",
"sexconf": "[0.9]",
"warning": [
"ID front-back not match",
"Province code not match",
"Year of birth code not match",
"Sex code not match"
],
"warning_code": [
113,
111,
112,
110
]
},
}
Trường hợp có nhiều loại GTTT trong ảnh, ví dụ ảnh thứ nhất đọc ở bước 1 là Chứng minh nhân dân giấy 9 số, ảnh 2 ở bước 2 này là Chứng minh nhân dân thẻ 12 số
{
...
"recognized_data":{
"message": "Too Many Document Type Exists",
"result_code": 109
}
}
Upload 2 ảnh 1 lần#
Cung cấp phương thức để trích xuât thông tin trên các loại giấy tờ tùy thân có thông tin ở hai mặt như:
Chứng minh nhân dân
Căn cước công dân
Không sử dụng cho hộ chiếu.
API ở mục nhận vào 1 lúc 2 ảnh sẽ trả về dữ liệu trích xuất được ngay trong response và các thông tin trích xuất tương tự như thông tin ở mục trên.
Request
Gọi vào API POST /kyc-documents-sides, kèm theo các thông tin tối thiểu sau:
image1: Nội dung của file 1 dưới dạng base64.name1: Tên của hình 1.image2: Nội dung của file 2 dưới dạng base64.name2: Tên của hình 2.
Ví dụ
CLI:
jo -d. image1=%CCCD-truoc.jpg name1=CCCD-truoc.jpg image2=%CCCD-sau.jpg name2=CCCD-sau.jpg | http -a $MY_AUTH https://api-uat.unicloud.ai/ekyc/kyc-documents-sides
Response
Trường hợp thành công
{
"document_type": "identity-proof",
"id": "781bfe27-4565-44c3-8304-1572111cc8d3",
"linked_file_ids": [
"8cfdff42-1245-4aeb-ac9a-02af125eeca3"
],
"message": "Success",
"recognized_data":
{
"address": "Số 6554, Lương Văn Can, Hà Nội",
"addressconf": "[0.9, 0.9]",
"birthday": "11/12/2013",
"birthdayconf": "[0.9]",
"characteristics": "Nốt ruồi C:3 cm dưới đuôi mắt phải",
"document": "CHIP ID",
"documentconf": "[0.86]",
"expiry": "23/12/2034",
"expiryconf": "[0.9]",
"hometown": "Phú Mỹ, Phù Ninh, Phú Thọ",
"hometownconf": "[0.91]",
"id": "025485421546",
"id_type": "0",
"idconf": "[0.9]",
"issue_by": "CỤC TRƯỞNG CỤC CẢNH SÁT QUẢN LÝ HÀNH CHÍNH VỀ TRẬT TỰ XÃ HỘI",
"issue_by_conf": "[0.9]",
"issue_date": "13/04/2021",
"issue_date_conf": "[0.9]",
"name": "NGUYỄN DU NI",
"nameconf": "[0.91]",
"national": "Việt Nam",
"nationalconf": "[0.9]",
"reliability": "[0.98]",
"server_tag": "sst-v1.26.0-cuda:0",
"sex": "Nữ",
"sexconf": "[0.9]",
"warning": ["Information was not on the same card"],
"warning_code": 109,
},
"result_code": 200
}
Trường hợp giá trị thể hiện ảnh chụp từ màn hình thiết bị khác sẽ nằm ở giá trị thứ 1, nếu là ảnh in trắng đen sẽ xuất hiện giá trị thứ 2
{
...
"message": "Success",
"recognized_data":
{
...
"reliability": "[0.4, -1.0]"
},
"result_code": 200
}
Trường hợp 2 ảnh là các loại GTTT khác nhau
{
...
"message": "Too Many Document Type Exists",
"recognized_data": {
...
"document": "MULTIPLE",
"id_type": "UNIDENTIFIED",
},
"result_code": 109
}
Trường hợp 2 ảnh là cùng loại Căn cước công dân có gắn chip nhưng không cùng 1 thẻ, tức ID mặt trước và mặt sau không giống nhau
{
...
"message": "Success",
"recognized_data": {
...
"document": "CHIP ID",
"warning": [
"ID front-back not match"
],
"warning_code": [
113
]
},
"result_code": 200
}