INTRODUCTION

Welcome to the Polydocs API!

You can use our API to access Polydocs API endpoints, which can get information on various cats, kittens, and breeds in our database.

AUTHENTIFICATION

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here" \
  -H "X-API-KEY: meowmeowmeow"

Make sure to replace meowmeowmeow with your API key.

Polydocs uses API keys to allow access to the API. You find your Polydocs API key in our Seeting Integration.

Polydocs expects for the API key to be included in all API requests to the server in a header that looks like the following:

X-API-KEY: meowmeowmeow

MASTER DATA

Insert New Master Data

/master_data_lookup/xml/import_xml_file

{
  "id": "//DataArea/ShippingAddress/ShippingAddressHeader/GeneralInfo/BusinessPartner",
  "Kundennummer": "//DataArea/ShippingAddress/ShippingAddressHeader/GeneralInfo/BusinessPartner",
  "Versandanschrift": "//DataArea/ShippingAddress/ShippingAddressHeader/GeneralInfo/ShippingAddressNumber",
  "Kundenname": "//DataArea/ShippingAddress/ShippingAddressHeader/Address/Name1",
  "Straße": "//DataArea/ShippingAddress/ShippingAddressHeader/Address/Street",
  "ORT": "//DataArea/ShippingAddress/ShippingAddressHeader/Address/CityName",
  "PLZ": "//DataArea/ShippingAddress/ShippingAddressHeader/Address/ZipCode"
}

with the Name customer_address

curl "https://api.polydocs.io/master_data_lookup/xml/import_xml_file" \
  -X POST \
  -H "X-API-KEY:: meowmeowmeow"
  -H 'accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -F 'data_type=customer_address' \
  -F 'field_mappings={   "id": "//DataArea/ShippingAddress/ShippingAddressHeader/GeneralInfo/BusinessPartner",   "Kundennummer": "//DataArea/ShippingAddress/ShippingAddressHeader/GeneralInfo/BusinessPartner",   "Versandanschrift": "//DataArea/ShippingAddress/ShippingAddressHeader/GeneralInfo/ShippingAddressNumber",   "Kundenname": "//DataArea/ShippingAddress/ShippingAddressHeader/Address/Name1",   "Straße": "//DataArea/ShippingAddress/ShippingAddressHeader/Address/Street",   "ORT": "//DataArea/ShippingAddress/ShippingAddressHeader/Address/CityName",   "PLZ": "//DataArea/ShippingAddress/ShippingAddressHeader/Address/ZipCode" }' \
  -F 'file=@address_xml_bod.xml;type=text/xml'

Lookup Customer Data

To check the data in the database you can use /master_data_lookup/get_data

curl -X 'GET' \
  'https://dev.api.polydocs.io/master_data_lookup/get_data?data_type=customer_address' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: meowmeowmeow'

TEST CLASSIFY

Classifier v2

You can upload and test the classification of a document.

