Automatic document field detection

Our parsers intelligently recognizes and auto-detects unique fields from uploaded documents.

Document language detection

Detect the language in scanned or printed documents, images, and PDFs.

Optical Character Recognition (OCR)

Convert scanned or printed documents, including images and PDFs, into machine-readable text.

Integration and automation

Our document parsers can be integrated into existing software systems or workflows.

Automatic document field detection API

Parse Documents provides a robust suite of APIs designed to handle all your document parsing requirements. Our aim is to simplify the complex process of document management, be it retrieval, parsing, or error handling. This includes effortless pagination, a plethora of supported document types, and meticulous error detail.

Versatility and Flexibility

Through our versatile APIs, you can not just retrieve uploaded documents but also queue documents for parsing either via a direct upload or through an external link. Our APIs are designed keeping in mind the dynamic nature of businesses and therefore, they seamlessly cater to varying business needs and configurations.

Swagger Configuration

The APIs are coded following the OpenAPI Specification (OAS), making the integration process hassle-free and straightforward. We provide complete Swagger UI-based documentation that details the potential responses and possible status and error codes.

Your Security, Our Priority

All API requests are authenticated via JWT headers for maximum security. This ensures that your sensitive document data remains protected at all times.

Let's Get Started

We are thrilled to have you onboard and can't wait to see how you integrate and maximize the utility of Parse Documents in your document management operations!

Please make sure to replace "YourAuthTokenHere" with your actual bearer token.
Get document list
GET /v1/documents

A GET method that fetches the details of uploaded documents from ParseDocuments.com. The results can be filtered and paginated using specific query parameters.

Example Request
GET /v1/documents?page=0
Query Parameters
  • status (optional): Status filter conditions:
    • 0 - Processing
    • 1 - Completed
    • 2 - Failed
  • period (optional): Export filter conditions:
    • 0 - Last File
    • 1 - Last 100 Files
    • 2 - Last 1000 Files
    • 3 - Last 10000 Files
    • 4 - Files Received Today
    • 5 - Files Received Yesterday
    • 6 - Files Received During Last 24 Hours
    • 7 - Files Received During Last 48 Hours
    • 8 - Files Received During Last 3 Days
    • 9 - Files Received During Last 5 Days
    • 10 - Files Received During Last 7 Days
    • 11 - Files Received During Last 2 Weeks
    • 12 - Files Received During Last 3 Weeks
    • 13 - Files Received During Last 4 Weeks
    • 14 - Files Received This Month
    • 15 - Files Received Last Month
    • 16 - Files Received Since Last Download
  • used (optional): Last used date (used by "FilesReceivedSinceLastDownload - Files Received Since Last Download" filter condition). Format: YYYY-MM-DD
  • confirmed (optional): Filter only confirmed documents (true/false or null for all)
  • page (optional): The page number for pagination.
Responses
  • 200 Success: Returns a list of uploaded document details.
  • 404 Not Found: The requested document is not found.
  • 400 Bad Request: The request was made incorrectly.
import requests

url = "https://.cargoinvoice.com/v1/documents"

querystring = {
    "status": "0",
    "period": "0",
    "used": "2022-01-01",
    "confirmed": "true",
    "page": "0"
}

headers = {
    "Authorization": "Bearer " + 'YourAuthTokenHere'
}

response = requests.get(url, headers=headers, params=querystring)
response.raise_for_status()

print(response.text)
package main

import (
    "fmt"
    "net/http"
    "net/url"
)

func main() {
    url := "https://.cargoinvoice.com/v1/documents"

    params := url.Values{
        "status": {"0"},
        "period": {"0"},
        "used": {"2022-01-01"},
        "confirmed": {"true"},
        "page": {"0"},
    }

    req, err := http.NewRequest("GET", url, nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }

    req.URL.RawQuery = params.Encode()
    req.Header.Set("Authorization", "Bearer "+YourAuthTokenHere)

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making GET request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response body:", err)
        return
    }

    fmt.Println(string(body))
}
<?php
$url = "https://.cargoinvoice.com/v1/documents";

$queryParams = [
    "status" => "0",
    "period" => "0",
    "used" => "2022-01-01",
    "confirmed" => "true",
    "page" => "0"
];

$headers = [
    "Authorization: Bearer " . 'YourAuthTokenHere'
];

$url .= '?' . http_build_query($queryParams);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$error = curl_error($ch);

curl_close($ch);

