Getting Started

To get started with our API, we provide comprehensive documentation on how to consume our API. Our API implementation follows the JSON API Standard. We suggest to have a look at that first, if you are unfamilliar with that.

Making requests - in a nutshell

All requests you send to our API follow the same schema.

1. Get your access key

After signing in, you can create API keys in the Developer module.

2. Add request headers

Don’t forget to add these headers for every request you submit to the API.

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

Find out more about authentication and authorization.

3. Submit a request to our API

If you want to talk to our Parashift Document Center API, use the following base url and choose either one of these requests.

Base URL: https://extraction.api.parashift.io

POST Upload a new document
GET Request a specific document
GET Query documents

4. How to test API calls

Our preferred tool to test any API communication is Postman.

Alternatively, the comand line tool curl can be used as follows:

curl --location --request GET 'https://extraction.api.parashift.io/v1/YOURTENANTID/documents/YOURDOCUMENTID?include=accounting_document,sender_address,receiver_address'
--header 'content-type: application/vnd.api+json' \
--header 'authorization: Bearer YOURAPIKEY'

or

curl --location --request POST 'https://extraction.api.parashift.io/v1/YOURTENANTID/documents' \
--header 'content-type: application/vnd.api+json' \
--header 'authorization: Bearer YOURAPIKEY' \
--data-raw '{
  "data": {
    "type": "documents",
    "attributes": {
    // Specify your own custom fields. These cannot be changed in the extraction process but will be saved to the document as fixed values.
    // "custom_fields": { "TestType": "normal, auto classification" },
    
    // Specify if line items should be extracted in the P2P process (additional cost per line item)
    // Default: false
    "extract_line_items": true,
    
    //Specify if a fixed document type is set, otherwise classification on P2P document types is done by Parashift
    // Default is auto classification through Parashift
    // "document_type": "receipt",
    
    // Document as base64 string
      "base64_files": ["YOUR BASE64 ENCODED FILE"]
    }
  }
}'

What next?

To implement our API, we suggest to read through our documentation. Some examples you might find useful:

Support

Finally, if you have any questions… Feel free to get in touch, we’re happy to help.