Skip to main content
Version: 2.3.0

Send Import Batch Document Process

Last updated: August 18, 2026 Updated by: VNPT eContract's team


Purpose​

Trigger the sign/approval process for all documents that were created in the import batch in step 7.4.

The response returns the full details of the import batch after sending: status changes to "Process sent", along with a documents list (the documents in the batch), where waitingProcess shows information about the person currently waiting to process the next step in the signing workflow.

  • Request URL: /api/batch-imports/send/{batchImportId}
  • HTTP method: POST
  • HTTP content-type: application/json
  • Authorize: Bearer token
  • Parameters:
KeyPositionTypeRequiredDescription
batchImportIdPath paramintYesImport batch ID returned by the API in section 7.4 (e.g., /api/batch-imports/send/22945)
batchImportIdBodyintYesMust match the value of the path param, based on actual test data
caution

Note: the request body repeats batchImportId, which is already present in the path — this should be confirmed with the development team to determine whether one of the two can be removed, or whether this is a required part of the current API design.

In addition, test results show that this API may involve a short backend processing delay due to its asynchronous nature. Integration partners should apply a reasonable retry/timeout mechanism and combine it with checking the import batch status when calling this API.

Sample Request​

{
"batchImportId": 22945
}

Sample Response — HTTP 200​

{
"data": {
"id": 22945,
"createdDate": "2026-08-05T13:21:56.0319878",
"uploadedByUserId": 27938,
"uploadedByUser": {
"id": 27938,
"code": "trinhttv",
"name": "Tran Thi Viet Trinh",
"email": "trinhttv@vnpt.vn",
"username": "trinhttv@vnpt.vn"
},
"numberOfRecords": 1,
"name": "Fixed-term labor contract batch import HDLD-NVC-20260805062154B",
"documentType": {
"id": 8950,
"code": "HDLD",
"name": "Labor contract",
"documentCount": 1,
"enableVnptSeal": false,
"requireVerifiedUserSigning": false,
"children": []
},
"status": {
"value": 999,
"description": "Process sent"
},
"documents": [
{
"id": "367fe4a4-1d85-489a-bc8e-5ab2ec42b222",
"no": "HDLD-NVC-20260805062154B",
"subject": "Labor contract - Nguyen Van Cuong 154B",
"status": {
"value": 2,
"description": "Ready"
},
"contractStatus": {
"value": 1,
"description": "Contract valid"
},
"processRecipientCount": 2,
"waitingProcess": {
"id": "0f0ad3cb-6aaa-4dea-b8f1-4c387f15f3d2",
"orderNo": 1,
"displayType": {
"value": 2,
"description": "Text and image"
},
"accessPermission": {
"value": 2,
"description": "Sign draw"
},
"status": {
"value": 1,
"description": "Waiting"
},
"processedByUser": {
"id": 70400,
"code": "BAOTH",
"name": "To Hoai Bao",
"email": "baoth@vnpt.vn",
"username": "baoth@vnpt.vn"
}
},
"downloadUrl": "http://10.70.100.213:2036/Api/Download?token=<truncated...>"
}
],
"errors": [],
"importType": {
"value": 3,
"description": "Labor contracts created from templates"
}
},
"success": true,
"code": 0,
"messages": [
"Send batch document success"
]
}
note

Some secondary fields within each document object (such as histories, attachments, fillingItems, etc.) have been omitted from the sample response above for readability.

Response Parameters​

KeyTypeDescription
dataobjectDetailed information about the import batch after the signing process has been sent (see details below)
successbooleanRequest processing status (true: Success, false: Failed)
codeintResponse status code
messagesarrayList of processing result messages from the system

Details of the data object in the response:​

KeyTypeDescription
idintImport batch ID (BatchImportId)
createdDatestringBatch creation time (ISO 8601 format)
uploadedByUserIdintID of the user who uploaded the batch
uploadedByUserobjectDetails of the user who uploaded the batch (id, code, name, email, username)
numberOfRecordsintTotal number of contract records in the import batch
namestringName of the import batch
documentTypeobjectDocument type information (id: 8950, code: HDLD, name: Labor contract, ...)
statusobjectBatch processing status (value: 999, description: Process sent)
documentsarrayList of documents for which the process has been initiated in the batch (see below)
errorsarrayList of error messages, if any
importTypeobjectImport type (3: Labor contracts created from templates)

Details of each object in the documents array:​

KeyTypeDescription
idstringDocument GUID
nostringContract/document number
subjectstringDocument title
statusobjectDocument status (value: 2, description: Ready)
contractStatusobjectContract status (value: 1, description: Contract valid)
processRecipientCountintTotal number of participants in the signing process
waitingProcessobjectInformation about the step currently pending processing (see below)
downloadUrlstringDownload link for the document file

Details of the waitingProcess object in documents:​

KeyTypeDescription
idstringGUID of the processing step
orderNointOrder of the step in the signing process (1: First step)
displayTypeobjectDisplay format (value: 2, description: Text and image)
accessPermissionobjectProcessing permission (value: 2, description: Sign draw)
statusobjectStep status (value: 1, description: Waiting)
processedByUserobjectInformation about the user required to sign/approve at this step (id, code, name, email, username)