Documentation
Overview Quick Start Authentication API Endpoints Code Examples Error Codes Rate Limits Changelog
Swagger UI ReDoc

Quick Start Guide

Get up and running with the VIN Decoder API in minutes.

1 Create an Account

First, you'll need to create an account to access the API.

Sign Up Now

2 Get Your API Credentials

You can authenticate using either an API Token or API Key:

Option A: API Token

Your authentication token is automatically generated when you create an account.

Authorization: Token your-token-here

Option B: API Key

Create an API key for more flexibility and better security.

X-API-Key: your-api-key-here

3 Make Your First Request

Let's decode your first VIN! Choose your preferred language:

curl -X POST https://www.vinreveal.com/api/v1/decode \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"vin": "WAUAFAFL1DN015882"}'
import requests

headers = {
    'X-API-Key': 'your-api-key-here',
    'Content-Type': 'application/json'
}

data = {
    'vin': 'WAUAFAFL1DN015882'
}

response = requests.post('https://www.vinreveal.com/api/v1/decode',
                       headers=headers,
                       json=data)

print(response.json())
const headers = {
    'X-API-Key': 'your-api-key-here',
    'Content-Type': 'application/json'
};

const data = {
    vin: 'WAUAFAFL1DN015882'
};

fetch('https://www.vinreveal.com/api/v1/decode', {
    method: 'POST',
    headers: headers,
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
<?php
$ch = curl_init();

$data = array('vin' => 'WAUAFAFL1DN015882');

curl_setopt($ch, CURLOPT_URL, 'https://www.vinreveal.com/api/v1/decode');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'X-API-Key: your-api-key-here',
    'Content-Type: application/json'
));
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

$response = curl_exec($ch);
$result = json_decode($response, true);

print_r($result);
curl_close($ch);
?>

4 Understanding the Response

A successful response will return detailed vehicle information:

{
  "vin": "WAUAFAFL1DN015882",
  "valid": true,
  "year": 2013,
  "make": "Audi",
  "model": "A4",
  "manufacturer": "Audi AG",
  "engine": "2.0L Turbo",
  "country": "Germany",
  "assembly_plant": "Ingolstadt",
  "body_type": "Sedan",
  "drive_type": "AWD",
  "vehicle_type": "Passenger Car",
  "decoded_at": "2024-01-20T15:30:45Z"
}

Next Steps

Authentication Methods

Learn about different authentication options and best practices.

Learn More
API Endpoints

Explore all available endpoints and their parameters.

View Endpoints
Code Examples

See complete examples in multiple programming languages.

View Examples
Error Handling

Understand error codes and how to handle them properly.

View Error Codes

Need Help?

If you have questions or need assistance: