New to Corsair? See API access, authentication, and error handling.
Ocr
getUsage
ocr.getUsage
Read the OCR calls used this period and the plan limit.
Risk: read
usage full type
usage full type
read
ocr.read
Read a VIN, trailer id, odometer, shipping container, boat registration or C-TPAT seal from an image. Uses one OCR call; takes 20 to 30 s.
Risk: read
POST /v1/ocr/reader/ with a
type (vin, trailer_id, odometer, shipping_container, boat_reg_number, seal_ctpat) and the image as upload or uploadUrl. Results differ by type. Takes 20 to 30 seconds per image.
Output
results full type
results full type
Plates
read
plates.read
Read license plates (and optionally make, model and color) from an image. Uses one Snapshot lookup. Plate text is not stored.
Risk: read
POST /v1/plate-reader/. Send the image as base64 in
upload or as a public uploadUrl, not both. regions takes country or state codes. mmc adds make, model, color and orientation (a paid add-on); direction needs mmc. config takes engine settings such as { detection_mode: 'vehicle' }, which also returns vehicles without a plate; in that mode each result’s plate is an object or null instead of a string.
Output
results full type
results full type
Usage
get
usage.get
Read the current Snapshot usage period.
Risk: read
usage full type
usage full type