Skip to main content

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

ConceptDescription
ShipmentA trade transaction with parties, route, goods, and packaging
ExtractionAI-powered data extraction from uploaded documents
ValidationDeterministic business rule checking against reference data
GenerationPDF document creation from validated shipment data
VerificationHash-based document authenticity verification

Communication Patterns

OperationPatternResponse Time
ValidationSynchronousUnder 1 second
ExtractionAsynchronous (poll)5-30 seconds
GenerationAsynchronous (poll)2-10 seconds per document
CRUDSynchronousUnder 500ms

Rate Limits

TierRequests/minuteExtractions/dayValidations/day
Free6010100
Starter3001005,000
Growth60050050,000
Scale1,2002,000200,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.