EKYC ZMA SDK Read Card

Thư viện các api đọc thông tin từ thẻ căn cước công dân, tích hợp vào các ứng dụng web, bao gồm zalo mini app.

Installation

npm install @ekyc-zma-sdk/read-card

Configuration

Thiết lập các thông tin cơ bản được cung cấp. Các thông tin này được admin cấp cho đối tác.

import { config } from '@ekyc-zma-sdk/read-card';

// Configure the SDK
config({
  appId: 'your-app-id',
  baseUrl: 'https://api.example.com',
  publicKey: '-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----',
  privateKey: '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----'
});

Features

Luồng đọc thông tin của thẻ CCCD với các thông tin được quét từ NFC:

import { initTransaction, readCard, registerDeviceToken } from '@ekyc-zma-sdk/read-card';

// B1: Đăng ký thiết bị
registerDeviceToken({
    deviceId: "id duy nhất của thiết bị",
    period: 6000,
})
.then(res => {
// B2: khởi tạo một transaction
    return initTransaction()
})
.then(res => {
/* B3: gọi hàm read card để đọc thông tin từ CCCD với các thông tin từ chip NFC của CCCD: 
- sod: (string) Raw data chứa toàn bộ data trong thẻ dưới dạng hash value
- dg1DataB64: (string) Chứa thông tin MRZ
- dg2DataB64: (string) Chứa thông tin sinh trắc học (Biometric Data) bao gồm ảnh chân dung
- dg13DataB64: (string) Chứa thông tin cá nhân bao gồm Họ tên, số thẻ CCCD, ngày sinh, quê quán,....
- dg14DataB64: (string) Thông tin mã khoá dùng để xác thực trong quá trình đọc thẻ
- transactionId: id được khởi tạo từ B2
*/
    const transactionId = res.data
    return readCard({ sod, dg1DataB64, dg2DataB64, dg13DataB64, dg14DataB64, transactionId })
})
.then(res => {
// lấy data trả về với res.data, kết thúc flow đọc thẻ
    console.log(res.data)
})

Sample

Xem sample tại đây, bao gồm full luồng ekyc, bao gồm cả read-card và liveness.