General format

Updated date: 30/04/2023
Updated by: VNPT eContract's team

---

In this document, we utilize the following conventions to facilitate clear and convenient presentation for content comprehension:

• All input/output parameters are formatted in camelCase (e.g., userName, cusCode, dayOfBirth...)
• All API responses follow the same protocol and adhere to the following conventions:

General conventions

Convention	Description	Example
Courier New	Code	{ "hasVerified": false, "fileName": "DocTemplate.docx" }
Bold	The content that needs to be emphasized	…request method POST
code	Parameter or parameter value, result	HTTP Method: POST

The sample response returned by the system includes the following information:

Key	Type	Description
data	object	The returned data is in the form of a JSON object, JSON array, or string.
success	boolean	Request success status true: success false: failure
code	int	Error code returned from the system: 0: Default 100: OTP confirmation required 401: Not authenticated
message	array string	Description of information from the system, or detailed error.

Sample response body

{
    "data": [
        {
            "id": 164,
            "name": "Công ty TNHH DH",
            "address": "42 Pasteur, P. Võ Thị Sáu, Quận 3, TP.Hồ Chí Minh",
            "taxCode": "0108212803-012",
            "createdDate": "2021-01-04T23:03:28.0149563",
            "status": {
                "value": 0,
                "description": "Active"
            }
        }
    ],
    "success": true,
    "code": 0,
    "messages": []
}