API Callback kết quả consent
Nền tảng thông báo cho TCDN kết quả xác nhận chia sẻ/không chia sẻ của công dân và các mã lỗi tài khoản VNeID.
Đây là API do TCDN tự xây dựng và khai báo URL trong AgentGW. Nền tảng gọi POST tới URL này ngay sau khi TCDN khởi tạo giao dịch (agent/init) để báo trạng thái tài khoản VNeID, và sau khi công dân xác nhận chia sẻ/không chia sẻ.
Endpoint
| Method | Endpoint | Mô tả |
|---|---|---|
POST | URL do TCDN định nghĩa trong AgentGW | Nền tảng gọi về TCDN |
Request body (Nền tảng → TCDN)
| Tham số | Kiểu | Mô tả |
|---|---|---|
requestId | String | Tham chiếu request_id TCDN gửi khi khởi tạo |
resultCode | String | 1 đồng ý, 2 không đồng ý, INIT hiển thị màn consent, hoặc mã lỗi (ví dụ -17) |
resultDesc | String | Mô tả chi tiết (xem Bảng mã responseCode) |
txnId | String | Mã giao dịch dùng để truy vấn dữ liệu khi công dân đồng ý |
data | Object | Dữ liệu trả thêm tuỳ nhu cầu (có thể không có) |
Callback — Công dân đồng ý chia sẻ
{
"requestId": "7353b035-90e7-436c-93df-faa9e1817d74",
"resultCode": "1",
"resultDesc": "Success!",
"txnId": "63d57f38-99dc-4c53-b05c-57dd24ec386d"
}Callback — Thông tin công dân không hợp lệ (Mức 1, hết hạn…)
{
"requestId": "d052c2b651964557b242e885efbf82a2",
"resultCode": "-17",
"resultDesc": "Thông tin công dân không hợp lệ, vui lòng kiểm tra chi tiết trên ứng dụng VNeID",
"txnId": "22c3cf62-b6bd-4b04-b8ba-e29a5d03ac42"
}Response body (TCDN → Nền tảng)
TCDN xác nhận đã nhận
{
"responseCode": 0,
"description": "Success",
"responseTime": "31102026093012"
}Nếu
resultCode là mã lỗi (ví dụ -17) ngay sau khởi tạo, TCDN phải dừng luồng và KHÔNG switch App to App sang VNeID. Trạng thái INIT cho biết VNeID đã hiển thị màn consent thành công.Đây là API do TCDN tự xây dựng và khai báo URL trong AgentGW. Nền tảng gọi POST tới URL này ngay sau khi TCDN khởi tạo giao dịch (agent/init) để báo trạng thái tài khoản VNeID, và sau khi công dân xác nhận chia sẻ/không chia sẻ.
Endpoint
| Method | Endpoint | Mô tả |
|---|---|---|
POST | URL do TCDN định nghĩa trong AgentGW | Nền tảng gọi về TCDN |
Request body (Nền tảng → TCDN)
| Tham số | Kiểu | Mô tả |
|---|---|---|
requestId | String | Tham chiếu request_id TCDN gửi khi khởi tạo |
resultCode | String | 1 đồng ý, 2 không đồng ý, INIT hiển thị màn consent, hoặc mã lỗi (ví dụ -17) |
resultDesc | String | Mô tả chi tiết (xem Bảng mã responseCode) |
txnId | String | Mã giao dịch dùng để truy vấn dữ liệu khi công dân đồng ý |
data | Object | Dữ liệu trả thêm tuỳ nhu cầu (có thể không có) |
Response body (TCDN → Nền tảng)
Nếu
resultCode là mã lỗi (ví dụ -17) ngay sau khởi tạo, TCDN phải dừng luồng và KHÔNG switch App to App sang VNeID. Trạng thái INIT cho biết VNeID đã hiển thị màn consent thành công.Callback — Công dân đồng ý chia sẻ
{
"requestId": "7353b035-90e7-436c-93df-faa9e1817d74",
"resultCode": "1",
"resultDesc": "Success!",
"txnId": "63d57f38-99dc-4c53-b05c-57dd24ec386d"
}Callback — Thông tin công dân không hợp lệ (Mức 1, hết hạn…)
{
"requestId": "d052c2b651964557b242e885efbf82a2",
"resultCode": "-17",
"resultDesc": "Thông tin công dân không hợp lệ, vui lòng kiểm tra chi tiết trên ứng dụng VNeID",
"txnId": "22c3cf62-b6bd-4b04-b8ba-e29a5d03ac42"
}TCDN xác nhận đã nhận
{
"responseCode": 0,
"description": "Success",
"responseTime": "31102026093012"
}