API xác thực danh tính của VTS

eVerify

eVerify là REST API để hệ thống của bạn xác thực giấy tờ tùy thân. Bản hiện tại hỗ trợ xác thực CCCD gắn chip với Bộ Công an (eID C06). Xác thực vân tay và eKYC sẽ có trong các bản sau.

Bắt đầu nhanhTạo ứng dụng, lấy API key và gửi request đầu tiên.eID C06Gửi dữ liệu chip CCCD, nhận kết luận VALID hoặc INVALID.Tham chiếu APITham số, schema và response của từng endpoint.

Gọi thử trong 1 phút

Lấy API key trong mục Tích hợp API của eDevice (xem Bắt đầu nhanh), rồi chạy:

export EVERIFY_API_KEY="evf_live_..."            # thay bằng key của bạn
export EVERIFY_BASE_URL="https://everify.vtsi.vn/api/v1"

curl -sS "$EVERIFY_BASE_URL/balance" -H "X-API-Key: $EVERIFY_API_KEY"

Key đúng thì bạn nhận được số lượt còn lại của đơn vị:

{
  "request_id": "req_01JBF8...",
  "data": {
    "enterprise_code": "VPCC-DA",
    "balances": [
      { "quota_type": "eid_verify", "name": "Xác thực eID", "total_in": 5000, "total_out": 0, "used": 0, "reserved": 0, "balance": 5000 }
    ]
  },
  "error": null
}

Endpoint

Endpoint	Chức năng
`POST /eid/verify`	Gửi dữ liệu đọc từ chip CCCD, nhận kết luận `VALID` hoặc `INVALID` từ Bộ Công an.
`GET /balance`	Xem số lượt còn lại của đơn vị sở hữu ứng dụng.
`GET /transactions`	Xem lịch sử giao dịch của ứng dụng hoặc cả đơn vị, phân trang theo cursor.
`GET /ledger`	Xem sổ biến động của ví: cấp, chia, thu hồi, trừ, hoàn lượt.
`GET /usage/summary`	Tổng hợp số lần gọi theo ngày hoặc tháng để đối soát.

Địa chỉ gốc: https://everify.vtsi.vn/api/v1.

Quy ước chung

Xác thực bằng header X-API-Key. Xem Xác thực.
Mọi response có dạng { request_id, data, error }. Thành công thì error là null. Có lỗi thì data là null. Xem Mã lỗi.
Chỉ gọi từ máy chủ. Không đặt API key trong web hoặc ứng dụng di động.
Mỗi lần xác thực có kết luận trừ 1 lượt của đơn vị sở hữu ứng dụng. Xem Sản lượng và trừ lượt.

Gọi thử trong 1 phút​

Endpoint​

Quy ước chung​

Gọi thử trong 1 phút

Endpoint

Quy ước chung