if ($error) {
    echo "Error: " . $error;
} else {
    echo $response;
}
using System;
using System.Net.Http;

public class Program
{
    private static readonly HttpClient client = new HttpClient();

    public static void Main(string[] args)
    {
        GetDocumentList().Wait();
    }

    private static async Task GetDocumentList()
    {
        try
        {
            client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", "YourAuthTokenHere");

            var queryParams = new System.Collections.Specialized.NameValueCollection
            {
                { "status", "0" },
                { "period", "0" },
                { "used", "2022-01-01" },
                { "confirmed", "true" },
                { "page", "0" }
            };

            var query = new System.Net.Http.FormUrlEncodedContent(queryParams);
            var requestUri = new UriBuilder("https://.cargoinvoice.com/v1/documents")
            {
                Query = query.ReadAsStringAsync().Result
            };

            var response = await client.GetAsync(requestUri.ToString());
            response.EnsureSuccessStatusCode();

            string responseBody = await response.Content.ReadAsStringAsync();

            Console.WriteLine(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Error: {e.Message}");
        }
    }
}

In this code, we define a simple program with a single method `GetDocumentList`.

This method first sets up the authentication header by adding the bearer token to the HttpClient's default headers.

Then, it constructs the query parameters using a `System.Collections.Specialized.NameValueCollection` object.

It converts the query parameters to a `System.Net.Http.FormUrlEncodedContent` object and appends it to the request URL using a `System.Net.UriBuilder`.

If the request fails for any reason, an HttpRequestException will be thrown and the method will catch it and print the error message to the console.

If the request is successful, the method will read the response body as a string and print it to the console.

Query Parameters:

  • status (optional): Status filter conditions (0-2).
  • period (optional): Export filter conditions (0-16).
  • used (optional): Last used date (YYYY-MM-DD format).
  • confirmed (optional): Only filter confirmed documents (true/false).
  • page (optional): The page number for pagination.
Retrieve document details
GET /v1/documents/{id}

A GET method that retrieves the details of a specific document from ParseDocuments.com using its primary key.

Example Request
GET /v1/documents/1
Path Parameters
  • id: The primary key of the document.
Responses
  • 200 Success: Returns the details of the requested document.
  • 404 Not Found: The requested document is not found.
  • 400 Bad Request: The request was made incorrectly.
import requests

url = "https://.cargoinvoice.com/v1/documents/1"
headers = {
    "Authorization": "Bearer YourAuthTokenHere"
}

response = requests.get(url, headers=headers)
print(response.text)
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    url := "https://.cargoinvoice.com/v1/documents/1"
    req, _ := http.NewRequest("GET", url, nil)
    req.Header.Set("Authorization", "Bearer "+Model)

    client := &http.Client{}
    response, _ := client.Do(req)

    defer response.Body.Close()

    body, _ := ioutil.ReadAll(response.Body)

    fmt.Println(string(body))
}
<?php
$url = "https://.cargoinvoice.com/v1/documents/1";
$headers = array(
    "Authorization: Bearer " . Model
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);

curl_close($ch);

echo $response;
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    private static readonly HttpClient client = new HttpClient();

    static void Main(string[] args)
    {
        GetDocumentDetails(1).Wait();
    }

    private static async Task GetDocumentDetails(int id)
    {
        try
        {
            client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", Model);

            var response = await client.GetAsync($"https://.cargoinvoice.com/v1/documents/{id}");
            response.EnsureSuccessStatusCode();

            string responseBody = await response.Content.ReadAsStringAsync();

            Console.WriteLine(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Error: {e.Message}");
        }
    }
}

In this code, we define a simple program with a single method `GetDocumentDetails` that takes the document ID as an input parameter.

This method first sets up the authentication header by adding the bearer token to the HttpClient's default headers.

Then, it constructs the request URL by appending the document ID to the base URL.

If the request fails for any reason, an HttpRequestException will be thrown and the method will catch it and print the error message to the console.

If the request is successful, the method will read the response body as a string and print it to the console.

Path Parameters:

  • id: The primary key of the document.
Trigger document webhook
GET /v1/documents/webhook/{id}

A GET method that triggers the webhook for a specific document identified by its primary key.

Example Request
GET /v1/documents/webhook/123
Path Parameters
  • id: The primary key of the document
Responses
  • 200 Success: Returns the webhook information for the document.
  • 404 Not Found: The requested document is not found.
  • 400 Bad Request: The request was made incorrectly.
