Document Upload

The Upload Document API is used when multiple documents need to be uploaded and grouped within a single envelope. Each document is uploaded individually, generating a unique document_ids for each file. These document_ids can then be added to a single envelope via the Create Envelope API, enabling all documents to be signed collectively within the same transaction by one or more recipients

If the envelope only uses 1 document You can skip this step and continue to the Create Envelope API.

---

API Description

POST {environment-url}/document/external-api/rest/v1/document

---

Headers

Name	Type	Description
Content-Type*	String	multipart/form-data
Authorization*	String	Bearer Access Token Get the access token by calling the Authentication API

---

Request Body

Name	Type	Description
file*	File	Upload the file to the VIDA Sign Open Platform (max 50 MB, 500 pages).
creator_email*	String	Assign document to your member (email must be a registered member under the workspace)

---

Response Body

Document Upload Success

HTTP Status Code: 200

Status : SUCCESS

JSON Response:

{
    "success": true,
    "data": {
        "id": "{document_id}"
    }
}

Forbidden

HTTP Status Code: 403

Status : ERROR

JSON Response

{
    "message": "Unable to operate via the integration API.",
    "code": "ES.105011"
}

Bad Request - PDF Doesn't exist

Bad Request Incase of the PDF file

HTTP Status Code: 400

Status : ERROR

JSON Response

{
    "message": "File is empty.",
    "code": "ES.10508"
}

Bad Request - Large file size

Bad request Incase of large file size

HTTP Status Code: 400

Status : ERROR

JSON Response

{
    "code":"ES.10509",
    "message":"File upload too large"
}

Bad Request - Unsupported file type

Bad request Incase of unsupported file size

HTTP Status Code: 400

Status : ERROR

JSON Response

{
    "code":"ES.10505",
    "message":"Unsupported file types."
}

Bad Request - Invalid Parameter

Incase of invalid parameter. (eg: creator_email)

HTTP Status Code: 400

Status : ERROR

JSON Response

{
    "message": "Please enter a valid email address",
    "code": "MG.10303"
}

Bad Request - Invalid Data

The email id provided in the creator_email is not a member of the workspace.

HTTP Status Code: 400

Status : ERROR

JSON Response

{
    "message": "The `creator_email` is not a member of the current workspace.",
    "code": "MG.20707"
}

Bad Request - The document page number too large

HTTP Status Code: 400

Status : ERROR

JSON Response

{
    "code":"ES.1053",
    "message":"File page count should not be more than 500"
}