Contract.fit

**Permission required:** view_statistics

Change the current user password

Update the current authenticated user password

Create a new API Key

API Keys are simple randomly generated strings bound to roles that grant access to resources. Every API Key maps to attributes defining its validity and can be revoked at any time. API Key can be passed in the **X-API-Key** HTTP Header and in the querystring **&api_key=** **Permission required:** edit_backend_settings

Create a new API Key on inbox level

The requesting user needs to have inbox level permissions API Keys are simple randomly generated strings bound to roles that grant access to resources. Every API Key maps to attributes defining its validity and can be revoked at any time. API Key can be passed in the **X-API-Key** HTTP Header and in the querystring **&api_key=** **Permission required:** edit_backend_settings

Create a project

Simply create a new project **Deprecated**: default_format **Permission required:** create_inbox

Create an inbox

Create a new inbox in the given **project** **Permission required:** create_inbox

Create connection

Create a new connection bound to the given scope (can be a project or inbox) **Permission required:** edit_integrations

Create format

Create an new format **Deprecated**: display_name **Deprecated**: default_format **Permission required:** edit_format_settings

Create integration

Create a new integration. Each type of integration has its own initialization logic and thus may yield suitable error codes depending on the underlying issue, such as credentials or connectivity issue. **Permission required:** edit_integrations

Create report

Create a new report **Permission required:** edit_reports

Create role

Create a new role **Permission required:** edit_users

Create user

Create a new user with the provided attributes and roles **Permission required:** edit_users

Delete a connection

Delete the given connection. **WARNING** This will completely remove the connection, this is not recoverable **Permission required:** edit_integrations

Delete a report

Delete the given report. **WARNING** This will completely remove the report, this is not recoverable **Permission required:** edit_reports

Delete a role

Delete the given role. **WARNING** This will completely remove the role, this is not recoverable **Permission required:** edit_users

Delete an API Key

Completely remove an API Key, thus disabling it. The token won't be recoverable **Permission required:** edit_backend_settings

Delete an inbox

Delete the given inbox. **WARNING** This will completely remove the inbox, this is not recoverable

Delete an integration

Delete the given integration. **WARNING** This will completely remove the integration, this is not recoverable **Permission required:** edit_integrations

Delete documents

in the given inbox. how parameter: if how == "FULL", we delete the entire document, including its source files if how == "SOURCE_FILES", we only remove the (source) files and we set the archived flag. In practice this means all information in the database (json) remains available, but you can no longer download / visualise the original document. what parameter: if what == "DONE", we will only delete files which have status_data.feedback == True if what == "ALL" we will delete all files Start_date and end_date: when specified we will only delete files which are received after (respectively before) the timestamp **WARNING** This will completely remove the documents, this is **not recoverable**

Delete project

Delete the given project. **WARNING** This will completely remove the project, this is not recoverable **Permission required:** edit_format_settings

Delete scoped predictor settings

**Permission required:** edit_predictor_settings

Delete scoped rule config

**Permission required:** edit_predictor_settings

Delete scoped sampling settings

**Permission required:** edit_data_retention_settings

Delete scoped sampling settings

**Permission required:** edit_sampling_settings

Delete the document

how parameter: if how == "FULL", we delete the entire document, including its source files if how == "SOURCE_FILES", we only remove the (source) files and we set the archived flag. In practice this means all information in the database (json) remains available, but you can no longer download / visualise the original document. **WARNING** The removal (of source files and in the database) is permanent **Permission required:** review

Delete the format

**WARNING** This will completely remove the documents, this is **not recoverable** **Permission required:** edit_format_settings

Delete the thresholds settings

**Permission required:** edit_thresholds_settings

Evaluate a rule on a document

**Permission required:** edit_predictor_settings

Generate custom output for documents

Using the provided filter on documents, will generate a custom output. **Note:** only excel output is supported at the moment. **Permission required:** review

Generate report based on input

**Note**: start_date and end_date filter on status update **Permission required:** read_reports

Generate report based on report id

**Note**: start_date and end_date filter on status update **Permission required:** read_reports

Get all API-Key

**Permission required:** view_api_keys

Get all API-Keys for this inbox

**Permission required:** view_api_keys

Get all Connections

Return the list of set up connections **Permission required:** edit_integrations

Get all data retention settings

**Permission required:** read_data_retention_settings

Get all integrations

Return the list of set up integrations **Permission required:** read_integrations

Get all predictor settings

**Permission required:** edit_predictor_settings

Get all reports

Return the list of reports **Permission required:** read_reports

Get all roles

Return the list of roles

Get all rule configs

**Permission required:** edit_predictor_settings

Get all sampling settings

**Permission required:** edit_sampling_settings / review

Get all thresholds settings

**Permission required:** read_thresholds_settings / review

Get all users

Return the list of users **Permission required:** edit_users

Get connection

Return the connection attributes **Permission required:** edit_integrations

Get custom output formatted document