import requests

def trigger_webhook():
    try:
        url = "https://example.com/v1/documents/webhook/123"
        headers = {"Authorization": "Bearer YOUR_TOKEN"}
        response = requests.get(url, headers=headers)
        response.raise_for_status()

        print(response.text)
    except requests.exceptions.RequestException as e:
        print("Error:", e)

trigger_webhook()
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    triggerWebhook()
}

func triggerWebhook() {
    url := "https://example.com/v1/documents/webhook/123"
    req, _ := http.NewRequest("GET", url, nil)
    req.Header.Set("Authorization", "Bearer YOUR_TOKEN")

    client := &http.Client{}
    resp, _ := client.Do(req)

    defer resp.Body.Close()

    body, _ := ioutil.ReadAll(resp.Body)

    fmt.Println(string(body))
}
<?php

function triggerWebhook() {
    $url = "https://example.com/v1/documents/webhook/123";
    $headers = [
        "Authorization: Bearer YOUR_TOKEN"
    ];

    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    curl_close($ch);

    echo $response;
}

triggerWebhook();
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    private static readonly HttpClient client = new HttpClient();

    static void Main(string[] args)
    {
        TriggerWebhook().Wait();
    }

    private static async Task TriggerWebhook()
    {
        try
        {
            client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", "YOUR_TOKEN");

            var id = "123";
            var requestUri = new Uri($"https://example.com/v1/documents/webhook/{id}");

            var response = await client.GetAsync(requestUri.ToString());
            response.EnsureSuccessStatusCode();

            string responseBody = await response.Content.ReadAsStringAsync();

            Console.WriteLine(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Error: {e.Message}");
        }
    }
}

In this code, we define a simple program with a single method `TriggerWebhook`.

This method first sets up the authentication header by adding the bearer token to the HttpClient's default headers.

Then, it constructs the request URL by appending the document ID to the base URL.

If the request fails for any reason, an HttpRequestException will be thrown and the method will catch it and print the error message to the console.

If the request is successful, the method will read the response body as a string and print it to the console.

Path Parameters:

  • id: The primary key of the document.
Generate a Download Link for the Document
GET /v1/documents/download/{id}

A GET method that generates a download link for the requested document with the specified primary key.

Example Request
GET /v1/documents/download/12345
Path Parameters
  • id: The primary key of the document
Responses
  • 200 Success: Returns the generated download link for the document.
  • 404 Not Found: The requested document is not found.
  • 400 Bad Request: The request was made incorrectly.
import requests

def get_download_link():
    try:
        headers = {
            "Authorization": "Bearer YOUR_ACCESS_TOKEN"
        }
        url = "https://YOUR_BASE_URL/v1/documents/download/12345"
        response = requests.get(url, headers=headers)
        response.raise_for_status()
        print(response.text)
    except requests.exceptions.RequestException as e:
        print("Error:", str(e))

get_download_link()
package main

import (
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    getDownloadLink()
}

func getDownloadLink() {
    url := "https://YOUR_BASE_URL/v1/documents/download/12345"
    req, err := http.NewRequest("GET", url, nil)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }

    fmt.Println(string(body))
}
        
<?php

function getDownloadLink() {
    $url = "https://YOUR_BASE_URL/v1/documents/download/12345";
    $headers = array(
        "Authorization: Bearer YOUR_ACCESS_TOKEN"
    );

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    curl_close($ch);

    echo $response;
}

getDownloadLink();
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    private static readonly HttpClient client = new HttpClient();

    static void Main(string[] args)
    {
        GetDownloadLink().Wait();
    }

    private static async Task GetDownloadLink()
    {
        try
        {
            client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", "YOUR_ACCESS_TOKEN");

            var response = await client.GetAsync("https://YOUR_BASE_URL/v1/documents/download/12345");
            response.EnsureSuccessStatusCode();

            string responseBody = await response.Content.ReadAsStringAsync();

            Console.WriteLine(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Error: {e.Message}");
        }
    }
}

In this code, we define a simple program with a single method `GetDownloadLink`.

This method first sets up the authentication header by adding the bearer token to the HttpClient's default headers.

Then, it makes a GET request to the specified URL to fetch the download link for the document with the primary key `12345`.

If the request fails for any reason, an HttpRequestException will be thrown and the method will catch it and print the error message to the console.

If the request is successful, the method will read the response body as a string and print it to the console.

Path Parameters:

  • id: The primary key of the document