API Calls Examples

API Calls for Document Upload and Status Check

API integration provides functions and services that connect applications and processes. In this guide, we will show you how to make API calls through api.polydocs.io for document upload and status check.

Authentication

To make API calls, authentication is the first step. Follow the steps below to authenticate:

Open api.polydocs.io.
Click on Authorize in the upper right corner.
Enter your API Key and confirm by clicking Authorize.

Upload Document

To upload a document, follow the steps below:

After authentication, scroll down to the POST /document/process endpoint.
Open the tab and click on Try it out in the upper right corner.
Enter the following value in the source field: email:{Pattern name}.
Select the file you want to upload and click Execute.

Your document will be uploaded to your dashboard with the rules you set in DocBits.

Document Status Check

To check the status of a document, follow the steps below:

After authentication, scroll down to the GET /document/status endpoint.
Open the tab and click on Try it out in the upper right corner.
Enter the document ID in the doc-id field. You can find the document ID when you open the document on the dashboard. This is the last part of the URL when the document is open.

You will receive the following response

If the status is “Ready For Validation,” it means that the user can check the document.

Upload Document with Metadata

To upload a document with metadata, follow the steps below:

After authentication, scroll down to one of these endpoints: /document/process_documents, /document/process, or /document/process_base64.
Open the tab and click on Try it out in the upper right corner.
Enter the metadata in the metadata field. The metadata needs to be in a valid JSON format. An example of a metadata entry would be: {"custom-key": "the custom value", "custom_doc_id": "8a5cf33b-c923-4879-96ca-94d69965d508"}.
Select a file to upload.
Click Execute.
Wait for the response. If the metadata field is not a valid JSON, an error message will appear. If “success”: true, then your document will be uploaded to your dashboard with the rules you set in DocBits.

By following these simple steps, you can easily make API calls for document upload and status checks.