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.

Xem Markdown

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

MethodEndpointMô tả
POST/api/tcdn/{service-code}/api/get-transactionLấy dữ liệu (không ảnh mặt)

Tham số thân yêu cầu (Body)

Tham sốKiểuBắt buộcMô tả
transactionIdStringCóMã giao dịch nhận được khi khởi tạo thành công
cURL lấy dữ liệu công dân
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" }'
Phản hồi (HTTP 200)
{
  "description": "Success!",
  "responseTime": "31102026093511",
  "responseCode": "0",
  "data": { "biometric": 0, "pid": null },
  "userInfo": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpPU0UvSldTIn0=.<payload>.<signature>"
}
userInfo sau khi parse JWS (payload)
{
  "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ườngMô tả
citizenPidSố định danh/CCCD (12 số)
fullName / birthDateHọ tên; ngày sinh dd-MM-yyyy
permanentCityCode / permanentCityTextMã & tên tỉnh thường trú
livingPlaceCityCode / livingPlaceCityTextMã & tên tỉnh nơi ở hiện tại
idCardExpireDateNgày hết hạn CCCD
genderCodeMã giới tính (1–4, xem Bảng mã)
Với 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ỗ

POSThttps://ekyc-c06.hitechcloud.vn/api/tcdn/share-info/api/get-transaction

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.

Headers
Body