Request processing for a document

POST /api/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 This is an array of URLs, which will be downloaded for processing.  
custom_fields If you want to provide custom fields for further processing.  
extraction_process String User either basic-extraction, full-extraction or robo-accounting to request a specific extraction method for this document.

Example Request Body

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

Response

Example Response Body

Find out more about the datastructure of a document.

{
    "data": {
        "id": "236",
        "type": "documents",
        "attributes": {
            "created_at": "2018-08-20T10:13:59.229Z"
            "updated_at": "2018-08-20T10:13:59.229Z"
            "custom_fields": {
                "customer_id": "1234"
            },
            "status": "pending",
            "extraction_process": "basic_extraction",
            "signed_pdf": null
        },
        "relationships": {
        }
    },
    "jsonapi": {
        "version": "1.0"
    }
}

Further information