Documents

The purpose of the document is to track the overall processing status and attached files. It relates additional data like accounting documents and sender and receiever addresses. To get a complete picture, look at this example response.

Delivering documents

You can deliver documents for further processing. You deliver documents by providing download URLs. An array of URLs can be provided via the urls attribute, which is only available for submitting documents.

If you provide more than one document (ie single page PDFs or a few JPGs), they will be merged into one document.

Read this if you want to know about requirements and limitations of delivering files.

Attributes of documents

created_at The document creation date.  
updated_at The document update date.  
urls Array required Download URLs for documents which need to be processed (Only for creating new processing requests).
custom_fields Object Pass in custom fields on demand.
current_status String readonly This is the current status of the document.
previews Array readonly Low resolution previews of the document’s pages. Please refer to the JSON format for files below.
thumbnail String readonly Low resolution preview of the document, usually the same as the first page preview.
signed_pdf String readonly Processed PDFs are provided for download. These are the original PDFs, just signed. Please refer to the JSON format for files below. In case of encrypted PDFs the signing step is skipped and an unsigned PDF is returned instead. You will find the error code source_file_is_encrypted if this is the case.
enhanced_pdf String readonly Processed PDFs are provided for download. This version includes processing and adds search features of the PDF. Please refer to the JSON format for files below.
document_type String readonly This includes a document type that was detected, which you find here
error_codes Array readonly A list of error codes.
download_errors Array readonly A list of download_errors.
extraction_process String User either basic-extraction, self-validation or full-extraction to request a specific extraction method for this document. For Purchase to Pay, only full-extraction is allowed.
ocr_text String readonly This is a string containing all the text extracted during processing.

JSON Structure for files

This applies to previews (delivered as an array), as well as thumbnail, signed_pdf, and enhanced_pdf delivered as single file:

url The download url of the file.
file_name The file name of the file.
mime_type The mime type of the file.

Example:

previews: [
  {
    "url": "https://...",
    "file_name": "preview-123-1.jph",
    "mime_type": "image/jpeg"
  }
]