Chuyển đến nội dung chính
VOS API v2 ghi nhận contract trích xuất CCCD trong đăng ký được dùng bởi Vero OMS. Dùng OpenAPI reference làm nguồn chuẩn cho path, request schema, response schema và yêu cầu xác thực.

Phạm vi hiện tại

NhómOperationMục đích
Đăng kýPOST /api/v2/chat/api/id-cardTrích xuất thông tin CCCD/CMND trong luồng đăng ký.

Trích xuất CCCD

Request body, ví dụ, response schema và định dạng lỗi.

Nguồn OpenAPI

File OpenAPI đã lọc chứa operation API v2 được document.

Hướng dẫn versioning

Chủ đềHướng dẫn
Version trong pathGiữ đúng path /api/v2 như tài liệu.
Base URLDùng server URL được định nghĩa trong OpenAPI operation hoặc API playground được generate.
Xác thựcTheo đúng yêu cầu security của từng endpoint. Endpoint trích xuất CCCD trong đăng ký không yêu cầu xác thực.
Định dạng payloadGửi JSON field đúng schema. Với ảnh CCCD, gửi nội dung base64 không kèm tiền tố data: URL.

Luồng trích xuất CCCD khi đăng ký

1

Chuẩn bị ảnh

Chụp hoặc upload ảnh mặt trước CCCD/CMND. Chỉ gửi ảnh mặt sau hoặc ảnh chân dung khi quy trình đăng ký yêu cầu.
2

Gửi request API v2

Gọi POST /api/v2/chat/api/id-card với payload ảnh dạng base64.
3

Xác thực dữ liệu trích xuất

Dùng response để điền thông tin đăng ký, sau đó yêu cầu người dùng kiểm tra và chỉnh sửa trước khi submit.