Document

Get Documents

POST https://api-app.xtracta.com/v1/documents

(*) mandatory
(*1) one of them must be supplied

api_key

document_id

workflow_id

any_user_documents*

document_status no value pre-processing indexing qa reject output output-in-progress api-ui-in-progress prelearning learning

api_download_status no value active archived

page

items_per_page

documents_order no value asc desc

detailed no value 1 for detailed data on document list

locations no value 1 to get field value locations

deleted no value 1 to show only deleted documents

days_to_check

---

* If passing user's api key; pass 1 in any_user_documents to get the documents uploaded by any user, pass 0 to get only the documents uploaded by the current user.

Display response in the following format

XML JSON

Update Document

POST https://api-app.xtracta.com/v1/documents/update

(*) mandatory

api_key

document_id

new_workflow_id

api_download_status no value active archived

document_status no value indexing qa reject output re-extract re-ocr (does re-extraction too) complete-reprocess learning

reason

free_form

delete no value 0 restore document 1 delete document

field_data Insert Sample Data Insert Sample Learning Data

validation no value 1 run validation

learning no value 1 Let Xtracta learn the extraction by this update

user_email

user_id

---

The parameter user_email has higher priority than param user_id.

Display response in the following format

XML JSON

Upload Document

POST https://api-app.xtracta.com/v1/documents/upload

(*) mandatory

api_key

workflow_id

batch_id

field_data Insert Sample Data Insert Sample Learning Data

userfile The file to upload - If you do not attach the file, the API will return a URL to upload the file to. If multiple "userfile"s are uploaded, they will be merged into one PDF file before being processed. The maximum number of files that can be uploaded in a single request is 110, and the maximum request size is 110M.

userfile_url If userfile is not specified, the API checks if you have provided an URL of the file. The additional files will be merged with the first file generating one big file for processing.

learning no value 1 Let Xtracta learn the extraction by this upload Uploaded files will not appear in Xtracta. This flag should be used with field_data parameter.

---

Display response in the following format

XML JSON

Open Document UI

POST https://api-app.xtracta.com/v1/documents/ui

(*) mandatory

api_key

document_id

expire

callback_url

after_api_download_status no value active archived api_download_status will be what you specified here after saving

no_lockout no value 1 - force open the document in case someone else has it opened already

free_form

buttons (save,output,indexing,qa,reject,archive,delete,save_and_learn)

user_email

user_id

field_options Insert Sample Data

version no value - The default Engine Learning Screen (ELS) of API Key’s group 1 - to open in classic ELS 2 - to open in new ELS

---

The parameter user_email has higher priority than param user_id.

Display response in the following format

XML JSON

Open Document Upload UI

POST https://api-app.xtracta.com/v1/documents/upload/ui

(*) mandatory

api_key

workflow_id

expire

---

Display response in the following format

XML JSON

Open Reassign pages

POST https://api-app.xtracta.com/v1/documents/reassign_pages

(*) mandatory

api_key

source_document_id

source_pages

target_type new existing

target_document_id

target_position

---

Display response in the following format

XML JSON

Tracking

Get Tracking

POST https://api-app.xtracta.com/v1/tracking

(*) mandatory
(*1) one of them must be supplied

api_key

workflow_id

document_id

status no value ok error blank resolved

type no value email ftp web api

page

items_per_page

start_datetime

end_datetime

time_covers no value (default is TimeReceived) TimeReceived TimeActivity

order no value asc desc

timezone

detailed no value 1 Get processing activities and email details

learning no value 1 to show only learning documents 2 to show all documents excluding learning documents

---

Display response in the following format

XML JSON

Update tracking status

POST https://api-app.xtracta.com/v1/tracking/resolve

(*) mandatory

api_key

input_id

---

Display response in the following format

XML JSON

Dashboard

Open Dashboard

POST https://api-app.xtracta.com/v1/documents/ui

(*) mandatory

api_key

workflow_id

document_status no value indexing qa reject

fields Only lower letters, dash(-) and underscore(_) are used, spaces need to be replaced by underscore (e.g. po,invoice_gst_amount)

expire

document expire