If you have a custom output configured (this is set by contract.fit team), This allows you to get the custom output formatted document. **Permission required:** review

Get details of an API-Key

**Permission required:** view_api_keys

Get document original file

Return the document original file, as attachment. **Permission required:** review

Get documents in the inbox

**Permission required:** view_list

Get format attributes

Return the given format attributes **Deprecated**: display_name **Deprecated**: default_format **Permission required:** edit_format_settings / review

Get Inbox attributes

Get the given inbox attributes **Permission required:** view_list

Get inbox statistics

Compute and return statistics on the given inbox, optionally restricted to a date range and a field. Stats will return per field: - accuracy - precision - f1 score - recall **Note** Depending on the date range and fields, computation might be intensive **Permission required:** view_statistics

Get integration attributes

Return the given integration attributes **Permission required:** edit_integrations

Get integration attributes

Return the given integration attributes **Permission required:** read_integrations

Get list of inboxes

Simply return the list of inboxes

Get lists of format

Return the formats **Deprecated**: display_name **Deprecated**: default_format

Get paginated list of documents in the inbox

**Permission required:** view_list

Get processing runtime stats

**This endpoint is in _preview_ and its interface may change.** Compute statistics over the documents in the inbox. These stats include: - mean - min - max - standard deviation - 50th percentile - 95th percentile - 99th percentile Documents are grouped by their page count: this is currently the *only* supported group by attribute. Documents can be further filter by any given start or end date: the filter will apply to the start processing date, and *not* to the done date. **Permission required:** view_statistics

Get project attributes

Get the attributes of the given project **Deprecated**: default_format

Get report

Return report attributes **Permission required:** read_reports

Get role

Return role attributes

Get scoped dashboard setting

Get the dashboard settings for the given scope (project or inbox)

Get scoped data retention settings

**Permission required:** read_data_retention_settings

Get scoped predictor settings

**Permission required:** edit_predictor_settings

Get scoped review setting

Get the review settings for the given scope (project or inbox)

Get scoped rule config

**Permission required:** edit_predictor_settings

Get scoped sampling settings

**Permission required:** edit_sampling_settings / review

Get summary or details of automation blockers

**Permission required:** view_statistics

Get supported document_types

**Permission required:** edit_format_settings

Get tags values

Get the tag fields values bound to the given scope. Scope can be an inbox or a project **Permission required:** edit_format_settings / review

Get the Accuracy counts on documents, sections and fields in the given inbox

**Permission required:** view_statistics

Get the Blue Dots statistics for the inbox

Compute and return the blue dots statistics, optionally restricted to date range, fields and versions **Permission required:** submit

Get the custom CSS file

Get the custom logo

Get the document

Simple endpoint that will fetch the given document **Permission required:** review

Get the document text

Return the optimal text for the document; will either be the OCR text, the native text, the raw text or a translated version. To ease the data volume from the DB, we lazy load only the relevant text for the document. **Permission required:** review

Get the document Workflow

**WARNING experimental use only** **Permission required:** upload

Get the list of projects

Return the list of projects in the organization **Deprecated**: default_format

Get the regexes that are generated by the rule

**Permission required:** edit_predictor_settings

Get the scoped thresholds settings

**Permission required:** read_thresholds_settings / review

Get the STP counts on documents, sections and fields in the given inbox

**Permission required:** view_statistics

Get the text a where_to_search specification will generate

Returns a list of strings per granularity. If no granularity is specified. It is considered to be the whole document **Permission required:** edit_predictor_settings

Get user

Return user attribute **Permission required:** edit_users

get_document_page_image_resource

get_document_page_image_thumbnail_resource

get_document_reverse_resource

get_email_integration_activation_resource

get_release_notes

get_sso_config_resources

get_usage_stats_resource

post_document_data_resource

post_document_query

post_enrichment_resource

post_sso_config_resources

Process a table-level annotation

A fast and convenient annotation tool that converts a table-level annotation to cell-level feedback. **Permission required:** review

Reset the user password

Return info on the current user

Return user info of the authenticated used making the call

Schedule document reprocessing

This endpoint schedules (async) reprocessing for the given document; it will call the async processing with the given desired version name, similar to the async document upload but skipping OCR. It works asynchronously, so results need to be consulted by a separate call (or webhook) **Permission required:** upload

Schedule inbox reprocessing

This endpoint schedule reprocessing for documents in the given inbox; this will call the async processing, just like async document upload **Permission required:** upload

Submit a feedback

Send a feedback for the given document and optionally evaluate. When a document is to be reviewed, this endpoint is used to send the user feedback. **Permission required:** submit

Update document status

Update the given document status data with the request user and date. Each document defines some status: - lock - escalate - reject - delete - archive - submitted These fields have 3 attributes: - status true / false - since: datetime (UTC) - by: user ID By calling this endpoint you can update the given status data with the request user (the one authenticated) and the current datetime. **Note** : You cannot pass a user in the request nor a datetime **Permission required:** review