Upload File Request (POST /v2.0/envelopes/upload_file)
This method uploads a file (similar to the process Step 1 in the web application).
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Body (Form Data)
| Field | Type | Required | Description |
|---|---|---|---|
| File | File | Yes | The file to upload |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | The returned message |
Response Body Data Fields
| Field | Always Preset |
|---|---|
| request_id | Yes |
Sample Success Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/upload_file' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \ --form 'File=@"/C:/Invoice.pdf"'
RESPONSE:
{
"message": "",
"data": {
"request_Id": "f2e4f43a-4dfb-4967-bd05-fb4bb90e77bc"
}
}
Sample Error Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/upload_file' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \ --form 'File=@"/path/to/file"'
RESPONSE:
{
"errors": [
{
"error_code": "FILE_REQUIRED", "
developer_message": "File is required"
}
]
}
Note: View the full list of applicable error code for this method here.