API Lấy dữ liệu công dân (get-transaction)
Truy vấn dữ liệu công dân đã đồng ý chia sẻ hoặc kết quả xác thực thông tin — áp dụng cho dịch vụ không có xác thực ảnh mặt.
Sau khi công dân xác nhận chia sẻ trên VNeID, TCDN gọi endpoint này với transactionId để nhận userInfo (JWS). Với dịch vụ xác thực thông tin (verify-info), các trường gửi lên khi khởi tạo sẽ trả về True/False.
Endpoint
| Method | Endpoint | Mô tả |
|---|---|---|
POST | /api/tcdn/{service-code}/api/get-transaction | Lấy dữ liệu (không ảnh mặt) |
Tham số thân yêu cầu (Body)
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
transactionId | String | Có | Mã giao dịch nhận được khi khởi tạo thành công |
curl -X POST "https://ekyc-c06.hitechcloud.vn/api/tcdn/share-info/api/get-transaction" \
-H "Content-Type: application/json; charset=utf-8" \
-H "api_key: YOUR_API_KEY" \
-H "target_code: YOUR_TARGET_CODE" \
-H "request_id: 087f0479-98e8-4f37-a312-a7e24399e26a" \
-H "request_time: 31102026093500" \
-d '{ "transactionId": "a569782f-8768-42bb-b231-8b0c9cb4b2e4" }'{
"description": "Success!",
"responseTime": "31102026093511",
"responseCode": "0",
"data": { "biometric": 0, "pid": null },
"userInfo": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpPU0UvSldTIn0=.<payload>.<signature>"
}{
"fullName": "Nguyễn Thị Huế",
"birthDate": "24-04-1988",
"nationalityCode": "VN",
"citizenPid": "036188001958",
"indentifyNumber": "654721832",
"dateOfIssue": "23-07-2024",
"issuingAuthority": "Cục Cảnh sát quản lý hành chính về trật tự xã hội",
"genderCode": "3",
"permanentAddress": "Khu Đô Thị Hai Bên Đường Lê Trọng Tấn",
"permanentVillageCode": "09877",
"permanentDistrictCode": null,
"permanentCityCode": "01",
"livingPlaceAddress": "Khu Đô Thị Hai Bên Đường Lê Trọng Tấn",
"idCardExpireDate": "30-12-2030"
}Các trường userInfo tiêu biểu
| Trường | Mô tả |
|---|---|
citizenPid | Số định danh/CCCD (12 số) |
fullName / birthDate | Họ tên; ngày sinh dd-MM-yyyy |
permanentCityCode / permanentCityText | Mã & tên tỉnh thường trú |
livingPlaceCityCode / livingPlaceCityText | Mã & tên tỉnh nơi ở hiện tại |
idCardExpireDate | Ngày hết hạn CCCD |
genderCode | Mã giới tính (1–4, xem Bảng mã) |
verify-info: trường gửi lên khi khởi tạo trả về true/false (khớp/không khớp CSDL); trường không gửi lên sẽ trả dữ liệu công dân nếu công dân đồng ý chia sẻ. Giá trị cấp huyện (*DistrictCode) có thể trả null.Kiểm thử tại chỗ
https://ekyc-c06.hitechcloud.vn/api/tcdn/share-info/api/get-transactionKiểm thử tại chỗtransactionId hết hạn sau 30 phút và chỉ gọi tối đa 3 lần. userInfo là JWS — xác minh bằng public key C06. Khoá không được lưu lại.
Sau khi công dân xác nhận chia sẻ trên VNeID, TCDN gọi endpoint này với transactionId để nhận userInfo (JWS). Với dịch vụ xác thực thông tin (verify-info), các trường gửi lên khi khởi tạo sẽ trả về True/False.
Endpoint
| Method | Endpoint | Mô tả |
|---|---|---|
POST | /api/tcdn/{service-code}/api/get-transaction | Lấy dữ liệu (không ảnh mặt) |
Tham số thân yêu cầu (Body)
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
transactionId | String | Có | Mã giao dịch nhận được khi khởi tạo thành công |
Các trường userInfo tiêu biểu
| Trường | Mô tả |
|---|---|
citizenPid | Số định danh/CCCD (12 số) |
fullName / birthDate | Họ tên; ngày sinh dd-MM-yyyy |
permanentCityCode / permanentCityText | Mã & tên tỉnh thường trú |
livingPlaceCityCode / livingPlaceCityText | Mã & tên tỉnh nơi ở hiện tại |
idCardExpireDate | Ngày hết hạn CCCD |
genderCode | Mã giới tính (1–4, xem Bảng mã) |
verify-info: trường gửi lên khi khởi tạo trả về true/false (khớp/không khớp CSDL); trường không gửi lên sẽ trả dữ liệu công dân nếu công dân đồng ý chia sẻ. Giá trị cấp huyện (*DistrictCode) có thể trả null.Kiểm thử tại chỗ
https://ekyc-c06.hitechcloud.vn/api/tcdn/share-info/api/get-transactionKiểm thử tại chỗtransactionId hết hạn sau 30 phút và chỉ gọi tối đa 3 lần. userInfo là JWS — xác minh bằng public key C06. Khoá không được lưu lại.
curl -X POST "https://ekyc-c06.hitechcloud.vn/api/tcdn/share-info/api/get-transaction" \
-H "Content-Type: application/json; charset=utf-8" \
-H "api_key: YOUR_API_KEY" \
-H "target_code: YOUR_TARGET_CODE" \
-H "request_id: 087f0479-98e8-4f37-a312-a7e24399e26a" \
-H "request_time: 31102026093500" \
-d '{ "transactionId": "a569782f-8768-42bb-b231-8b0c9cb4b2e4" }'{
"description": "Success!",
"responseTime": "31102026093511",
"responseCode": "0",
"data": { "biometric": 0, "pid": null },
"userInfo": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpPU0UvSldTIn0=.<payload>.<signature>"
}{
"fullName": "Nguyễn Thị Huế",
"birthDate": "24-04-1988",
"nationalityCode": "VN",
"citizenPid": "036188001958",
"indentifyNumber": "654721832",
"dateOfIssue": "23-07-2024",
"issuingAuthority": "Cục Cảnh sát quản lý hành chính về trật tự xã hội",
"genderCode": "3",
"permanentAddress": "Khu Đô Thị Hai Bên Đường Lê Trọng Tấn",
"permanentVillageCode": "09877",
"permanentDistrictCode": null,
"permanentCityCode": "01",
"livingPlaceAddress": "Khu Đô Thị Hai Bên Đường Lê Trọng Tấn",
"idCardExpireDate": "30-12-2030"
}