Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Getting started with our API: document upload

Main structuring elements of our solution

Chances are you have been given access to a tenant on our solution. This could be in a multi-tenant or single-tenant set-up, depending on the option you have selected. Either way, the name of your tenant will be the first part of the url to which you navigate to interact with our APIs or web portal, e.g., https://tenant.contract-p.fit

For your tenant, you will be able to configure multiple projects, e.g.,

  • Email routing for customer support

  • Invoice processing for the finance department

A project will specify the document types you are interested in (e.g., identity cards, invoices) and the fields of interest (e.g., first name, invoice number) in those document types. This is defined in a format and a project will support one or more formats.

Each project can then have multiple inboxes. An inbox is a logical grouping of files which allows you to control access and various settings.

Each inbox can have multiple files. A file can be an email, image, pdf, office document, zip file, … essentially anything that you could print, you can upload to an inbox in our solution.

...