Request processing for a document

POST /v1/[tenant_id]/documents
The api responds with a document id and other information regarding the on-going processing of the included files.

Request

Parameters

Name Value
tenant_id Add your tenant_id to every request URL.

Headers

Name Value
Content-Type application/vnd.api+json
Authorization Bearer [Your API Token]

Payload

Name Value  
urls Array of Strings This is an array of URLs, which will be downloaded for processing.
base64_files Array of Strings As an alternative to a list of URLs, files can be delivered as an array of base64 encoded strings.
custom_fields Hash If you want to provide custom fields for further processing.
document_type String If you already know the document type, or want to force it, set this attribute to skip classification.
extract_line_items Boolean Whether Line Items should be extracted or not, defaults to false

Example Request Body

{
  "data": {
    "type": "documents",
    "attributes": {
      "urls": ["https://www.domain.com/download/invoice-1234.pdf"],

      // as an alternative to urls:
      "base64_files": ["JVBERi0xLjQNCiWhs8XXDQoxIDAgb2JqDQo8PC9Db3VudC..."]

      "custom_fields": { "customer_id": "1234" },

      "document_type": "receipt",
      "extract_line_items": true
    }
  }
}

Response

Example Response Body

Find out more about the datastructure of a document.

{
    "data": {
        "id": "236",
        "type": "document",
        "attributes": {
            "created_at": "2020-04-20T10:13:59.229Z",
            "updated_at": "2020-04-20T10:13:59.229Z",
            "custom_fields": { 
              "customer_id": "1234" 
            },
            "download_errors": null,
            "error_codes": [],
            "extraction_process": "full-extraction",
            "urls": null,
            "current_status": "processing",
            "document_type": "receipt",
            "enhanced_pdf": null,
            "previews": [],
            "signed_pdf": null,
            "thumbnail": null
        },
        "relationships": {
            "accounting_document": { "meta": { "included": false }},
            "sender_address": { "meta": { "included": false } },
            "receiver_address": { "meta": { "included": false } }
        }
    },
    "meta": {},
    "jsonapi": {
        "version": "1.0"
    }
}

Further information