Developer Guide
Build integrations with the Klervex API.
Architecture
Klervex exposes a REST API backed by Supabase Edge Functions. All heavy processing is delegated to Rynko platform services:
Key Concepts
| Concept | Description |
|---|---|
| Shipment | A trade transaction with parties, route, goods, and packaging |
| Extraction | AI-powered data extraction from uploaded documents |
| Validation | Deterministic business rule checking against reference data |
| Generation | PDF document creation from validated shipment data |
| Verification | Hash-based document authenticity verification |
Communication Patterns
| Operation | Pattern | Response Time |
|---|---|---|
| Validation | Synchronous | Under 1 second |
| Extraction | Asynchronous (poll) | 5-30 seconds |
| Generation | Asynchronous (poll) | 2-10 seconds per document |
| CRUD | Synchronous | Under 500ms |
Rate Limits
| Tier | Requests/minute | Extractions/day | Validations/day |
|---|---|---|---|
| Free | 60 | 10 | 100 |
| Starter | 300 | 100 | 5,000 |
| Growth | 600 | 500 | 50,000 |
| Scale | 1,200 | 2,000 | 200,000 |
Error Format
All API errors follow a consistent format:
{
"error": {
"code": "KLV_VALIDATION_001",
"message": "HS code 9999.99.9999 not found in US HTS schedule",
"field": "goods.line_items[0].hs_code"
}
}
See Error Codes for the full reference.