Extract Endpoint

Endpoint

Authentication

All requests must include an API key in the request headers.

See Authentication for details.

Request

Request Headers

Request Body Parameters

File Requirements

Request Example

POST /sync HTTP/1.1
Host: apix.docdigitizer.com
x-api-key: dd_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files"; filename="invoice.pdf"
Content-Type: application/pdf

[Binary PDF data]
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="id"

550e8400-e29b-41d4-a716-446655440000
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="contextId"

123e4567-e89b-12d3-a456-426614174000
------WebKitFormBoundary7MA4YWxkTrZu0gW--
    

Response

Response Headers

Success Response (200 OK)

Response Body Schema

Output Object Schema

Each item in the Output array represents one detected document within the PDF.

Success Response Example

{
    "StateText": "COMPLETED",
    "TraceId": "ABC1234",
    "NumberPages": 3,
    "Output": [
        {
            "docType": "Invoice",
            "country": "PT",
            "pages": [1, 2],
            "schema": "Invoice_PT.json",
            "extraction": {
                "invoiceNumber": "INV-2024-001234",
                "invoiceDate": "2024-01-15",
                "dueDate": "2024-02-15",
                "vendorName": "Fornecedor Exemplo, Lda",
                "vendorTaxId": "PT509123456",
                "vendorAddress": "Av. da Liberdade, 100, 1250-096 Lisboa",
                "customerName": "Cliente Exemplo, SA",
                "customerTaxId": "PT501234567",
                "customerAddress": "Rua Augusta, 50, 1100-053 Lisboa",
                "subtotal": 1000.00,
                "taxRate": 23,
                "taxAmount": 230.00,
                "totalAmount": 1230.00,
                "currency": "EUR",
                "paymentTerms": "30 days",
                "bankAccount": "PT50 0035 0000 00000000000 00",
                "lineItems": [
                    {
                        "description": "Professional Services - January 2024",
                        "quantity": 40,
                        "unit": "hours",
                        "unitPrice": 25.00,
                        "amount": 1000.00,
                        "taxRate": 23
                    }
                ]
            }
        },
        {
            "docType": "Receipt",
            "country": "PT",
            "pages": [3],
            "schema": "Receipt_PT.json",
            "extraction": {
                "receiptNumber": "REC-2024-005678",
                "receiptDate": "2024-01-20",
                "amount": 1230.00,
                "paymentMethod": "Bank Transfer",
                "relatedInvoice": "INV-2024-001234"
            }
        }
    ]
}
    

Document Types

DocDigitizer automatically detects and extracts data from various document types.

Supported Document Types

See Schema Definition for detailed field specifications per document type.

Examples

cURL

curl -X POST https://apix.docdigitizer.com/sync \
  -H "x-api-key: dd_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6" \
  -F "files=@invoice.pdf" \
  -F "id=550e8400-e29b-41d4-a716-446655440000" \
  -F "contextId=123e4567-e89b-12d3-a456-426614174000"
    

PowerShell

$headers = @{
    "x-api-key" = "dd_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
}

$form = @{
    files = Get-Item -Path "invoice.pdf"
    id = "550e8400-e29b-41d4-a716-446655440000"
    contextId = "123e4567-e89b-12d3-a456-426614174000"
}

$response = Invoke-RestMethod -Uri "https://apix.docdigitizer.com/sync" `
    -Method Post -Headers $headers -Form $form

$response | ConvertTo-Json -Depth 10
    

Python

import requests

url = "https://apix.docdigitizer.com/sync"
headers = {"x-api-key": "dd_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"}

files = {"files": open("invoice.pdf", "rb")}
data = {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "contextId": "123e4567-e89b-12d3-a456-426614174000"
}

response = requests.post(url, headers=headers, files=files, data=data)
print(response.json())
    

JavaScript (Node.js)

const FormData = require('form-data');
const fs = require('fs');
const fetch = require('node-fetch');

const form = new FormData();
form.append('files', fs.createReadStream('invoice.pdf'));
form.append('id', '550e8400-e29b-41d4-a716-446655440000');
form.append('contextId', '123e4567-e89b-12d3-a456-426614174000');

fetch('https://apix.docdigitizer.com/sync', {
    method: 'POST',
    headers: {
        'x-api-key': 'dd_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
    },
    body: form
})
.then(res => res.json())
.then(data => console.log(JSON.stringify(data, null, 2)));
    

C# (.NET)

using var client = new HttpClient();
using var form = new MultipartFormDataContent();

client.DefaultRequestHeaders.Add("x-api-key", "dd_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6");

var fileContent = new ByteArrayContent(File.ReadAllBytes("invoice.pdf"));
fileContent.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");
form.Add(fileContent, "files", "invoice.pdf");
form.Add(new StringContent("550e8400-e29b-41d4-a716-446655440000"), "id");
form.Add(new StringContent("123e4567-e89b-12d3-a456-426614174000"), "contextId");

var response = await client.PostAsync("https://apix.docdigitizer.com/sync", form);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
    

PHP

<?php
$curl = curl_init();

$postFields = [
    'files' => new CURLFile('invoice.pdf', 'application/pdf'),
    'id' => '550e8400-e29b-41d4-a716-446655440000',
    'contextId' => '123e4567-e89b-12d3-a456-426614174000'
];

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://apix.docdigitizer.com/sync',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $postFields,
    CURLOPT_HTTPHEADER => [
        'x-api-key: dd_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
    ]
]);

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

echo $response;
?>
    

Rate Limits

API requests are subject to rate limiting to ensure fair usage.

Rate Limit Headers

Contact sales@docdigitizer.com for higher rate limits.

Errors

HTTP Status Codes

Error Response Format

{
    "StateText": "ERROR",
    "TraceId": "XYZ9876",
    "Messages": [
        "Error description here"
    ]
}
    

Common Errors

See Error Handling for best practices on handling errors.