VIN OCR

string required

An application id. You can get the id of an application by clicking on 'details' in your panel

string required

The API KEY of the application that makes the call to this API, you can obtain it in your panel, by clicking on the 'details' button of an application

file required

A jpg or png image to be scanned that may contain one or more VIN codes

Required if you don't send the image_url parameter

string required

An http or https address where the image to be scanned is available, and which may contain one or more VIN codes

Required if you don't send the image parameter

array optional

When the image does not have a good quality, it is possible that there are confusions between different valid VIN codes, the score_filters array allows you to alter the internal score that different VIN codes receive based on data such as manufacturing area, country of manufacture, manufacturer or brand.

score_filters must contain an array of elements, each of them indicating a filter and a score in case that filter is met

[
	{
		"zone": "*america*",
		"country": "*",
		"manufacturer": "*",
		"brand": "*",
		"score": -0.3
	},
	{
		"zone": "*africa*",
		"country": "*",
		"manufacturer": "*",
		"brand": "*",
		"score": 1
	},
	{
		"zone": "*",
		"country": "*",
		"manufacturer": "*motorcycle*",
		"brand": "*",
		"score": -20
	},
	{
		"zone": "*",
		"country": "*",
		"manufacturer": "*truck*",
		"brand": "*",
		"score": -20
	}

]

In this example, three filters have been applied to alter the score, giving priority to vehicles manufactured in Africa, and penalizing those manufactured in America. Additionally, it is desired to filter out those manufacturers of tractors, and motorcycles.

• Vehicles manufactured in Africa will receive an extra +1 on their score
• Vehicles made in America will receive a -1 penalty on the score
• All manufacturers of motorcycles, or trucks will receive a -20 penalty on their score.

boolean optional, default: false

If wildcard_at_end is specified, the VINS scanner will be allowed to add an asterisk* to those VINS that were found to be missing a character at the end of the code.

For example, given the VIN code L6TCX2E70ME00515, where a character is missing, the API will determine that the missing character is the last one, and will return as the main VIN code: L6TCX2E70ME00515*

This option can be used to try to determine the correct code in your own vehicle database if you have one.

boolean optional, default: false

If set to true, the response will contain a new element considered_vins that will contain an array with all the VINS considered in the vision analysis and their scores.

A boolean with value true if your request could be processed. Or false, in case of errors.

An array that will contain all the VINs that have been sent, along with the extracted data and an analysis of the validity of each VIN code.

See the following table for details on the elements of this array.

Detailed information on the cost of the request sent, where:

The VIN that the API finally processed, this VIN could be corrected if a possible typing error was detected, or if there were any characters missing from the submitted code that could be automatically deduced.

The number that was read by the OCR, unprocessed. Can match vin_number if no correction was necessary

A boolean indicating whether the final VIN is considered correct or not. In those manufacturers or countries where a control digit is used, this is considered when determining if the VIN is correct or not.

In the event that the submitted VIN has been corrected by the API as it is considered incorrect, it will be true

The year of manufacture of the vehicle if it can be calculated.

The WMI (World Merchant Identifier) code of the VIN. A manufacturer identifier.

VIS Section (Vehicle Identification Section), the code that each manufacturer uses at its discretion internally to determine the vehicle and its characteristics.

The manufacturer's serial number, used by manufacturers internally and at their discretion.

Manufacturer name.

If there is evidence that this manufacturer does or does not use the manufacturing plant code internally, true if so.

A one-character code that identifies the vehicle's manufacturing plant.

Manufacturer code, usually the same as WMI, with exceptions for some countries and manufacturers.

Whether this manufacturer uses a check digit or not. Dependent on manufacturers, and geographical areas, with some exceptions.

true if yes.

For vehicles that use this digit, the API performs extra checks to better determine if the VIN code provided is correct or not.

The check digit extracted from the VIN that was provided to the API. Before possible corrections.

The check digit expected for this manufacturer.

Whether the provided check digit is correct or not. To determine the final vin code, this validation is ignored in case the manufacturer does not use a check digit.

Indicates if it is a manufacturer with a low production volume. Multiple manufacturers of these vehicles are often grouped under the same manufacturer code.

An array of strings containing the names of the brands involved in the production and/or manufacturing of the vehicle. In most cases it usually contains a single element.

The country where the vehicle was manufactured or assembled.

The geographic area where the vehicle was assembled or manufactured.

Possible values: Africa, Asia, Europe, North America, South America y Oceania

The VIN code as it was sent in your request, before it is corrected in case of detecting errors.

A list of the VINs that were considered during the autocorrection phase, in case the vin was considered correct as provided to the API will contain a single element.

In the event that the API has considered several VINs, this list will contain those that it has considered together with a quality score).

Each element of the considered_vins array contains:

string required

An application id. You can get the id of an application by clicking on 'details' in your panel

string required

The API KEY of the application that makes the call to this API, you can obtain it in your panel, by clicking on the 'details' button of an application

string required

An application id. You can get the id of an application by clicking on 'details' in your panel

string required

The API KEY of the application that makes the call to this API, you can obtain it in your panel, by clicking on the 'details' button of an application

string required

An application id. You can get the id of an application by clicking on 'details' in your panel

string required

The API KEY of the application that makes the call to this API, you can obtain it in your panel, by clicking on the 'details' button of an application