File Clean API Reference

This defines the File Clean API:

  • Request - to clean file.
  • Response - ensure that your request to the File Clean API was successful.

Request

A File Clean API request looks like:

https://fax.to/api/v2/file-clean?document_id=DOCUMENT_ID&api_key=API_KEY

This request contains:

Parameters

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

Parameter Description Required
document_id Your document_id. For example document_id=327. Yes.

Authentication information

The following table shows the information for authentication:

Parameter Description Required
api_key Your Key. For example, api_key=f@x2r0ckkz. Yes.

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.

Response

We support JSON ONLY responses


{
      "status": "success",
      "user_id":1,
      "created date": "2017-08-29 07:18:05",
      "id": 327,
      "filename": "59a5152b95cc1.pdf.tiff",
      "orig_filename": "59a5152b95cc1.pdf",
      "preview_file": "9a5152b95cc1.pdf.preview.jpg",
      "preview_image":null,
      "preview_in_storage":1,
      "file_extension":"pdf",
      "filename_uploaded":"pdf-sample.pdf",
      "filesize":"485432",
      "s3": null,
      "server_document_id": null,
      "team_user_id": null,
      "total_pages":1,
      "updated_at":"2017-08-29 07:18:05",
    }

Keys and Values

Key Value Response Type
status The status of the API request JSON

Response Messages

HTTP Status Code Reason
200 Successful response
401 Unauthorized.
403 Rate limit exceeded
404 Resource not Found
500 Internal server error