Constructor
# new DecodeVin(userConfigopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
userConfig |
FetchConfig |
<optional> |
User configuration options to construct the class with. |
Methods
# async DecodeVin(vin, paramsopt) → {Promise.<DecodeVinResponse>}
The DecodeVin API Action will decode the VIN and the decoded output will be made available in the format of Key-value pairs.
- Providing
params.modelYearallows for the decoding to specifically be done in the current, or older (pre-1980), model year ranges.- It is recommended to always provide
params.modelYearif the model year is known at the time of decoding.
- It is recommended to always provide
- This API also supports partial VIN decoding (VINs that are less than 17 characters).
- In this case, the VIN will be decoded partially with the available characters.
- In case of partial VINs, a "*" could be used to indicate the unavailable characters.
- The 9th digit is not necessary.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
vin |
string | Vehicle Identification Number (full or partial). |
||
params |
object |
<optional> |
{} | Query Search Parameters to append to the URL. |
modelYear |
number |
<optional> |
Optional Model Year search parameter. |
- Api Response object.
Promise.<DecodeVinResponse>