Get document by Id

Updated date: 25/02/2025
Updated by: VNPT eContract's team

---

Purpose

The function retrieves detailed information of a document based on its ID. In case you want to search for multiple documents, please refer to Get list of documents

• Request URL: /api/documents/{id}
• HTTP method: GET
• Authorize: Bearer token
• Parameter:

Key	Type	Description
id	string	[Required] Id of document

Sample request

Id of document: id = "f877ee4c-eb23-4274-1eca-08dcd87b88c1"
Request: /api/documents/f877ee4c-eb23-4274-1eca-08dcd87b88c1

Sample response body

{
    "data": {
        "id": "f877ee4c-eb23-4274-1eca-08dcd87b88c1",
        "createdDate": "2024-09-25T10:56:27.4025434",
        "lastModifiedDate": "2025-02-25T09:28:21.0974161",
        "completedDate": "2025-02-25T09:28:21.0974181",
        "no": "42/PTTT",
        "subject": "Test document for the Electronic Document Management Service",
        "hasVerified": false,
        "hasVerify": false,
        "status": {
            "value": 4,
            "description": "Completed"
        },
        "contractStatus": {
            "value": 0,
            "description": "Undefined"
        },
        "department": {
            "id": 2061,
            "name": "Market Development Department",
            "code": "PTTT",
            "users": [
            ]
        },
        "createdByUser": {
            "id": 10287,
            "code": "ChauChau",
            "name": "KAMONWAN SIVARAKSA",
            "email": "thuychaunguyen98@gmail.com",
            "phone": "0817XXXXXX",
            "comId": 2211
        },
        "createdByUserId": 10287,
        "reason": "Reject the document due to incorrect contract number.",
        "processRecipientCount": 1,
        "waitingProcesses": [
        ],
        "processInOrder": true,
        "isWaitToSignDraw": false,
        "isWaitToSignDigital": false,
        "isWaitToApprove": false,
        "isWaitToFillData": false,
        "isWaitToCoordinate": false,
        "isWaitToESign": false,
        "isWaitToEkyc": false,
        "isFillable": false,
        "type": {
            "id": 2057,
            "code": "TEST",
            "name": "Test document for services",
            "description": "Test document",
            "documentCount": 1,
            "children": [
            ]
        },
        "batchImport": {
            "id": 5714,
            "createdDate": "2024-09-25T10:56:21.7197004",
            "uploadedByUserId": 10287,
            "uploadedByUser": {
                "id": 10287,
                "code": "ChauChau",
                "name": "KAMONWAN SIVARAKSA",
                "email": "thuychaunguyen98@gmail.com",
                "phone": "0817XXXXXX",
                "comId": 2211
            },
            "numberOfRecords": 1,
            "name": "Batch import break page CNCL",
            "status": {
                "value": 999,
                "description": "Process sent"
            },
            "documents": [
                null
            ],
            "errors": [
            ]
        },
        "processes": [
            {
                "id": "7845eaf3-b73b-4fa4-b11c-08dd2df53ec0",
                "lastModifiedDate": "2025-01-06T08:55:49.8230006",
                "createdDate": "2024-09-25T10:56:27.4024352",
                "comId": 2211,
                "isOrder": true,
                "orderNo": 1,
                "signatureText": "KAMONWAN SIVARAKSA\r\nC=VN,ST=TP Hồ Chí Minh,L=Quận 3,CN=Nguyen Thuy Chau,UID=id:10287\r\nĐồng ý ký nháy\r\n25/02/2025 9:28:20 SA +07:00",
                "reason": "Agree with the content for signing",
                "pageSign": 1,
                "position": "13,688,193,778",
                "fontSize": 8,
                "displayType": {
                    "value": 2,
                    "description": "Text and image"
                },
                "signedMethod": {
                    "value": 2,
                    "description": "VNPT SmartCA"
                },
                "accessPermission": {
                    "value": 2,
                    "description": "Sign draw"
                },
                "status": {
                    "value": 3,
                    "description": "Signed"
                },
                "processedDate": "2025-02-25T09:28:21.089046",
                "processedByUserId": 10287,
                "processedByUser": {
                    "id": 10287,
                    "code": "ChauChau",
                    "name": "KAMONWAN SIVARAKSA",
                    "email": "thuychaunguyen98@gmail.com",
                    "phone": "0817XXXXXX",
                    "comId": 2211
                },
                "documentId": "f877ee4c-eb23-4274-1eca-08dcd87b88c1",
                "fillingItems": [
                ]
            },
            {
                "id": "fb8cb263-ae46-4ec3-b11e-08dd2df53ec0",
                "lastModifiedDate": "2025-01-06T08:55:49.8234033",
                "createdDate": "2024-12-13T11:14:03.5506869",
                "comId": 2211,
                "isOrder": true,
                "orderNo": 2,
                "displayType": {
                    "value": 0,
                    "description": "0"
                },
                "accessPermission": {
                    "value": 1,
                    "description": "View only"
                },
                "status": {
                    "value": 1,
                    "description": "Waiting"
                },
                "processedByUserId": 8252,
                "processedByUser": {
                    "id": 8252,
                    "code": "IT02756",
                    "name": "Nguyen Thuy Chau",
                    "email": "email_address",
                    "phone": "0817XXXXXX",
                    "comId": 2211
                },
                "documentId": "f877ee4c-eb23-4274-1eca-08dcd87b88c1",
                "fillingItems": [
                ]
            }
        ],
        "accessibleViewProcesses": [
        ],
        "histories": [
            {
                "createdDate": "2024-09-25T10:56:27.4024537",
                "requestType": {
                    "value": 0,
                    "description": "Web"
                },
                "ipAddress": "123.25.190.41",
                "user": {
                    "id": 10287,
                    "code": "ChauChau",
                    "name": "KAMONWAN SIVARAKSA",
                    "email": "email_address",
                    "phone": "0817XXXXXX",
                    "comId": 2211
                },
                "activity": {
                    "value": 1,
                    "description": "Create document"
                }
            },
            {
                "createdDate": "2024-09-25T10:56:40.6895006",
                "requestType": {
                    "value": 0,
                    "description": "Web"
                },
                "ipAddress": "123.25.190.41",
                "user": {
                    "id": 10287,
                    "code": "ChauChau",
                    "name": "KAMONWAN SIVARAKSA",
                    "email": "email_address",
                    "phone": "0817XXXXXX",
                    "comId": 2211
                },
                "activity": {
                    "value": 3,
                    "description": "Invite recipient"
                }
            }
        ],
        "attachments": [
        ],
        "relatedDocuments": [
        ],
        "linkedDocuments": [
        ],
        "messages": [
            {
                "createdDate": "2024-12-11T14:45:42.4977745",
                "content": "Agree with document content",
                "senderId": 10287,
                "sender": {
                    "id": 10287,
                    "code": "ChauChau",
                    "name": "KAMONWAN SIVARAKSA",
                    "email": "email_address",
                    "phone": "0817XXXXXX",
                    "comId": 2211
                }
            }
        ],
        "file": {
            "name": "IT2.CKDS2025.VNPT-IT2.5EWU.pdf",
            "size": 153554
        },
        "downloadUrl": "{HOST}/Api/Download?token=...",
        "downloadOriginalUrl": "{HOST}/Api/Download?token=...",
        "downloadWatermarkMetadataUrl": "{HOST}/Api/Download?token=...",
        "fillingItems": [
        ],
        "sharedUsers": [
        ],
        "isMarkStar": false
    },
    "success": true,
    "code": 0,
    "messages": [
    ]
}