Overview
The Data Extraction APIs turn export documents into structured JSON. Extract rows from shipping bill PDFs to prepare a bulk eBRC upload, or pull billing data out of invoice PDFs.Base URL
All Data Extraction API requests should be made to:Authentication
These endpoints authenticate with a Tradelens API key, a separate key from your eBRC API key, sent in the same header style:Supported document types
Shipping bills
Exporter details, consignee information, product descriptions, quantities and values, and shipping details. Two variants: eBRC-specific fields or the complete document.Invoices
Vendor and supplier information, line items, amounts and totals, tax information, and payment terms. See Extract Invoice Data.Request format
- All requests use
multipart/form-dataencoding - Upload documents as file attachments
- Supported file format: PDF
- Maximum file size: 5 MB per document
Response format
Extraction responses are JSON with astatus and a document-specific data object:
Error handling
400- Invalid file format or corrupted document401- Invalid or missing API key413- File size exceeds limit422- Document processing failed429- Rate limit exceeded500- Internal processing error
Related
- Bulk Upload via Excel to file what you extracted.
- Environments and Base URLs for all hosts in one place.
- Errors for the core API’s error conventions.
Need help?
Contact us
For help with Data Extraction APIs, email amin@eximfiles.io