API Documentation

 

Architecture and Concepts


VINquery.com APIs enable client applications to access a suite of VIN decoding, machine learning, and object recognition algorithms through representational state transfer (REST). A key feature of the REST architecture is the stateless communication between client and server. The client initiates requests, the server processes them, returns responses, and each transaction is completed independently. This documentation provides a technical description of the real-time APIs offered by VINquery.com.

To maintain reliability and stability in our demo and production environments, VINquery.com enforces API call efficiency guidelines. We continually monitor API usage to ensure effective load balancing and will reach out to developers if their usage places an unnecessary burden on the system. Applications are restricted from polling for service status more than once every 15 minutes.

 

Resources

There are two types of resources associated with these services: images and 17-character text string(representing a VIN). Uploaded images can be any MIME type, such as JP(E)G, PNG, BMP, GIF. The object recognition algorithms currently work on 32-bit/24-bit/8-bit grayscale images, so images are converted to 32-bit/24-bit/8-bit grayscale before being submitted to the recognition engines.

RESTful APIs

All requests are sent using HTTP GET or HTTP POST methods, and API responses are in XML or Json format.

REST API HTTP Type Base URL
VINdecode API 2.0 GET https://ws.vinquery.com/vindecode/v2
VINfix API 2.0 GET https://www.recognition.ws/vinfix/v2
VINocr API 2.0 POST https://www.recognition.ws/vinocr/v2
VINbarcode API 2.0 POST https://www.recognition.ws/vinbarcode/v2
VMMR API 1.0 POST https://vmmr.recognition.ws/v1
LPR API 2.0 POST https://lpr.recognition.ws/v2

HTTP Status Codes

All VINquery.com APIs return the following HTTP status codes:

HTTP Status Code Description
200 Success Request
400 Bad Request
500 Internal Server Error