no_lockout no value 1 force to open the document in case of someone's opened already and there will be no warning when closing by browser's button

page

items_per_page

documents_order no value asc desc

buttons (save,output,indexing,qa,reject,archive,delete,save_and_learn)

---

Display response in the following format

XML JSON

Open Tracking Dashboard

POST https://api-app.xtracta.com/v1/tracking/ui

(*) mandatory
(*1) one of them must be supplied

api_key

workflow_id

document_id

status no value ok blank

type no value email ftp web api

expire

page

items_per_page

start_datetime

end_datetime

time_covers no value (default is TimeReceived) TimeReceived TimeActivity

order no value asc desc

timezone

learning no value 1 to show only learning documents

---

Display response in the following format

XML JSON

Database

Get databases

POST https://api-app.xtracta.com/v1/databases

(*) mandatory

api_key

group_id

database_id

database_name

---

Display response in the following format

XML JSON

Add database

POST https://api-app.xtracta.com/v1/databases/add

(*) mandatory

api_key

database_name

group_id

---

Display response in the following format

XML JSON

Update database

POST https://api-app.xtracta.com/v1/databases/update/

(*) mandatory

api_key

database_id

database_name

---

Display response in the following format

XML JSON

Delete database

POST https://api-app.xtracta.com/v1/databases/delete

(*) mandatory

api_key

database_id

---

Display response in the following format

XML JSON

Get columns

POST https://api-app.xtracta.com/v1/databases/columns

(*) mandatory

api_key

database_id

column_id

column_name

group_id

---

Display response in the following format

XML JSON

Add column

POST https://api-app.xtracta.com/v1/databases/column_add

(*) mandatory

api_key

database_id

column_name

---

Display response in the following format

XML JSON

Update column

POST https://api-app.xtracta.com/v1/databases/column_update

(*) mandatory

api_key

column_id

column_name

---

Display response in the following format

XML JSON

Delete column

POST https://api-app.xtracta.com/v1/databases/column_delete

(*) mandatory

api_key

column_id

---

Display response in the following format

XML JSON

Get data

POST https://api-app.xtracta.com/v1/databases/data

(*) mandatory

api_key

database_id

column_id

row

type

limit

offset

conditions

---

Display response in the following format

XML JSON

Add data

POST https://api-app.xtracta.com/v1/databases/data_add

(*) mandatory

api_key

database_id

data Insert Sample Data

refresh no value 1 Clear all existing data before adding

---

Display response in the following format

XML JSON

Update data

POST https://api-app.xtracta.com/v1/databases/data_update

(*) mandatory

api_key

database_id

data Insert Sample Data

---

Display response in the following format

XML JSON

Delete data

POST https://api-app.xtracta.com/v1/databases/data_delete

(*) mandatory
(*1) or (*2) must be supplied

api_key

database_id

row

column_id

---

Display response in the following format

XML JSON

Provisioning

Provision

POST https://api-app.xtracta.com/v1/provisioning/provision

Provisions a new "client" with a group, workflow(s) and/or database(s) based on the templates linked to the profile used.

(*) mandatory
(*1) one of them must be supplied

api_key

provisioning_key

profile_id

identifier

group_name The name of the new group that will be created. Usually the client's name. Identifier will be used if this isn't specified.

group_id The group in which the account will be provisioned. This will default to the top level for the API key or provisioning key if not passed. This is generally not required for most instances as the API/provisioning key are at the direct level you wish to provision under.

input_account

---

Display response in the following format

XML JSON

Billing

Get Plans

POST https://api-app.xtracta.com/v1/billings

(*) mandatory
(*1) one of them must be supplied

api_key

group_id

plan_id

pack_id

is_parent

---

Display response in the following format

XML JSON

Get Usage

POST https://api-app.xtracta.com/v1/billings/usage

(*) mandatory

api_key

group_id

---

Display response in the following format

XML JSON

Get Billing History

POST https://api-app.xtracta.com/v1/billings/history

(*) mandatory

api_key

group_id

billing_from

billing_to

recursive

---

Display response in the following format

XML JSON

Renew/Upgrade/Downgrade Plan

POST https://api-app.xtracta.com/v1/billings/update

(*) mandatory

