What does the checker verify on a API documentation?

Container check digits against ISO 6346, weight and unit consistency, date coherence, Incoterm and port-code sanity, required-field presence and more — 24 checks in total, each reported with the field it applies to.

Is my document stored?

No. The file stays in memory while it is processed and is never written to disk. The result is deleted automatically within 24 hours, and documents are never used to train models.

How much does it cost?

The first 3 documents every month are free. Paid plans start at $19 per month for 50 documents. A one-off Batch Pack covers 5,000 documents.

API Documentation

API documentation — the integrator entry point Runs on Bill of Lading documents only, with results deleted within 24 hours.

Try the API

This posts to POST /api/v1/parse on this deployment, with the same quota that applies to any anonymous caller.

curl -X POST https://your-deployment/api/v1/parse \
  -H "content-type: application/json" \
  -H "authorization: Bearer $BOLCHECK_API_KEY" \
  -d '{"text":"B/L NO: COSU1234567890"}'

Endpoints

Method	Path	Purpose
POST	/api/v1/parse	Validate a document. multipart/form-data with `file`, or JSON with `text`.
GET	/api/v1/jobs/:id	Fetch a result (or poll a queued document).
DELETE	/api/v1/jobs/:id	Delete a result immediately.
GET	/api/v1/jobs/:id/export	Download the result as CSV or JSON (`?format=csv`).
POST	/api/v1/check-container	Free container-number and check-digit validation. No quota.
GET	/api/v1/entitlement	Current quota for the calling key or address.
GET	/api/v1/health	Deployment health: database, configuration, model connectivity.

Error codes

Status	Code	Meaning
400	invalid_input	The request is missing something or asks for an unsupported document type.
401	missing_api_key	The API key is absent, invalid or revoked.
402	quota_exceeded	The allowance for this period is used up. The response carries an upgrade link.
413	file_too_large	Over 20 MB.
415	unsupported_type	Not a PDF, image or text file. The type is decided by content, not by filename.
422	unreadable_document	The document could not be read. Scans need the vision engine, and we never guess.
429	rate_limited	Too many requests; the response carries Retry-After.
500	internal_error	Our fault. The request id is in the response for support.

Notes for integrators

· The document type is decided by the file's content, so a wrong filename cannot break a submission.
· Bills of Lading only. Packing lists and customs documents are a separate, fixed-price integration.
· Rate limits are per key; the response carries Retry-After when they bite.
· Results are deletable on demand and expire in 24 hours, so fetch what you need.

What gets checked

33 Bill of Lading fields are looked for, and 24 rules run over them. Every finding names the field it applies to, so it can be fixed in the source document.

· B/L No. (required)
· Booking No.
· B/L Type
· Place of Issue
· Date of Issue (required)
· Shipped on Board
· No. of Original B/L
· Carrier
· Shipper (required)
· Consignee (required)
· Notify Party
· Delivery Agent
· Place of Receipt
· Port of Loading (required)
· Port of Discharge (required)
· Place of Delivery
· Vessel (required)
· Voyage No.
· Marks & Numbers
· No. of Packages (required)
· Package Unit
· Description of Goods (required)
· Gross Weight (required)
· Net Weight
· Measurement
· HS Code
· Container Count
· Container Type
· Freight Terms
· Incoterms
· Declared Value
· Currency
· Place of Payment

Questions

What does the checker verify on a API documentation?: Container check digits against ISO 6346, weight and unit consistency, date coherence, Incoterm and port-code sanity, required-field presence and more — 24 checks in total, each reported with the field it applies to.
Is my document stored?: No. The file stays in memory while it is processed and is never written to disk. The result is deleted automatically within 24 hours, and documents are never used to train models.
How much does it cost?: The first 3 documents every month are free. Paid plans start at $19 per month for 50 documents. A one-off Batch Pack covers 5,000 documents.