Skip to main content

Overview

The Data Extraction APIs provide document processing capabilities to extract structured data from various document types including shipping bills and invoices.

Base URL

All Data Extraction API requests should be made to:
https://tradelens-apis.dev.eximfiles.com/platform

Authentication

Data Extraction APIs use a different authentication system. Include your Tradelens API key in the request headers:
x-api-key: TRADELENS_API_KEY
accept: application/json
The Data Extraction APIs use a separate API key system from the main eBRC APIs. Contact support to obtain your Tradelens API key.

Supported Document Types

Shipping Bills

Extract key information from shipping bill documents including:
  • Exporter details
  • Consignee information
  • Product descriptions
  • Quantities and values
  • Shipping details

Invoices

Extract structured data from invoice documents including:
  • Vendor/supplier information
  • Line items and descriptions
  • Amounts and totals
  • Tax information
  • Payment terms

Request Format

  • All requests use multipart/form-data encoding
  • Upload documents as file attachments
  • Supported file formats: PDF
  • Maximum file size: 5MB per document

Response Format

Extraction APIs return structured JSON data containing:
{
  "status": "success",
  "data": {
    // Document-specific extracted data
  }
}

Error Handling

Common error responses:
  • 400 - Invalid file format or corrupted document
  • 401 - Invalid or missing API key
  • 413 - File size exceeds limit
  • 422 - Document processing failed
  • 429 - Rate limit exceeded
  • 500 - Internal processing error

Best Practices

  1. File Quality: Use high-resolution, clear PDF documents for best extraction accuracy
  2. Rate Limiting: Implement appropriate delays between requests to avoid rate limits
  3. Error Handling: Always check response status and handle extraction failures gracefully

Need Help?

Contact Support

For help with Data Extraction APIs, email us at [email protected]