{
  "model_name": "visual_classifier",
  "model_version": "1",
  "classification_label": "custom_label",
  "doc_type": null,
  "pages": [
    {
      "page": 1,
      "classification": "email",
      "prob": 0.9810521602630615,
      "model_name": "visual_classifier",
      "model_version": "1",
      "label_doc_type": null,
      "label_priority": 6
    },
    {
      "page": 2,
      "classification": "custom label",
      "prob": 0.9877511262893677,
      "model_name": "visual_classifier",
      "model_version": "1",
      "label_doc_type": null,
      "label_priority": 1
    }
  ],
  "classification_score": 0.9877511262893677

curl -X 'POST' \
  'https://dev.api.polydocs.io/classifier_v2/classify_document' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: meowmeowmeow' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@B_47444625_PDF_D52FGM54.PDF;type=application/pdf'

test

HEALTHZ

HTTP Request: /HEALTHZ

Summary: This API checks to see if the system is online.

Responses

title: DOC2 - API

language_tabs: - shell

toc_footers: - Sign Up for a Developer Key - Documentation Powered by lav

includes: - errors

search: true

INTRODUCTION

DOC2 - API

Version: 2.2.10

GET

Summary: Root

HTTP Request

***GET*** /

Responses

LOGTAIL

Logtail

HTTP Request: /logtail

Summary: This API retrieves logs from the system

Responses

Logtail Next

HTTP Request: /logtail/next

Summary: Get Next Logs

Responses

USERS

Retrieve user

HTTP Request: /users/get_users

Summary: This API allows you to retrieve specific users from the system.

Responses

Create new user

HTTP Request: /users/create

Summary: This API allows you create a new user in the system.

Responses

Delete user

HTTP Request: /users/delete/{user_id}

Summary: This API allows you to delete a user from the system.

Parameters

Responses

Update user information

HTTP Request: /users/update/{user_id}

Summary: This API allows you to update or change any specific users information.

Parameters

Responses

Retrieve users who can approve

HTTP Request: /users/get_users_who_can_approve

Summary: This API retrieves all the users that have the ability to approve changes in the system.

Parameters

Responses

GROUPS

Retrieve groups

HTTP Request: /groups/get_groups

Summary: This API can retrieve a specific group or groups from the system.

Responses

Create new group

HTTP Request: /groups/create

Summary: This API allows you to create a new group in the system.

Responses

Delete group

HTTP Request: /groups/delete/{group_id}

Summary: This API allows you to delete a group from the system.

Parameters

Responses

Update group information

HTTP Request: /groups/update/{group_id}

Summary: This API allows you to update or change any specific groups information.

Parameters

Responses

Add user to a group

HTTP Request: /groups/add_user_to_group

Summary: This API allows you to add a new user to a specific group.

Responses

GROUPS AND USERS

Add user to a group

HTTP Request: /groups_and_users/add_user_to_group

Summary: This API allows you to add a specific user to a group.

Responses

Add multiple users to a group

HTTP Request: /groups_and_users/add_users_to_group

Summary: This API allows you to add multiple users to a group.

Responses

Remove user from a group

HTTP Request: /groups_and_users/remove_user_from_group

Summary: This API allows you to remove a specific user from a group.

Responses

Retrieve users from a group

HTTP Request: /groups_and_users/get_group_users

Summary: This API allows you to retrieve the users from a specific group.

Parameters

Responses

GROUP PERMISSIONS

Set group permissions

HTTP Request: /group_permission/set_group_permissions

Summary: This API allows you to set what permissions a specific group has enabled.

Responses

Set permissions for all groups

HTTP Request: /group_permission/set_all_group_permissions

Summary: This API allows you to set what permissions all groups have enabled.

Responses

Retrieve permissions of a group

HTTP Request: /group_permission/get_group_permissions

Summary: This API retrieves the permissions a group has enabled.

Responses

Get permissions of all groups

HTTP Request: /group_permission/get_all_group_permissions

Summary: This API retireves all the permissions each group has enabled.

Responses

Retrieve user groups and permissions

HTTP Request: /group_permission/get_user_groups_and_permissions

Summary: This API retrieves the groups a specific user belongs too and the permissions that are neabled for these groups.

Responses

SUB ORGANISATIONS

Retrieve sub organisations

HTTP Request: /sub_organisations/get_sub_organisations

Summary: This API retrieves a list of all the sub organizations on the system.

Responses

Create new sub organisation

HTTP Request: /sub_organisations/create

Summary: This API allows you to create a new sub organisation.

Responses

Delete sub organisation

HTTP Request: /sub_organisations/delete/{sub_org_id}

Summary: This API allows you to delete a sub organisation.

Parameters

Responses

Update sub organisation

HTTP Request: /sub_organisations/update/{sub_org_id}

Summary: This API allows you to update or change the information of a sub organisation.

Parameters

Responses

Add new user

HTTP Request: /sub_organisation_user/add_user_to_sub_organisation

Summary: This API allows you to add a new user to a sub organisation.

Responses

Remove user

HTTP Request: /sub_organisation_user/remove_user_from_sub_organisation

Summary: This API allows you to delete a user from a sub organisation.

Responses

Retrieve users sub organisations

HTTP Request: /sub_organisation_user/get_user_sub_organisations

Summary: This API retrieves all the sub organisations where a specific user is added.

Parameters

Responses

Retrieve users organisation and sub organisation

HTTP Request: /sub_organisation_user/get_user_organisation_and_sub_organisation

Summary: This API retrieves the organisation(s) and sub organisation(s) where a specific user is added.

Responses

Retrieve sub organisations with specific users

HTTP Request: /sub_organisation_user/get_sub_organisations_with_users

Summary: This API retrieves sub organisations that have certain users added to them.

Responses

Retrieve users of a sub organisation

HTTP Request: /sub_organisation_user/get_sub_organisation_users

Summary: This API retrieves a list of all the users added to a specific sub organisation.

Parameters

Responses

CONFIGURATIONS

Webhook Export

HTTP Request: /CONFIGURE_WEBHOOK_EXPORT

Summary: Allows you to configure a URL where a document will be exported too.

Responses

Flow² Export

HTTP Request: /CONFIGURATIONS/CONFIGURE_FLOW2_EXPORT

Summary: Configure export for Flow².

Responses

Zugferd Export

HTTP Request: /CONFIGURATIONS/CONFIGURE_ZUGFERD_EXPORT

Summary: Configure export for Zugferd.

Responses

Peppol Export

HTTP Request: /CONFIGURATIONS/CONFIGURE_PEPPOL_EXPORT

Summary: Configure export for Peppol.

Responses

IDM Export

HTTP Request: /CONFIGURATIONS/CONFIGURE_IDM_EXPORT

Summary: Configure export for IDM.

Responses

BOD Export

HTTP Request: /CONFIGURATIONS/CONFIGURE_BOD_EXPORT

Summary: Configure export for BOD.

Responses

ION Export

HTTP Request: /CONFIGURATIONS/CONFIGURE_ION_EXPORT

Summary: Configure export for ION.

Responses

INFOR Export

HTTP Requet: /CONFIGURATIONS/CONFIGURE_INFOR_EXPORT

Summary: Configure export for INFOR.

Responses

Retrieve Configuration

HTTP Request: /CONFIGURATIONS/GET_CONFIGURATION

Summary: This API retrieves the oldest configuration of an organisation.

***POST*** /configurations/get_configuration

Responses

Retrieve Configurations

HTTP Request: /CONFIGURATIONS/GET_CONFIGURATIONS

Summary: This API retrieves all configurations of an organisation.

Responses

Remove configuration

HTTP Request: /CONFIGURATIONS/REMOVE_CONFIGURATION

Summary: This API allows you to remove a configuration.

Responses

Update Visibility

HTTP Request: /CONFIGURATIONS/UPDATE_CONFIGURATION_VISIBILITY

Summary: Activate or deactivate a configuration.

Responses

Validation

HTTP Request: /CONFIGURATIONS/VALIDATE_EXPORT_CONFIGURATION

Summary: Validate export Ccnfigurations.

Responses

Document Types

HTTP Request: /CONFIGURATIONS/DOCUMENT_TYPES

Summary: Retrieves a list of each document type name.

Responses

Document types list

HTTP Request: /CONFIGURATIONS/DOCUMENT_TYPES_LIST

Summary: Retrieves a list of all document types and additional information.

Responses

Download

HTTP Request: /CONFIGURATIONS/DOWNLOAD/{ID}

Summary: Allows you to download mapping files for specific configurations.

Parameters

Responses

IMPORT

Supplier BOD

HTTP Request: /IMPORT/SUPPLIER_BOD

Summary: This API imports a supplier BOD.

Responses

Supplier BOD XML

HTTP Request: /IMPORT/SUPPLIER_BOD_XML

Summary: This API imports a supplier BOD XML.

Responses

Purchase Order BOD

HTTP Request: /IMPORT/PURCHASE_ORDER_BOD

Summary: This API imports a purchase order BOD.

Responses

Purchase Order BOD XML

HTTP Request: /IMPORT/PURCHASE_ORDER_BOD_XML

Summary: This API imports a purchase order BOD XML.

Responses

ACK Purchase Order BOD

HTTP Request: /IMPORT/ACK_PURCHASE_ORDER_BOD

Summary: This API imports a ACK purchase order BOD.

Responses

ACK Receive Delivery

HTTP Request: BOD/IMPORT/ACK_RECEIVE_DELIVERY_BOD

Summary: This API imports a ACK receive delivery BOD

Responses

EMAIL

Retrieve Email

HTTP Request: /EMAIL/GET_EMAIL

Summary: This API retrieves a configured email address and all information associated with it.

Responses

Add Email

HTTP Request: /EMAIL/ADD_UPDATE_EMAIL

Summary: This API allows you to configure a new email address to the system.

Responses

Delete Email

HTTP Request: /EMAIL/DELETE_EMAIL

Summary: This API allows you to delete an email address from the system.

Responses

Deactivate Email

HTTP Request: /EMAIL/(DE)-ACTIVATE_EMAIL

Summary: This API allows you to deactivate a current email address so that it can be replaced by a new one.

Responses

Retrieve

HTTP Request: /EMAIL/FETCH_EMAILS

Summary: Imports PDF attachments sent to a specific configured email address.

Responses

Import Log

HTTP Request: /EMAIL/GET_IMPORT_LOG

Summary: Retrieves the log of email imported documents.

Responses

Check login

HTTP Request: /EMAIL/CHECK_LOGIN

Summary: This API checks if the email credentials are valid and can be used to log in.

Responses

ORGANISATION DETAILS

Set Details

HTTP Request: /ORG_DETAILS/SET_ORG_DETAILS

Summary: This API allows you to add the details of a specific organisation.

Responses

Retrieve Details

HTTP Request: /ORG_DETAILS/GET_ORG_DETAILS

Summary: This API retrieves the details of an organisation.

Responses

Set Profile

HTTP Request: /ORG_DETAILS/SET_ORG_PROFILE

Summary: This API allows you to set up a profile for an organisation.

Responses

Retrieve Organisation Profile

HTTP Request: /ORG_DETAILS/GET_ORG_PROFILE

Summary: This API retrieves the profile of a desired organisation.

Responses

OCR Settings

HTTP Request: /ORG_DETAILS/SET_OCR_SETTINGS

Summary: This API allows you to set the specific OCR settings of an organisation.

Responses

Retrieve OCR Settings

HTTP Request: /ORG_DETAILS/GET_OCR_SETTINGS

Summary: This API retrieves the OCR settings of a specific organisation.

Responses

EXPORT

Zugferd

HTTP Request: /EXPORT_ZUGFERD

Summary: This API transforms an invoice into Zugferd format.

Parameters

Responses

Peppol

HTTP Request: /EXPORT/EXPORT_PEPPOL

Summary: This API transforms an invoice into Peppol format.

Parameters

Responses

Retrieve Pending Watch Export Documents

HTTP Request: /EXPORT/GET_PENDING_WATCH_EXPORT_DOCUMENTS

Summary: This API retrieves all pending watch export documents.

Parameters

Responses

Update Pending Watch Export Status

HTTP Request: /EXPORT/UPDATE_PENDING_WATCH_EXPORT_STATUS

Summary: This API displays the update status of pending watch export documents.

Parameters

Responses

Test Process Document

HTTP Request: /EXPORT/TEST_PROCESS_DOC

Summary: Test Process Doc

Parameters

Responses

Save Extraction Rules

HTTP Request: /EXPORT/SAVE_EXTRACTION_RULES

Summary: This API sends a command to the system to save all extraction rules.

Responses

Retrieve Data V1

HTTP Request: /EXPORT/GET_DATA_V1

Summary: This API retrieves all V1 data.

Parameters

Responses

FUZZY

Retrieve Vendor List

HTTP Request: /FUZZY/GET_VENDORS_LIST

Summary: This API retrieves a list of all the vendors of an organisation.

Parameters

Responses

Import Vendor CSV

HTTP Request: /FUZZY/IMPORT_VENDORS_CSV

Summary: This API imports the data of a vendor CSV file.

Responses

VENDORS

Retrieve Vendors List

HTTP Request: /VENDORS/GET_VENDORS_LIST

Summary: This API retrieves a list of all an organisations vendors.

Parameters

Responses

Import Vendor CSV

HTTP Request: /VENDORS/IMPORT_VENDORS_CSV

Summary: This API imports a CSV file of a specific vendor. Responses

MIGRATION

Retrieve Migration Version

HTTP Request: /MIGRATION/GET_MIGRATION_VERSION

Summary: This API retrieves a migration version.

Responses

DOCUMENT CLASSIFICATION RULES

Retrieve Document Classification Rules

HTTP Request: /DOC_CLASSIFICATION_RULES/GET_DOC_CLASSIFICATION_RULES

Summary: This API retrieves the classification rules for a type of document.

Responses

Create New Classification Rules

HTTP Request: /DOC_CLASSIFICATION_RULES/CREATE

Summary: This API allows you to create a new classification rule for a specific type of document.

Responses

Delete Classification Rules

HTTP Request: /DOC_CLASSIFICATION_RULES/DELETE/{ID}

Summary: This API allows you to delete a classification rule for a specific type of document.

Parameters

Responses

Update Classification Rules

HTTP Request: /DOC_CLASSIFICATION_RULES/UPDATE/{ID}

Summary: This API allows you to update existing classification rules for a specific document type.

Parameters

Responses

DOCUMENTS

Classify a Document

HTTP Request: /DOCUMENT/CLASSIFY_DOCUMENT

Summary: This API allows you to classify a document.

Responses

Process DOC² Landing Document

HTTP Request: /DOCUMENT/PROCESS_DOC2LANDING_DOCUMENT

Summary: This API allows you to process a landing document for DOC².

Responses

Process Documents

HTTP Request: /DOCUMENT/PROCESS_DOCUMENTS

Summary: This API allows you to process documents.

Responses

Process

HTTP Request: /DOCUMENT/PROCESS

Summary: This API allows you to process one document.

Responses

Process Base64

HTTP Request: /DOCUMENT/PROCESS_BASE64

Summary: This API processes an base64 encoded document.

Responses

Update Document

HTTP Request: /DOCUMENT/UPDATE/{DOC_ID}

Summary: This API allows you to update an existing document.

Parameters

Responses

Validate and Export

HTTP Request: /DOCUMENT/VALIDATE_AND_EXPORT/{DOC_ID}

Summary: This API allows you to validate and export a document.

Parameters

Responses

Retrieve List of Documents

HTTP Request: /DOCUMENT/LIST

Summary: This API retrieves a list of all existing documents in the system.

Parameters

Responses

Retrieve Document Status

HTTP Request: /DOCUMENT/STATUS/{DOC_ID}

Summary: This API shows the status of a specific document.

Parameters

Responses

Dashboard

HTTP Request: /DOCUMENT/DASHBOARD

Summary: This API retrieves general document information from recent documents.

Parameters

Responses

Extraction Result

HTTP Request: /DOCUMENT/EXTRACTION_RESULT

Summary: This API displays the extraction results of a document.

Responses

Restart

HTTP Request: /DOCUMENT/RESTART/{DOC_ID}

Summary: This API allows you to restart the processing of a specific document.

Parameters

Responses

Restart Documents

HTTP Request: /DOCUMENT/RESTART_DOCUMENTS

Summary: This API restarts the processing of all documents in an organisation.

Responses

Approve or Reject

HTTP Request: /DOCUMENT/APPROVE_OR_REJECT/{DOC_ID}

Summary: This API allows you to either accept or reject a specific document.

Parameters

Responses

Update Document Log

HTTP Request: /DOCUMENT/UPDATE_DOCUMENT_LOG/{DOC_ID}

Summary: This API updates the document log.

Parameters

Responses

Retrieve Document Log

HTTP Request: /DOCUMENT/GET_DOCUMENT_LOG/{DOC_ID}

Summary: This API retrieves the log of a specific document.

Parameters

Responses

Restart with New Classification

HTTP Request: /DOCUMENT/RESTART_WITH_NEW_CLASSIFICATION/{DOC_ID}*

Summary: This API restarts a document to be classified as a specific document type.

Parameters

Responses

Restart export

HTTP Request: /DOCUMENT/RESTART_EXPORT/{DOC_ID}

Summary: Restart Export

Parameters

Responses

Document ID

HTTP Request: /DOCUMENT/{DOC_ID}

Summary: Get Document ID.

Parameters

Responses

Delete

HTTP Request: /DOCUMENT/DELETE/{DOC_ID}

Summary: Delete document.

***DELETE*** /document/delete/{doc_id}

Parameters

Responses

Delete Documents

HTTP Request: /DOCUMENT/DELETE_DOCUMENTS

Summary: This API allows you to delete documents.

Responses

Assign Specific Document

HTTP Request: /DOCUMENT/ASSIGN/{DOC_ID}

Summary: This API assigns a document to a user for further tasks, eg. classification.

Parameters

Responses

Assign Documents

HTTP Request: /DOCUMENT/ASSIGN_DOCUMENTS

Summary: This API assigns multiple documents to a user for further tasks, eg. classification.

Responses

Assign with Email

HTTP Request: /DOCUMENT/ASSIGN_WITH_EMAIL/{DOC_ID}

Summary: This API assigns a document to a users email address for further tasks, eg. classification.

Parameters

Responses

Retrieve Next Document

HTTP Request: /DOCUMENT/GET_NEXT_DOCUMENT/{DOC_ID}

Summary: Get Next Document

Parameters

Responses

Retrieve OCR Data

HTTP Request: /DOCUMENT/GET_OCR_DATA/{DOC_ID}

Summary: This API retrieves the OCR data of a specific document.

Parameters

Responses

Delete Documents in Error Status

HTTP Request: /DOCUMENT/DELETE_ERROR_DOCS

Summary: This API allows you to delete documents that are in error status.

Responses

Split Document

HTTP Request: /DOCUMENT/SPLIT_DOCUMENT

Summary: This API allows you to split a document.

Responses

Generate Thumbnails

HTTP Request: /DOCUMENT/GENERATE_THUMBNAILS

Summary: This API generates a preview image of what the document will look like.

Responses

Retrieve Document Status XML

HTTP Request: /DOCUMENT/GET_DOC_STATUS_XML

Summary: This API retrieves the status of an XML document.

Responses

DOCUMENT LAYOUT TEMPLATES

Retrieve Layout Templates

HTTP Request: /DOCUMENT_LAYOUT_TEMPLATE/GET_LAYOUT_TEMPLATES

Summary: This API retrieves layout templates for a document.

Parameters

Responses

Create

HTTP Request: /DOCUMENT_LAYOUT_TEMPLATE/CREATE

Summary: This API allows you to create a layout emplate for a document.

Responses

Retrieve Layout Template

HTTP Request: /DOCUMENT_LAYOUT_TEMPLATE/{ID}

Summary: This API retrieves a specific layout template using the ID associated with the layout template.

Parameters

Responses

Update Layout Template

HTTP Request: /DOCUMENT_LAYOUT_TEMPLATE/{ID}

Summary: This API allows you to update a layout template for a document.

Parameters

Responses

Delete Layout template

HTTP Request: /DOCUMENT_LAYOUT_TEMPLATE/{ID}

Summary: This API allows you to delete a specific layout template.

Parameters

Responses

Upload Template Sample

HTTP Request: /DOCUMENT_LAYOUT_TEMPLATE/UPLOAD_TEMPLATE_SAMPLE

Summary: This API allows you to upload a sample template.

Responses

TABLE EXTRACTION V3

Auto Extract Table

HTTP Request: /TABLE_EXTRACTION_V3/AUTO_EXTRACT_TABLE

Summary: This API allows you to set that a table will be automatically extracted from a document.

Responses

Retrieve Table

HTTP Request: /TABLE_EXTRACTION_V3/GET_TABLE

Summary: This API will retrieve a specific table froma document.

Responses

Reformat Table

HTTP Request: /TABLE_EXTRACTION_V3/REFORMAT_TABLE

Summary: This API allows you to reformat an extracted table.

Responses

Retrieve Compact Table

HTTP Request: /TABLE_EXTRACTION_V3/GET_COMPACT_TABLE

Summary: This API will retrieve a compact table.

Responses

Create Table Column

HTTP Request: /TABLE_EXTRACTION_V3/CREATE_DOCUMENT_TABLE_COLUMN

Summary: This API allows you to create a table column for a document.

Responses

Delete Table Rules

HTTP Request: /TABLE_EXTRACTION_V3/DELETE_TABLE_RULES

Summary: This API allows you to delete table rules.

Responses

BLOCK TABLE EXTRACTION

Blocked List

HTTP Request: /BLOCK_TABLE_EXTRACTION/BLOCKED_LIST

Summary: This API retrieves a list of blocked suppliers.

Responses

Blocked List - Add

HTTP Request: /BLOCK_TABLE_EXTRACTION/BLOCKED_LIST/ADD

Summary: This API allows you to add a blocked supplier.

Responses

Blocked List - Delete

HTTP Request: /BLOCK_TABLE_EXTRACTION/BLOCKED_LIST/{ID}

Summary: This API

Parameters

Responses

FIELD

Retrieve Document UI LAYOUT

HTTP Request: /FIELD/GET_DOCUMENT_UI_LAYOUT

Summary: This API retrieves the document UI layout.

Parameters

Responses

Retrieve Field Settings

HTTP Request: /FIELD/GET_FIELD_SETTINGS

Summary: This API retrieves the field settings for a specific field.

Parameters

Responses

Clone Document Type

HTTP Request: /FIELD/CLONE_DOC_TYPE

Summary: This API allows you to clone the fields of a document type to create a clone of a document type.

Parameters

Responses

Copy Settings from Document Type

HTTP Request: /FIELD/COPY_FIELDS_SETTING_FROM_DOC_TYPE

Summary: This API lets you copy the field settings of a document type.

Parameters

Responses

Retrieve Field Settings of all Document Types

HTTP Request: /FIELD/GET_FIELD_SETTINGS_ALL_DOCUMENT_TYPES

Summary: This API retrieves a list of all the document types of an organisation as well as the field settings contained within those document types.

Parameters

Responses

Restore Default Settings

HTTP Request: /FIELD/SETTINGS_RESTORE_DEFAULTS

Summary: This API allows you to restore field settings back to the default settings.

Parameters

Responses

Update Field Settings

HTTP Request: /FIELD/UPDATE_FIELD_SETTINGS

Summary: This API allows you to update or change existing field settings.

Parameters

Responses

Retrieve Document Layout

HTTP Request: /FIELD/GET_DOCUMENT_LAYOUT

Summary: This API retrieves the layout fo a specific document.

Parameters

Responses

Retrieve Document Table Validation Rules

HTTP Request: /FIELD/GET_DOCUMENT_TABLE_VALIDATION_RULES

Summary: This API retrieves the validation rules for all documents table extractions.

Parameters

Responses

Update Document Table Column

HTTP Request: /FIELD/UPDATE_DOCUMENT_TABLE_COLUMN

Summary: This API allows you to update or change an existing document table column.

Parameters

Responses

Retrieve Custom Field Labels

HTTP Request: /FIELD/GET_CUSTOM_FIELD_LABELS

Summary: This API retrieves a list of the custom field labels.

Parameters

Responses

EXTRACT

Retrieve Text

HTTP Request: /EXTRACT/GET_TEXT

Summary: This API retrieves extracted text from a document.

Responses

Retrieve Table Text

HTTP Request: /EXTRACT/GET_TABLE_TEXT

Summary: This API retrieves text from an extracted table.

Responses

Retrieve Formatted Amount

HTTP Request: /EXTRACT/GET_FORMATTED_AMOUNT

Summary: This API retrieves a formatted amount.

Responses

Retrieve Column Headers

HTTP Request: /EXTRACT/GET_COLUMN_HEADERS

Summary: This API retrieves the column headers from an extracted table.

Responses

Retrieve AI Score

HTTP Request: /EXTRACT/GET_AI_SCORE

Summary: This API retrieves the AI score from a data extraction of a document.

Parameters

Responses

PURCHASE ORDERS

Retrieve Purchase Order List

HTTP Request: /PURCHASE_ORDER/GET_PURCHASE_ORDERS_LIST

Summary: This API retrieves purchase order lists.

Parameters

Responses

Retrieve Lines

HTTP Request: /PURCHASE_ORDER/GET_PURCHASE_ORDER_LINES

Summary: This API retrieves purchase order lines.

Parameters

Responses

Retrieve Display Columns

HTTP Request: /PURCHASE_ORDER/GET_PURCHASE_ORDER_DISPLAY_COLS

Summary: This API retrieves ourchase order display columns.

Parameters

Responses

Auto PO Match

HTTP Request: /PURCHASE_ORDER/AUTO_PO_MATCH

Summary: This API allows you to automatically match a purchase order to the PO number.

Responses

SPECIAL RULES

Save

HTTP Request: /SPECIAL_RULES/SAVE

Summary: Save

Responses

PREFERENCES

Retrieve Preferences

HTTP Request: /PREFERENCES/GET_PREFERENCES

Summary: This API retrieves a list of settings that can be activated and deactivated.

Responses

Set Preference

HTTP Request: /PREFERENCES/SET_PREFERENCE

Summary: This API allows you to update or change existing settings that can be activated and deactivated.

Responses

Remove Preference

HTTP Request: /PREFERENCES/REMOVE_PREFERENCE

Summary: This API allows you to delete a preference.

Parameters

Responses

Retrieve Regex from Document Type

HTTP Request: /PREFERENCES/GET_DOCUMENT_TYPE_REGEXES

Summary: This API retrieves the regular expressions of a document type.

Responses

Retrieve Supported Barcode Types

HTTP Request: /PREFERENCES/GET_SUPPORTED_BARCODE_TYPES

Summary: This API retrieves all supported barcode types.

Responses

Update Organisation Preferences

HTTP Request: /PREFERENCES/UPDATE_ORGANISATION_PREFERENCE

Summary: This API allows you to update or change the preferences of an organisation.

Responses

Retrieve Organisation Preferences

HTTP Request: /PREFERENCES/GET_ORGANISATION_PREFERENCE

Summary: This API retrieves a list of all the preferences of an organisation.

Responses

Update OCR Configuration

HTTP Request: /PREFERENCES/UPDATE_OCR_CONFIGURATION

Summary: This API allows you to update or change the OCR configuration.

Responses

Retrieve OCR Configuration

HTTP Request: /PREFERENCES/GET_OCR_CONFIGURATION

Summary: This API retrieves the OCR Configuration of an organisation.

Responses

RESOURCE

Document ID - File Name

HTTP Request: /RESOURCE/DOCUMENT/{DOC_ID}/{FILENAME}

Summary: This API retrieves a file of a document.

Parameters

Responses

Image ID - Page

HTTP Request: /RESOURCE/IMAGE/{DOC_ID}/{PAGE}

Summary: This API retrieves an image from a specific document.

Parameters

Responses

Type - ID - Image (Page)

HTTP Request: /RESOURCE/{TYPE}/{ID}/IMAGE/{PAGE}

Summary: This API allows you to retrieve a specific image from a document.

Parameters

Responses

Check S3

HTTP Request: /RESOURCE/CHECK_S3

Summary: This API can check if a file is stored online and exists.

Parameters

Responses

Mass Check S3

HTTP Request: /RESOURCE/MASS_CHECK_S3

Summary: This API can check if multiple files are saved online and exist.

Parameters

Responses

Retrieve Errors

HTTP Request: /RESOURCE/GET_ERRORS

Summary: Gets the error message and the exception cause from the db for the specified doc_ids.

Parameters

Responses

EPHESOFT

Extract Table

HTTP Request: /EPHESOFT/EXTRACT_TABLE

Summary: Extracts table from the document Args: file: Document from which table should be extracted force_ocr ([type]): To re-ocr already ocr-ed document format_amount_locale ([type]): Output format for the amounts format_date_pattern ([type]): Output format for the dates remove_empty_columns: To remove empty columns from the output table start_page: Start page (In case there are multiple documents in single pdf) end_page: End page (In case there are multiple documents in single pdf) output_format: It is useless and never should be passed Returns: [type]: Returns extracted table (Compact)

Parameters

Responses

Retrieve Table Train URL

HTTP Request: /EPHESOFT/GET_TABLE_TRAIN_URL

Summary: Saves a table training record with doc_id and ephesoft_doc_id extracted from attached xml. OCRs and copies document from fellowkv storage to doc2 storage. Note: This endpoint doesn't extract any table yet. This is done by get_table_train_data endpoint.

Args: ephesoft_doc_id ([type]): Ephesoft doc id, for which table will be trained/extracted (e.g. DOC1) file: Zip or XML document from Ephesoft. ([BatchInstance]_batch.xml) force_ocr ([type]): To re-ocr already ocr-ed document Returns: [type]: id of the saved record

Responses

Retrieve Table Train Data

HTTP Request: /EPHESOFT/GET_TABLE_TRAIN_DATA

Summary: Extracts table from the document and return in response. Args: id ([type]): Id for the saved record for EphesoftTableExtractionTraining Returns: [type]: id of the saved record

Parameters

Responses

Save Extraction Rules

HTTP Request: /EPHESOFT/SAVE_EXTRACTION_RULES/{ID}

Summary: Saves extraction results, which can be loaded in Ephesoft with 'Reload Data' button using get_updated_ephesoft_doc endpoint. Saves table extraction rules for future documents of same supplier. Args: id ([type]): Id for the saved record for EphesoftTableExtractionTraining Returns: [type]: id of the saved record

Parameters

Responses

Retrieve PO Match URL

HTTP Request: /EPHESOFT/GET_PO_MATCH_URL

Summary: Saves a EphesoftPOMatching record with doc_id and ephesoft_doc_id extracted from attached xml. Args: ephesoft_doc_id ([type]): Ephesoft doc id, for which table will be trained/extracted (e.g. DOC1) file: Zip or XML document from Ephesoft. ([BatchInstance]_batch.xml) Returns: [type]: id of the saved record

Responses

Retrieve PO Match Data

HTTP Request: /EPHESOFT/GET_PO_MATCH_DATA/{ID}

Summary: Return extracted_data from EphesoftPOMatching. This has same structure as we have for documents extracted_data.

Args: id ([type]): EphesoftPOMatching record id Returns: [type]: extracted_data from EphesoftPOMatching

Parameters

Responses

Save PO Match Data

HTTP Request: /EPHESOFT/SAVE_PO_MATCH_DATA/{ID}

Summary: Saves updated EphesoftPOMatching record from extracted_data sent in request.

Args: id ([type]): EphesoftPOMatching record id extracted_data ([type]): extracted_data in the same format we have for documents Returns: [type]: success result

Parameters

Responses

Retrieve Updated Ephesoft Document

HTTP Request: /EPHESOFT/GET_UPDATED_EPHESOFT_DOC

Summary: Return updated ephesoft xml document populated either from extracted table or from PO matching.

Args: source ([type]): TableTraining or PO - TableTraining: Result xml should be populated from table training record - PO Result xml should be populated from po matching remove_empty_columns: To remove empty columns from the output table ephesoft_doc_id ([type]): Ephesoft doc id, for which table will be updated file: Zip or XML document in which table will be updated Returns: [type]: Zip file with updated table

Parameters

Responses

DOCUMENT TYPE

Retrieve Document Type

HTTP Request: /DOCUMENT_TYPE/GET_DOCUMENT_TYPES

Summary: This API retrieves specific document types.

Responses

Retrieve Document Types and Sub Types

HTTP Request: /DOCUMENT_TYPE/GET_DOCUMENT_TYPES_AND_SUB_TYPES

Summary: This API retrieves specific document types and sub types.

Responses

Create Document Type

HTTP Request: /DOCUMENT_TYPE/CREATE_DOCUMENT_TYPE

Summary: This API allows you to create a document type.

Responses

Delete Document Type

HTTP Request: /DOCUMENT_TYPE/DELETE_DOCUMENT_TYPE/{ID}

Summary: This API allows you to dlete a document type.

Parameters

Responses

Retrieve Sub Document Type

HTTP Request: /DOCUMENT_TYPE/GET_SUB_DOCUMENT_TYPES

Summary: This API retrieves a specific sub document type.

Parameters

Responses

Create Sub Document Type

HTTP Request: /DOCUMENT_TYPE/CREATE_SUB_DOCUMENT_TYPE

Summary: This API allows you to create a sub document type.

Responses

Delete Sub Document Type

HTTP Request: /DOCUMENT_TYPE/DELETE_SUB_DOCUMENT_TYPE/{ID}

Summary: This API allows you to delete a sub document type.

Parameters

Responses

Activate/Deactivate Document Type

HTTP Request: /DOCUMENT_TYPE/ACTIVATE_DEACTIVATE_DOCUMENT_TYPE

Summary: This API allows you to activate or deactivate a specific document type.

Responses

Retrieve Document Field Groups

HTTP Request: /DOCUMENT_TYPE/GET_DOCUMENT_FIELD_GROUPS

Summary: This API retrieves document field groups.

Parameters

Responses

Create Document Field Group

HTTP Request: /DOCUMENT_TYPE/CREATE_DOCUMENT_FIELD_GROUP

Summary: This API allows you to create a document field group.

Responses

Delete Document Field Group

HTTP Request: /DOCUMENT_TYPE/DELETE_DOCUMENT_FIELD_GROUP/{ID}

Summary: This API allows you to delete a document field group.

Parameters

Responses

Create Document Field

HTTP Request: /DOCUMENT_TYPE/CREATE_DOCUMENT_FIELD

Summary: This API allows you to create a document field.

Responses

Delete Document Field

HTTP Request: /DOCUMENT_TYPE/DELETE_DOCUMENT_FIELD/{ID}

Summary: This API lets you delete a document field.

Parameters

Responses

DOCUMENT TABLE

Retrieve All Document Tables

HTTP Request: /DOCUMENT_TABLE/GET_ALL_DOCUMENT_TABLES

Summary: This API retrieves all tables that appear in an organisations documents.

Responses

Retrieve Document Tables

HTTP Request: /DOCUMENT_TABLE/GET_DOCUMENT_TABLES

Summary: This API retrieves document tables.

Parameters

Responses

Retrieve Document Tables with Columns

HTTP Request: /DOCUMENT_TABLE/GET_DOCUMENT_TABLES_WITH_COLUMNS

Summary: This API retrieves document tables with columns included.

Parameters

Responses

Create Document Table

HTTP Request: /DOCUMENT_TABLE/CREATE_DOCUMENT_TABLE

Summary: This API allows you to create a document table.

Responses

Delete Document Table

HTTP Request: /DOCUMENT_TABLE/DELETE_DOCUMENT_TABLE/{ID}

Summary: This API allows you to delete a document table.

Parameters

Responses

Retrieve Document Table Columns

HTTP Request: /DOCUMENT_TABLE/GET_DOCUMENT_TABLE_COLUMNS

Summary: This API retrieves the columns from a table within a document.

Parameters

Responses

Create Document Table Column

HTTP Request: /DOCUMENT_TABLE/CREATE_DOCUMENT_TABLE_COLUMN

Summary: This API allows you to crteate a document table column.

Responses

Delete Document Table Column

HTTP Request: /DOCUMENT_TABLE/DELETE_DOCUMENT_TABLE_COLUMN/{ID}

Summary: This API allows you to dlete a document table column.

Parameters

Responses

Update Document Table Column

HTTP Request: /DOCUMENT_TABLE/UPDATE_DOCUMENT_TABLE_COLUMN

Summary: This API allows you to update or change an existing document table column.

Parameters

Responses

DATA VAULT

Create a Record

HTTP Request: /DATA_VAULT/CREATE_RECORD

Summary: This API allows you to create a record to be stored in the data vault.

Responses

AUTO TEST

Add Update Document

HTTP Request: /AUTO_TEST/ADD_UPDATE_DOCUMENT

Summary: This API duplicates the document into an auto test version of the document.

Responses

Remove Document

HTTP Request: /AUTO_TEST/REMOVE_DOCUMENT

Summary: This API deletes an auto test document.

Parameters

Responses

Retrieve Document Data

HTTP Request: /AUTO_TEST/GET_DOCUMENT_DATA

Summary: This API retrieves data from an auto test document.

Parameters

Responses

REGEX AND PATTERNS

RE Validation

HTTP Request: /REGEX_AND_PATTERNS/RE/IS_VALID

Summary: Is Re Valid

Responses

Regex Validation

HTTP Request: /REGEX_AND_PATTERNS/REGEX/IS_VALID

Summary: Is Regex Valid

Responses

RE Validate Patterns

HTTP Request: /REGEX_AND_PATTERNS/RE/VALIDATE_PATTERNS

Summary: This API validates Re patterns.

Responses

Regex Validate Patterns

HTTP Request: /REGEX_AND_PATTERNS/REGEX/VALIDATE_PATTERNS

Summary: This API validates Regex patterns.

Responses

FELLOW KV

Retrieve Data

HTTP Request: /FELLOWKV/GET_DATA/{URL}

Summary: This API retrieves data that was extracted from the Fellow KV extractor.

Parameters

Responses

Post Data

HTTP Request: /FELLOWKV/POST_DATA/{URL}

Summary: This API takes the retrieved Fellow KV data and posts a URL where the data is viewable.

Parameters

Responses

DOCUMENT TRAINER

Add Sample Document

HTTP Request: /DOCUMENT_TRAINER/ADD_SAMPLE_DOCUMENT

Summary: This API lets you upload multiple sample documents to the document trainer to test features, etc.

Responses

Add One Sample Document

HTTP Request: /DOCUMENT_TRAINER/ADD_ONE_SAMPLE_DOCUMENT

Summary: This API lets you upload one sample document to the document trainer to test features, etc.

Responses

Retrain Model

HTTP Request: /DOCUMENT_TRAINER/RETRAIN_MODEL

Summary: This API allows you to retrain a model.

Responses

Retrain All Models

HTTP Request: /DOCUMENT_TRAINER/RETRAIN_ALL_MODELS

Summary: This API allows you to retrain all models at once.

Responses

Test Classification

HTTP Request: /DOCUMENT_TRAINER/TEST_CLASSIFICATION

Summary: This API allows you to test if a document is correctly classified.

Responses

Retrieve Sample Documents

HTTP Request: /DOCUMENT_TRAINER/GET_SAMPLE_DOCUMENTS

Summary: This API retrieves sample documents.

Responses

Delete Sample Document

HTTP Request: /DOCUMENT_TRAINER/DELETE_SAMPLE_DOCUMENT/{ID}

Summary: This API lets you delete a sample document.

Parameters

Responses

Create Training Files

HTTP Request: /DOCUMENT_TRAINER/CREATE_TRAINING_FILES

Summary: This APIO lets you create new training files to train documents with.

Responses

Test Model

HTTP Request: /DOCUMENT_TRAINER/TEST_MODEL

Summary: This API lets you test a model.

Responses

DOCUMENT STATUS ALERT

Retrieve Document Alert Status

HTTP Request: /DOCUMENT_STATUS_ALERT/GET_DOCUMENT_STATUS_ALERT_STATUSES

Summary: This API retrieves the status of documents for which you have alerts configured.

Responses

Retrieve Document Alerts

HTTP Request: /DOCUMENT_STATUS_ALERT/GET_DOCUMENT_STATUS_ALERTS

Summary: This API retrieves only the alerts for documents which you have alerts configured.

Responses

Create Document Status Alert

HTTP Request: /DOCUMENT_STATUS_ALERT/CREATE_DOCUMENT_STATUS_ALERT

Summary: This API allows you to create a new status alert for a document.

Responses

Update Document Status Alert

HTTP Request: /DOCUMENT_STATUS_ALERT/UPDATE_DOCUMENT_STATUS_ALERT

Summary: This API allows you to update or change an existing document status alert.

Responses

Delete Document Status Alert

HTTP Request: /DOCUMENT_STATUS_ALERT/REMOVE_DOCUMENT_STATUS_ALERT

Summary: This API allows you to delte a document status alert.

Responses

CUSTOM CLASSIFIER

Test Classification

HTTP Request: /CUSTOM_CLASSIFIER/TEST_CLASSIFICATION

Summary: This API allows you to test the cutom classification rule you created.

Responses

Train Document

HTTP Request: /CUSTOM_CLASSIFIER/TRAIN_DOCUMENT

Summary: This API lets you train documents using your custom classification rule.

Responses

CUSTOM MODEL

List

HTTP Request: /CUSTOM_MODEL/LIST

Summary: This API retrieves a list of custom models.

Responses

Create Model

HTTP Request: /CUSTOM_MODEL/CREATE

Summary: This API allows you to create custom model layouts.

Responses

Retrieve Custom Model

HTTP Request: /CUSTOM_MODEL/{ID}

Summary: This API retrieves a custom model according to its ID.

Parameters

Responses

Update Custom Model

HTTP Request: /CUSTOM_MODEL/{ID}

Summary: This API allows you to update or change an existing custom model layout.

Responses

Delete Custom Model

HTTP Request: /CUSTOM_MODEL/{ID}

Summary: This API lets you delete a custom model layout.

Parameters

Responses

CUSTOM MODEL LABEL

Retrieve Custom Model Label List

HTTP Request: /CUSTOM_MODEL_LABEL/LIST

Summary: This API retrieves a list of all custom model labels.

Parameters

Responses

Create Custom Model Label

HTTP Request: /CUSTOM_MODEL_LABEL/CREATE

Summary: This API allows you to create a custom model label.

Parameters

Responses

Retrieve Specific Custom Model Label

HTTP Request: /CUSTOM_MODEL_LABEL/{ID}

Summary: This API retrieves a specific custom model label according to its ID.

Parameters

Responses

Update Custom Model Label

HTTP Request: /CUSTOM_MODEL_LABEL/{ID}

Summary: This API lets you update or change an existing custom model label.

Parameters

Responses

Delete Custom Model Label

HTTP Request: /CUSTOM_MODEL_LABEL/{ID}

Summary: This API lets you delete a custom model label.

Parameters

Responses

OCR CONFIGURATIONS

Retrieve OCR Server Types

HTTP Request: /OCR_CONFIGURATIONS/GET_OCR_SERVER_TYPES

Summary: This API retrieves all OCR server types.

Responses

Update OCR Configuration

HTTP Request: /OCR_CONFIGURATIONS/UPDATE_OCR_CONFIGURATION

Summary: This API allows you to update or change the existing OCR configurations.

Responses

Retrieve Specific OCR Configuration

HTTP Request: /OCR_CONFIGURATIONS/GET_OCR_CONFIGURATION

Summary: This API Allows you to retrieve a specific OCR configuration.

Responses

Enable/Disable Etext function

HTTP Request: /OCR_CONFIGURATIONS/UPDATE_ETEXT_ENABLE_STATUS

Summary: This API allows you to activate or deactivate the Etext function.

Responses

Check if Etext is Enabled

HTTP Request: /OCR_CONFIGURATIONS/IS_ETEXT_ENABLED

Summary: This API retrieves the status of the Etext activation (whether it is turned on or not).

Responses

API

API Health

HTTP Request: /API/HEALTH/

Summary: This API checks if an API is still online.

Responses

API Health - Services

HTTP Request: /API/HEALTH/SERVICES

Summary: This API retrieves the full list of services the API offers and displays whether they are online or not.

Responses

FLOW

Retrieve Specific Document Flow

HTTP Request: /FLOW/GET_DOCUMENT_FLOW/{DOC_ID}

Summary: This API retrieves a specific document flow.

Parameters

Responses

Test Specific Flow

HTTP Request: /FLOW/TEST_FLOW/{DOC_ID}

Summary: This API allows you to test a specific document flow.

Parameters

Responses

MASTER DATA LOOKUP

Retrieve Data Set Types

HTTP Request: /MASTER_DATA_LOOKUP/GET_DATASET_TYPES

Summary: This API retrieves a list of the data set types.

Responses

Retrieve Data Set Fields

HTTP Request: /MASTER_DATA_LOOKUP/GET_DATASET_FIELDS

Summary: This API retrieves a list of the data set fields.

Parameters

Responses

Retrieve Data

HTTP Request: /MASTER_DATA_LOOKUP/GET_DATA

Summary: This API retrieves data according to the data set type.

Parameters

Responses

Download CSV File

HTTP Request: /MASTER_DATA_LOOKUP/DOWNLOAD_CSV

Summary: This API allows you to download a CSV file.

Parameters

Responses

Create Records

HTTP Request: /MASTER_DATA_LOOKUP/CREATE_RECORDS

Summary: This APi allows you to create a new master data record.

Responses

Update Record

HTTP Request: /MASTER_DATA_LOOKUP/UPDATE_RECORD

Summary: This API allows you to update or change an existing master data record.

Responses

Delete Record

HTTP Request: /MASTER_DATA_LOOKUP/DELETE_RECORD

Summary: This API allows you to delete a master data record.

Responses

Import Data

HTTP Request: /MASTER_DATA_LOOKUP/IMPORT_DATA

Summary: This API allows you to import a CSV file.

Responses

Errors

The Polydocs API uses the following error codes: