Upload

POST

files

upload

Upload

curl --request POST \
  --url https://sandbox.syngrafii.com/api/v1/files/upload \
  --header 'api_key: <api-key>'

const options = {method: 'POST', headers: {api_key: '<api-key>'}};

fetch('https://sandbox.syngrafii.com/api/v1/files/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.syngrafii.com/api/v1/files/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.syngrafii.com/api/v1/files/upload"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.syngrafii.com/api/v1/files/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "files": [
    {
      "fileId": "<string>",
      "externalId": "<string>",
      "fileName": "<string>",
      "isInvalid": true,
      "isConverted": true,
      "isNotSupported": true,
      "isPasswordProtected": true,
      "error": "<string>",
      "message": "<string>",
      "type": "<string>"
    }
  ]
}

Upload one or more files to be signed. Save the returned fileId or externalId for use in future API requests.

Post the raw file (do not convert to base64) with a Content-Type of application/pdf for PDF or application/octet-stream for DOCX.

You must add a Content-Disposition header with the filename to allow any of the supported file conversions to PDF.

Request

PDF
DOCX
UTF-8

Request

POST /files/upload
Content-Type: multipart/form-data

Content-Disposition: form-data; filename="document.pdf"
Content-Type: application/pdf

<FILE_CONTENTS>

Request

POST /files/upload
Content-Type: multipart/form-data

Content-Disposition: form-data; filename="document.docx"
Content-Type: application/octet-stream

<FILE_CONTENTS>

Request

POST /files/upload
Content-Type: multipart/form-data

Content-Disposition: form-data; filename*=UTF-8''r%C3%A9sum%C3%A9.pdf
Content-Type: application/pdf

<FILE_CONTENTS>

Query parameters

string

default:"temporary"

Value	Description
temporary	The file will be stored temporarily and deleted if not added to a package within 24 hours.

string

Provide an external ID that can be used to reference the file.This externalId will be stored with the document during packages/add request. It will then be included in future:

packages/status requests
document webhook events

If a user replaces a document after the package was created the externalId will no longer be associated with the document.

Response

object[]

List of uploaded files with their statuses.

Show properties

string

Unique identifier for the uploaded file.

string

External system identifier for the file, if available.

string

Original filer name of the uploaded file.

boolean

Indicates if the file is invalid or corrupted.

boolean

Indicates if the file was successfully converted to the required format.

boolean

Indicates if the file type is not supported.

boolean

Indicates if the file is password protected.

string

Error code or message related to the file upload or processing.

string

Additional message or details about the file status.

string

Type of stored file.

Value	Description
temporary	The file will be stored temporarily and deleted if not added to a package within 24 hours.

Errors

PDF Error: PDF header not found.If a PDF Error: PDF header not found. error is returned, make sure you are sending the file as binary data.

Notes

Encoding filename using UTF-8Replace filename (ISO-8859-1) in Content-Disposition header with filename*=UTF-8”

Place two separate single quotes after the UTF-8, not one double quote.
You must URL Encode the filename to escape the UTF-8 characters and any whitespaces.
Do not wrap the encoded filename with double quotes.
Do not add a semicolon after the encoded filename.

Examplerésumé.pdf filename*=UTF-8''r%C3%A9sum%C3%A9.pdfFor more information, refer to RFC 5987

⌘I

Upload

curl --request POST \
  --url https://sandbox.syngrafii.com/api/v1/files/upload \
  --header 'api_key: <api-key>'

const options = {method: 'POST', headers: {api_key: '<api-key>'}};

fetch('https://sandbox.syngrafii.com/api/v1/files/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.syngrafii.com/api/v1/files/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.syngrafii.com/api/v1/files/upload"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.syngrafii.com/api/v1/files/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "files": [
    {
      "fileId": "<string>",
      "externalId": "<string>",
      "fileName": "<string>",
      "isInvalid": true,
      "isConverted": true,
      "isNotSupported": true,
      "isPasswordProtected": true,
      "error": "<string>",
      "message": "<string>",
      "type": "<string>"
    }
  ]
}

Getting started

Guides

API

Webhooks

Reference

Request

Query parameters

Response

Errors

Notes

​Request

​Query parameters

​Response

​Errors

​Notes

Request

Query parameters

Response

Errors

Notes