Documentation

 

VINocr Web Service API


Please note that the output VIN from the VINocr Web Service might require a further sanity check, since there are a lot of complications that can arise during the recognition and translation process. Still, proofreading your VIN will be a lot faster and easier than having to type it all in, one character at a time.

To achieve the highest possible recognition speed the image size is a key factor. To achieve the highest possible recognition rate the image quality is a key factor.

Do Not Send The Same Image More Than Once

Our system will take one credit off from your account balance when XML resuslt is returned regardless of what the result turns out

to be. So please be sure to have a mechanism in place in your system to prevent the same image from being sent to the web service more than once.

REST API Description

This API uses multipart POST HTTP method. Ensure your POST is a multipart/form-data request. The following three parameters and their values are required.

Parameter Name Parameter Value Used in URL
API Key accesscode xxxxx-xxxxx-xxxxx-xxxxx POST http://www.recognition.ws/vinocr/v1?accesscode=xxxxx-xxxxx-xxxxx-xxxxx&saveimage=TRUE
Input Image* Image File* JPG, JPEG, PNG, GIF, BMP POST http://www.recognition.ws/vinocr/v1?acccesscode=xxxxx-xxxxx-xxxxx-xxxxx&saveimage=TRUE
Save Image** saveimage** TRUE or FALSE (default: FALSE) POST http://www.recognition.ws/lpr/v1?acccesscode=xxxxx-xxxxx-xxxxx-xxxxx&saveimage=TRUE
* Only one image file is allowed in a POST request. A POST request with multiple files would be rejected immediately. Only the first found VIN will be processed if an input image contains more than one VIN.
** Set parameter "saveimage" to "TRUE" if you'd like our system to save the input image so that later you can log in to your account to review it. Set the value of this parameter to "FALSE" otherwise.

        
<html>
   <form enctype="multipart/form-data" action="http://www.recognition.ws/vinocr/v1?accesscode=xxxxx-xxxxx-xxxxx-xxxxxx&saveimage=FALSE" method="POST">
      Choose an image to process: <input name="anyName" type="file" />
      <input type="submit" value="Go" />
   </form>
</html>
        
    

 

Input Image Specs

VIN characters have to meet the specification of at least 25 pixels high characters. In general, OCR can decode characters lower than this requirement but not at the extremely high(99.8%) accuracies required.

Input Image Specs
Height of the VIN portion in an input image 20 - 150 pixels
Width of the VIN portion in an input image 80 - 400 pixels
Length of a VIN 17 characters
Size of Input Image < 2.0 MB

Output in XML

  • VIN: VIN number in ASCII
  • Position of the VIN portion in an input image: Top(pixels), Left(pixels), Width(pixels), Height(pixels). The origin(0,0) is the top-left corner of an input image.
        
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<VINocr Version="1.0.0" Date="12/14/2015 3:23:58 PM" Status="SUCCESS">
  <VIN_Captured>XXXXXXXXXXXXXXXXX</VIN_Captured>
  <Left>left</Left>
  <Top>top</Top>
  <Width>width</Width>
  <Height>height</Height>
</VINocr>
        
    

Error Codes

Error Code (Key) Description (Value)
0 Database Errors.
23 Insufficient balance for Recognition.
25 No image has been uploaded.
26 Recognition failed.
27 Unknown erro(s) occured.
29 One or more required parameters missing.
        
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<VINocr version="1.0.0" Date="5/28/2015 1:39:10 PM" Status="FAILED">
  <Message Key="0" Value="Database Errors." />
</VINocr>