/documents

Document

This is an entity representing a document which passed through our analysis process. A document is either an image and the data associated with it. So you will get many informations about it, including meta data on how process went, and data detected

get

Get the list of documents by filters

post

Request to create a new document

post

Request to check the quality of an image

post

Reprocess documents by filter

get

Get the document as formatted data

delete

Delete the document

get

Render the image corresponding to the document

/campaigns

Campaign

Campaign represents a promotion campaign valid during a certain period of time and linked to a set of rules that have to be matched during receipt analysis. Any document that goes through a campaign will be checked against the set of rules (detection of things in the document) that are specified within the campaign.

get

Get the list of campaigns by filters

post

Create a new campaign

get

Get statistics of campaigns by filters

get

Get campaign's information

patch

Update data of a campaign

delete

Delete the campaign and document(s) related

get

Export a zip Archive containing CSV of documents and items in documents.

post

Reprocess documents by filter

get

Get the list of documents by filters

post

Add document for a given campaign

/endpoints

Endpoints

Represent an access point for a given set of documents (image with data), you can send document to an endpoint and retrieve data extracted from it from this endpoint. An Endpoint can have document linked to a mobile application and / or to a promotion campaign.

get

Get the list of endpoints by filters

post

Create a new endpoint

patch

Update informations about outgoing url

get

Get endpoint's informations

delete

Delete the endpoint and all document(s) related

get

Export a zip Archive containing CSV of documents and items in documents.

post

Reprocess documents by filter

get

Get the list of documents by filters

post

Add document for a given endpoint

/whoami

get

Get the list of all companies