api_key

group_id

plan_id

purge

---

Display response in the following format

XML JSON

Order Pack

POST https://api-app.xtracta.com/v1/billings/booster

(*) mandatory

api_key

group_id

pack_id

quantity

purge

---

Display response in the following format

XML JSON

Open Billing UI

POST https://api-app.xtracta.com/v1/billings/billing_ui

(*) mandatory

api_key

purge

expire

---

Display response in the following format

XML JSON

Workflow

Get Workflow

POST https://api-app.xtracta.com/v1/workflow

(*) mandatory

api_key

group_id

workflow_id

workflow_name

recursive 1 - Get workflows belonging to the current group and all subgroups recursively (default) 0 - Only get workflows belonging to the current group

---

Display response in the following format

XML JSON

Update Workflow

POST https://api-app.xtracta.com/v1/workflow/update

(*) mandatory

api_key

workflow_id

user_ids

new_group_id

settings Insert Sample Data

---

Display response in the following format

XML JSON

Add Workflow from template

POST https://api-app.xtracta.com/v1/workflow/add_from_template

(*) mandatory

api_key

workflow_template_id

workflow_name

group_id

input_account

db_links 1 to create new database(s) structures and a new workflow with the relevant links (default). 0 to create a new workflow without the database linked rules.

---

Display response in the following format

XML JSON

Clone Workflow

POST https://api-app.xtracta.com/v1/workflow/clone

(*) mandatory

api_key

workflow_id

workflow_name

group_id

input_account

db_links 1 to create new database(s) structures and a new workflow with the relevant links (default). 0 to create a new workflow without the database linked rules.

---

Display response in the following format

XML JSON

Group

Add group

POST https://api-app.xtracta.com/v1/group/add

(*) mandatory

api_key

group_id

group_name

inactivity_limit

password_expiry

block_password_reuse

---

Display response in the following format

XML JSON

List group

POST https://api-app.xtracta.com/v1/group/list

(*) mandatory

api_key

group_id

---

Display response in the following format

XML JSON

Delete group

POST https://api-app.xtracta.com/v1/group/delete

(*) mandatory

api_key

group_id

---

Display response in the following format

XML JSON

User

Get User

POST https://api-app.xtracta.com/v1/user

Get User

(*) mandatory

api_key

group_id

workflow_id

---

Display response in the following format

XML JSON

Add User

POST https://api-app.xtracta.com/v1/user/add

(*) mandatory

api_key

name

email_address

password it will be generated and returned if not specified

group_id

workflow_ids

token_expire

---

Display response in the following format

XML JSON

Update User

POST https://api-app.xtracta.com/v1/user/update

(*) mandatory

api_key

user_id

name

email_address

password

---

Display response in the following format

XML JSON

Delete User

POST https://api-app.xtracta.com/v1/user/delete

(*) mandatory

api_key

user_id

---

Display response in the following format

XML JSON

Get login token

POST https://api-app.xtracta.com/v1/user/login_token

(*) mandatory

api_key

user_id

token_expire

---

Display response in the following format

XML JSON

Authorize (Get user API key)

POST https://api-app.xtracta.com/v1/user/authorize

(*1) or (*2) must be supplied

login_token

emailaddress

password

---

Display response in the following format

XML JSON

Batches

Get Batches

POST https://api-app.xtracta.com/v1/batch

(*) mandatory

api_key

batch_id

---

Display response in the following format

XML JSON

Create Batch

POST https://api-app.xtracta.com/v1/batch/create

(*) mandatory

api_key

batch_workflow_id

---

Display response in the following format

XML JSON

Update Batch

POST https://api-app.xtracta.com/v1/batch/update

(*) mandatory

api_key

batch_id

category_id

batch_status no value ready onhold deleted done

---

Display response in the following format

XML JSON

Get Batch workflow

POST https://api-app.xtracta.com/v1/batch/batchworkflow

(*) mandatory

api_key

batchworkflow_id

---

Display response in the following format

XML JSON

Announcements

Get Announcements

POST https://api-app.xtracta.com/v1/announcement

(*) mandatory

api_key

group_id

---

Display response in the following format

XML JSON