Authentication#

1. Open api.polydocs.io
2. Click on Authorize in the upper right corner

3. Enter your API Key and confirm by clicking Authorize

Upload document#

After completing steps 1.-3.
4. Scroll down to

5. Open the tab and click on Try it out in the upper right corner to enter the following value

source: email:{Pattern name}

6. Select the file you want to upload and click Execute

Your document will be uploaded to your dashboard with the rules you set in DOC²

Document Status#

After completing steps 1.-3.
4. Scroll down to

5. Open the tab and click on Try it out in the upper right corner to enter the following value

doc-id: https://app.polydocs.io/2a/9c931f6f-f352-4526-a78d-c036c39a8d9e

You will obtain the document ID when you open the document on the dashboard. This is located at the end of the URL when the document is open.

You will receive the following response:

Ready For Validation means that the user can check the document.

Upload document with metadata#

After completing steps 1.-3.
4. Scroll down to one of these endpoints:
- /document/process_documents
- /document/process
- /document/process_base64

Here we will upload a document to /document/process, but the steps are the same for the other endpoints

5. Open the tab and click on Try it out in the upper right corner to enter the following value

Enter Metadata
The metadata needs to be in a valid json format. Json Validator
An example of a metadata entry would be:
1
{"custom-key": "the custom value", "custom_doc_id": "8a5cf33b-c923-4879-96ca-94d69965d508"}`
Select a file to upload
Click Execute
Wait for a response. If the metadata field is not in a valid json format, an error message will appear. If "success": true, then your document will be uploaded to your dashboard with the rules you set in DOC²

XML Export#

This allows you to take the fields we provide to you and convert them into a format that suites your needs.Download a XSLT template here

Detailed information can be found here