Phiên bản: 2.3.0

Lấy thông tin chi tiết chứng từ

Ngày cập nhật: 16 tháng 09, 2026
Người cập nhật: VNPT eContract's team

Mục đích

Tra cứu thông tin chi tiết của chứng từ theo DocumentId, bao gồm thông tin chứng từ, trạng thái xử lý hiện tại, danh sách các file thành phần và thông tin quy trình/người dùng đang chờ xử lý chứng từ.

Request URL: /v2/documents/{documentId}
HTTP method: GET
Authorize: Bearer token
Parameter:

Key	Vị trí	Type	Bắt buộc	Description
`documentId`	Path param	GUID	Có	Id chứng từ cần tra cứu (ví dụ: `/v2/documents/c7cd1930-...`)

Mẫu request

GET /v2/documents/f5b0c112-d357-44ce-b8a8-7cb77d3d0b9e

Mẫu response body

{
    "data": {
        "id": "f5b0c112-d357-44ce-b8a8-7cb77d3d0b9e",
        "createdDate": "2026-08-13T17:55:40.8560899",
        "lastModifiedDate": "2026-08-13T17:58:46.1287882",
        "no": "DOCUMENT-MF-001",
        "subject": "Chứng từ nhiều file DOCUMENT-MF-001 - Cập nhật",
        "hasVerified": false,
        "hasVerify": false,
        "hasSeal": false,
        "requireVerifiedUserSigning": false,
        "status": {
            "value": 2,
            "description": "Ready"
        },
        "contractStatus": {
            "value": 0,
            "description": "Undefined"
        },
        "description": "Ví dụ cập nhật chứng từ DOCUMENT-MF-001",
        "department": {
            "id": 9855,
            "name": "Phòng ban Kinh Doanh 04",
            "code": "DPM004",
            "users": [
            ]
        },
        "createdByUser": {
            "id": 27938,
            "code": "creator",
            "name": "Văn thư",
            "email": "creator@yopmail.com",
            "phone": "0123456789",
            "comId": 7354,
            "username": "creator@yopmail.com",
            "isSelected": false
        },
        "createdByUserId": 27938,
        "processRecipientCount": 2,
        "waitingProcess": {
            "id": "bba867ee-09f9-41f6-6ddb-08def929c6d3",
            "createdDate": "2026-08-13T17:58:15.7798094",
            "comId": 7354,
            "isOrder": true,
            "orderNo": 1,
            "pageSign": 1,
            "position": "234,514,374,574",
            "displayType": {
                "value": 0,
                "description": "0"
            },
            "accessPermission": {
                "value": 4,
                "description": "Sign digital"
            },
            "status": {
                "value": 1,
                "description": "Waiting"
            },
            "processedByUserId": 59407,
            "processedByUser": {
                "id": 59407,
                "code": "user001",
                "name": "Người dùng 001",
                "email": "user001@yopmail.com",
                "comId": 7354,
                "username": "user001@yopmail.com",
                "isSelected": false
            },
            "documentId": "f5b0c112-d357-44ce-b8a8-7cb77d3d0b9e",
            "fillingItems": [
            ],
            "fileInfoId": "6865273c-90f5-49cd-403b-08defc11a479",
            "attachments": [
            ]
        },
        "waitingProcesses": [
            {
                "id": "bba867ee-09f9-41f6-6ddb-08def929c6d3",
                "createdDate": "2026-08-13T17:58:15.7798094",
                "comId": 7354,
                "isOrder": true,
                "orderNo": 1,
                "pageSign": 1,
                "position": "234,514,374,574",
                "displayType": {
                    "value": 0,
                    "description": "0"
                },
                "accessPermission": {
                    "value": 4,
                    "description": "Sign digital"
                },
                "status": {
                    "value": 1,
                    "description": "Waiting"
                },
                "processedByUserId": 59407,
                "processedByUser": {
                    "id": 59407,
                    "code": "user001",
                    "name": "Người dùng 001",
                    "email": "user001@yopmail.com",
                    "comId": 7354,
                    "username": "user001@yopmail.com",
                    "isSelected": false
                },
                "documentId": "f5b0c112-d357-44ce-b8a8-7cb77d3d0b9e",
                "fillingItems": [
                ],
                "fileInfoId": "6865273c-90f5-49cd-403b-08defc11a479",
                "attachments": [
                ]
            }
        ],
        "processInOrder": true,
        "isWaitToSignDraw": false,
        "isWaitToSignDigital": false,
        "isWaitToApprove": false,
        "isWaitToFillData": false,
        "isWaitToCoordinate": false,
        "isWaitToESign": false,
        "isWaitToEkyc": false,
        "isFillable": false,
        "type": {
            "id": 8950,
            "code": "DOCID",
            "name": "Chứng từ thử nghiệm",
            "documentCount": 1,
            "enableVnptSeal": false,
            "requireVerifiedUserSigning": false,
            "children": [
            ]
        },
        "processes": [
            {
                "id": "bba867ee-09f9-41f6-6ddb-08def929c6d3",
                "createdDate": "2026-08-13T17:58:15.7798094",
                "comId": 7354,
                "isOrder": true,
                "orderNo": 1,
                "pageSign": 1,
                "position": "234,514,374,574",
                "displayType": {
                    "value": 0,
                    "description": "0"
                },
                "accessPermission": {
                    "value": 4,
                    "description": "Sign digital"
                },
                "status": {
                    "value": 1,
                    "description": "Waiting"
                },
                "processedByUserId": 59407,
                "processedByUser": {
                    "id": 59407,
                    "code": "user001",
                    "name": "Người dùng 001",
                    "email": "user001@yopmail.com",
                    "comId": 7354,
                    "username": "user001@yopmail.com",
                    "isSelected": false
                },
                "documentId": "f5b0c112-d357-44ce-b8a8-7cb77d3d0b9e",
                "fillingItems": [
                ],
                "fileInfoId": "6865273c-90f5-49cd-403b-08defc11a479",
                "attachments": [
                ]
            },
            {
                "id": "129da2f9-85d4-4390-6ddc-08def929c6d3",
                "createdDate": "2026-08-13T17:58:15.7799953",
                "comId": 7354,
                "isOrder": true,
                "orderNo": 2,
                "pageSign": 1,
                "position": "334,614,474,674",
                "displayType": {
                    "value": 0,
                    "description": "0"
                },
                "accessPermission": {
                    "value": 4,
                    "description": "Sign digital"
                },
                "status": {
                    "value": 1,
                    "description": "Waiting"
                },
                "processedByUserId": 27938,
                "processedByUser": {
                    "id": 27938,
                    "code": "user002",
                    "name": "Người dùng 002",
                    "email": "user002@yopmail.com",
                    "phone": "0123456789",
                    "comId": 7354,
                    "username": "user002@yopmail.com",
                    "isSelected": false
                },
                "documentId": "f5b0c112-d357-44ce-b8a8-7cb77d3d0b9e",
                "fillingItems": [
                ],
                "fileInfoId": "a940f960-213c-4a89-403c-08defc11a479",
                "attachments": [
                ]
            }
        ],
        "accessibleViewProcesses": [
        ],
        "histories": [
            {
                "createdDate": "2026-08-13T17:55:41.0734176",
                "requestType": {
                    "value": 0,
                    "description": "Web"
                },
                "ipAddress": "10.70.39.34",
                "user": {
                    "id": 27938,
                    "code": "creator",
                    "name": "Văn thư",
                    "email": "creator@yopmail.com",
                    "phone": "0123456789",
                    "comId": 7354,
                    "username": "creator@yopmail.com",
                    "isSelected": false
                },
                "activity": {
                    "value": 1,
                    "description": "Create document"
                }
            },
            {
                "createdDate": "2026-08-13T17:58:15.7800305",
                "requestType": {
                    "value": 0,
                    "description": "Web"
                },
                "ipAddress": "10.70.39.34",
                "user": {
                    "id": 27938,
                    "code": "creator",
                    "name": "Văn thư",
                    "email": "creator@yopmail.com",
                    "phone": "0123456789",
                    "comId": 7354,
                    "username": "creator@yopmail.com",
                    "isSelected": false
                },
                "activity": {
                    "value": 2,
                    "description": "Update document"
                }
            },
            {
                "createdDate": "2026-08-13T17:58:46.1260242",
                "requestType": {
                    "value": 0,
                    "description": "Web"
                },
                "ipAddress": "10.70.39.34",
                "user": {
                    "id": 27938,
                    "code": "creator",
                    "name": "Trần Thị Việt Trinh",
                    "email": "creator@yopmail.com",
                    "phone": "0919380915",
                    "comId": 7354,
                    "username": "creator@yopmail.com",
                    "isSelected": false
                },
                "activity": {
                    "value": 3,
                    "description": "Invite recipient"
                }
            }
        ],
        "attachments": [],
        "relatedDocuments": [],
        "linkedDocuments": [],
        "messages": [],
        "fillingItems": [],
        "sharedUsers": [],
        "isMarkStar": false,
        "downloadFileUrls": [
            {
                "id": "6865273c-90f5-49cd-403b-08defc11a479",
                "fileName": "Tai-lieu-chinh-01.pdf",
                "downloadUrl": "{HOST}/api/Download?token=...",
                "downloadWatermarkMetadataUrl": "{HOST}/api/Download?token=...",
                "orderNo": 1,
                "size": 358043,
                "fileType": {
                    "value": 0,
                    "description": "General"
                },
                "hasSeal": false
            },
            {
                "id": "a940f960-213c-4a89-403c-08defc11a479",
                "fileName": "Phu-luc-02.pdf",
                "downloadUrl": "{HOST}/api/Download?token=...",
                "downloadWatermarkMetadataUrl": "{HOST}/api/Download?token=...",
                "orderNo": 2,
                "size": 262757,
                "fileType": {
                    "value": 0,
                    "description": "General"
                },
                "hasSeal": false
            }
        ],
        "zipDownloadUrl": "{HOST}/api/Download/MergeFilesZipDocument?token=...",
        "zipDownloadOriginalUrl": "{HOST}/api/Download/MergeFilesZipDocument?token=...",
        "zipDownloadWatermarkMetadataUrl": "{HOST}/api/Download/MergeFilesZipDocument?token=...",
        "requiresSealSendConfirmation": false,
        "fixedPosition": false,
        "isLaborContractDocument": false
    },
    "success": true,
    "code": 0,
    "messages": [
    ]
}

Mô tả Response Body

Key	Type	Description
`success`	boolean	Trạng thái phản hồi của yêu cầu (true: Thành công, false: Thất bại)
`code`	int	Mã phản hồi từ hệ thống
`messages`	array	Danh sách thông báo hoặc lỗi trả về từ hệ thống
`data`	object	Đối tượng chứa thông tin chi tiết của chứng từ (xem chi tiết bên dưới)

Chi tiết dữ liệu trong `data`:

Các trường id, createdDate, lastModifiedDate, subject, description, status, contractStatus, type, downloadFileUrls, zipDownloadUrl, zipDownloadOriginalUrl, zipDownloadWatermarkMetadataUrl, processInOrder, processRecipientCount, processes... có ý nghĩa giống API Tạo chứng từ nhiều file (mục 4.1). Các trường createdByUser, waitingProcess, waitingProcesses có ý nghĩa giống API Gửi quy trình chứng từ (mục 4.4). Bảng dưới đây chỉ mô tả trường phát sinh mới khi tra cứu chi tiết chứng từ.

Key	Type	Description
`department`	object	Phòng/ban phát hành chứng từ (xem bên dưới)

Chi tiết đối tượng `department`:

Key	Type	Description
`id`	int	Id phòng/ban
`name`	string	Tên phòng/ban
`code`	string	Mã phòng/ban
`users`	array	Danh sách người dùng thuộc phòng/ban (rỗng trong dữ liệu mẫu)

Lưu ý

Response trả về đầy đủ thông tin chứng từ: thông tin phòng ban phát hành (department), người tạo (createdByUser), trạng thái hiện tại (status, contractStatus), danh sách file đính kèm (downloadFileUrls) và người đang chờ xử lý (waitingProcess).

API này phù hợp để đối tác tích hợp chủ động tra cứu/đồng bộ trạng thái chứng từ (thay vì chờ callback/webhook), đặc biệt hữu ích ngay sau khi gọi API Gửi quy trình (mục 4.4) để xác nhận chứng từ đã chuyển đúng trạng thái mong muốn.

Mục đích​

Mẫu request​

Mẫu response body​

Mô tả Response Body​

Chi tiết dữ liệu trong data:​

Chi tiết đối tượng department:​