Upload File API Reference

This defines the Upload File API:

• Request - File upload.
• Response - ensure that your request to the Fax API was successful.

Request

A Fax API request looks like:

This request contains:

• Parameters
• Authentication information
• Security
• Encoding

Parameters

The following table shows the parameters you use in the request:

Authentication information

The following table shows the information for authentication:

You find your Key in Dashboard.

Security

To ensure privacy, you must use HTTPS for all Faxto API requests.

Encoding

You submit all requests with a POST or GET call using UTF-8 encoding and URL encoded values. The expected Content-Type is multipart/form-data.

Response

We support JSON ONLY responses

{
  
	"status": "Success",
	"document_id": 300,
	"total_pages": 1,
	"document": {
	"filename": "598317a8404bd.pdf.tiff",
	"filename_uploaded": "verify.txt",
	"orig_filename": "598317a8404bd.pdf",
	"file_extension": "txt",
	"total_pages": 1,
	"filesize": 3650,
	"preview_in_storage": 1,
	"preview_file": "598317a8404bd.pdf.preview.jpg",
	"preview_image": null,
	"s3": null,
	"user_id": 2,
	"updated_at": "2017-08-03 12:31:38",
	"created_at": "2017-08-03 12:31:38",
	"id": 300
	}
}
	

Keys and Values

Response Messages