Quick Start
Get up and running with CargoLint in under 5 minutes. Upload your first document and get structured data back.
Get Started in 5 Minutes
CargoLint reads your trade documents, checks them, and gives you structured data back. Sign up, upload a document, and see the results.
Choose Your Path
Using the dashboard? Follow the steps below, then explore the How-To Guides for detailed walkthroughs of every feature.
Building an integration? Start with the steps below to understand the basics, then head to Authentication and the API Reference to start coding.
Step 1: Sign Up for Your Account
Visit the CargoLint dashboard and create an account. Signing up from a paid plan’s free-trial button on the pricing page starts a 14-day trial with Professional features - no credit card required. When the trial ends, your workspace moves to the free Starter plan with 10 documents per month. Signing up without a trial starts on Starter.
Step 2: Upload Your First Document
You can upload documents directly through the dashboard using drag-and-drop, or use the API.
Via the Dashboard:
- Log in to your dashboard
- Drop a file on the upload area, or click Browse files
- Choose New shipment in the Group as picker and confirm. CargoLint works out what kind of document it is and extracts the data
Via the API (requires Business or Enterprise plan):
First, generate your API key in Settings > Integrations > API Keys.
curl -X POST https://api.cargolint.com/api/v1/documents \
-H "X-API-Key: cl_YOUR_API_KEY" \
-F "file=@invoice.pdf"
Supported file types: PDF, PNG, JPG, TIFF (max 20 MB)
Step 3: View Your Results
Open the document from your Documents list to see the extracted fields and the document’s Quality score. Each field is green when nothing is wrong with it, amber for a warning and red for a problem that needs fixing; hovering it says why.
Every document a person needs to sign off lands in the Review Queue. Documents with reading problems - or with HS codes waiting for confirmation, or another reason to hold them - are in Review, where you correct fields and approve. Documents that read cleanly wait in Pending Approval for one-click sign-off.
If you’re using the API, poll the document until it finishes processing, then fetch the extracted fields:
curl https://api.cargolint.com/api/v1/documents/{id} \
-H "X-API-Key: cl_YOUR_API_KEY"
curl "https://api.cargolint.com/api/v1/documents/{id}/extractions" \
-H "X-API-Key: cl_YOUR_API_KEY"
Your First Upload walks through the responses.
What CargoLint Reads
CargoLint identifies each document’s kind on its own. It reads and checks commercial invoices, packing lists, bills of lading, air waybills, road and rail consignment notes, certificates of origin, insurance certificates, dangerous goods declarations, phytosanitary certificates and health certificates. Other trade documents, such as cargo manifests, customs declarations or CITES permits, are recognized and kept with their shipment, but not read yet. See Document Types.
Next Steps
For dashboard users:
- How to upload documents - detailed upload guide with tips
- How to review extracted data - using the review queue
- Working with shipments - cross-document checks and expected documents
- How to read the Quality score - what the score and its colours mean
For developers:
- Authentication - API keys and auth methods
- Your First Upload - detailed API upload walkthrough
- API Reference - full endpoint documentation