Integration - DocExtractor

DocCloud allows you to extract the data from input document and POST the extracted data on a preferred Webhook. By design, the API response in asynchronous. We typically POST the data on the webhook provided in the input request within a couple of seconds.

In API request, a maximum document size of 10MB is allowed.

Endpoint: https://app.docscloud.io/api/v1/documentextractor

Method: POST

Request Body:

{
    "auth_id": "available in the profile section",
    "auth_token": "available in the profile section",
    "urn": "Optional - Unique Reference Number of request identificaiton. You will receive the same number in output response.",
    "file_path": "Input file path.",
    "file_type": "Input file formats. Valid values - png/pdf/jpeg.",
    "webhook_url": "Webhook when the output response should be delivered.",
    "output_format": "Required format of the output file."
}

output_format: Here is the list of output formats that can be requested along with the valid values,
Value: "1" - Output data in JSON,
Value: "2" - Output data in CSV,
Value: "3" - Output data in DOCX,
Value: "4" - Output data in HTML,
Value: "5" - Output data as ZIP folder (having JSON, CSV, DOCX & HTML files)

Response:

{
    "urn": "Optional - In case it was shared in the Input Request"
    "file_url": "URL of the output file.",
    "file_type": "Output file format. Depending upon the output_format. Valid values - json/csv/docx/html/zip.",
    "delete_date": "Date (YYYY-MM-DD) on which the input and the output data will get deleted from our servers."
}

API Response code

DocsCloud uses HTTP response status codes to indicate the success or failure of your API requests. If your request fails, DocsCloud returns an error using the appropriate status code. In general, there are three status code ranges you can expect:

  1. 2xx success status codes confirm that your request worked as expected
  2. 4xx error status codes indicate an error because of the information provided (e.g., a required parameter was omitted)
  3. 5xx error status codes are rare and indicate an error with DocsCloud servers.
Code Message
200

OK - Everything worked as expected.

400

Bad Request - The request was unacceptable, often due to missing a required parameter.

401

Unauthorized - No valid API key provided.

402

Request Failed - The parameters were valid, but the request failed.

403

Forbidden - The API key doesn't have permissions to perform the request.

404

Not Found - The requested resource doesn't exist.

409

Conflict - The request conflicts with another request (perhaps due to using the same idempotent key).

429

Too Many Requests - Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500/2/3/4

Server Errors - Something went wrong on DocsCloud's end.