entrusted

Upload a document to sanitize

Changed on
post/api/v1/upload

Request

Request body application/x-www-form-urlencoded

filestring binary required

The document binary data

filenamestring required

The name of the document to process

ocrlangstring

Optional tesseract language code for optional character recognition (OCR). See https://tesseract-ocr.github.io/tessdoc/Data-Files-in-different-versions.html

docpasswdstring

Optional password for the encrypted Office or PDF document

visualquality'low' | 'medium' | 'high'

The desired PDF result visual quality

Response

Request accepted and queued for processing

request_idstring

Request system identifier encoded in base58 format.

The underlying value follows the format base64_fileuuid;base64_filename.

This helps set a reasonable output file name once the file is ready for download later.

tracking_uristring

URI location for fetching processing notifications

Example response

[
  {
    "request_id": "USm3fpXnKG5EUBx2ndxBDMPVciP5hGey2Jh4NDv6gmeo1LkMeiKrLJUUBk6Z",
    "tracking_uri": "/events/USm3fpXnKG5EUBx2ndxBDMPVciP5hGey2Jh4NDv6gmeo1LkMeiKrLJUUBk6Z"
  }
]

Changes