Vero OMS API

curl --request POST \ --url https://api-gw.verolabs.co/api/v2/chat/api/id-card \ --header 'Content-Type: application/json' \ --data ' { "frontImage": "aSDinaTvuI8gbWludGxpZnk=", "backImage": "aSDinaTvuI8gbWludGxpZnk=", "portraitImage": "aSDinaTvuI8gbWludGxpZnk=" } '

{ "data": { "idNumber": "<string>", "fullName": "<string>", "dateOfBirth": "31/12/1990", "sex": "Nam", "nationality": "Việt Nam", "placeOfOrigin": "<string>", "placeOfResidence": "<string>", "dateOfExpiry": "31/12/2030", "dateOfIssue": "01/01/2020", "issuedBy": "<string>", "address": "<string>" }, "imageUrls": { "front": "<string>", "back": "<string>", "portrait": "<string>" } }

Nội dung

application/json

Ảnh CCCD/CMND dạng base64 trong luồng đăng ký. frontImage là bắt buộc; backImage và portraitImage là tùy chọn.

Payload gửi ảnh giấy tờ định danh trong luồng đăng ký.

frontImage

string<byte>

bắt buộc

Nội dung ảnh mặt trước CCCD/CMND ở dạng base64. Chỉ gửi phần base64, không gửi tiền tố data URL.

backImage

string<byte>

Nội dung ảnh mặt sau CCCD/CMND ở dạng base64, gửi khi có ảnh mặt sau.

portraitImage

string<byte>

Ảnh chân dung hoặc selfie ở dạng base64, gửi khi có ảnh xác minh khuôn mặt.

Phản hồi

Dữ liệu định danh đã trích xuất và URL ảnh đã xử lý nếu có.

Response thành công của API trích xuất thông tin CCCD/CMND.

data

object

bắt buộc

Các trường định danh được trích xuất từ ảnh giấy tờ đã gửi.

Hide child attributes

data.idNumber

string

bắt buộc

Số CCCD/CMND được trích xuất từ mặt trước giấy tờ.

data.fullName

string

bắt buộc

Họ tên đầy đủ được trích xuất từ giấy tờ.

data.dateOfBirth

string

bắt buộc

Ngày sinh được trích xuất từ giấy tờ, thường theo định dạng dd/MM/yyyy.

Ví dụ:

"31/12/1990"

data.sex

string

bắt buộc

Giới tính được trích xuất từ giấy tờ.

Ví dụ:

"Nam"

data.nationality

string

bắt buộc

Quốc tịch được trích xuất từ giấy tờ.

Ví dụ:

"Việt Nam"

data.placeOfOrigin

string

bắt buộc

Quê quán hoặc nơi sinh được trích xuất từ giấy tờ.

data.placeOfResidence

string

bắt buộc

Nơi thường trú được trích xuất từ giấy tờ.

data.dateOfExpiry

string

bắt buộc

Ngày hết hạn của giấy tờ, thường theo định dạng dd/MM/yyyy.

Ví dụ:

"31/12/2030"

data.dateOfIssue

string

Ngày cấp giấy tờ, nếu trích xuất được.

Ví dụ:

"01/01/2020"

data.issuedBy

string

Cơ quan cấp giấy tờ, nếu trích xuất được.

data.address

string

Địa chỉ đã phân tích, nếu API trả về.

imageUrls

object

URL ảnh đã lưu hoặc đã chuẩn hóa, trả về khi có.

Hide child attributes

imageUrls.front

string<uri>

bắt buộc

URL ảnh mặt trước đã lưu hoặc đã xử lý.

imageUrls.back

string<uri>

bắt buộc

URL ảnh mặt sau đã lưu hoặc đã xử lý.

imageUrls.portrait

string<uri>

bắt buộc

URL ảnh chân dung hoặc selfie đã lưu hoặc đã xử lý.

Documentation Index

Nội dung

Phản hồi