API access uses API Consumers and JWT bearer tokens. Create credentials in your dashboard, keep Client Secrets on your server, and request an audience-specific token before calling this API. See the API access and authentication guidance.
The VINfix API generates one or more suggestions when a problematic VIN is submitted. It is up to the end users to make the final decision on which suggestion to use, or to choose not to use any of the suggestions. Therefore, batch processing without human oversight is not recommended.
Avoid Submitting the Same VIN Multiple Times
Our system deducts one credit from your account balance for each XML result returned, regardless of the outcome. To prevent unnecessary charges, ensure your system has a mechanism to avoid sending the same VIN to the API service more than once.
REST API Description
VINfix API provides programmatic access to two of our state-of-the-art machine learning algorithms.
| Parameter Name | Parameter | Value | Used in Request |
| JWT Bearer Token | Authorization header | Bearer <jwt-token> | Authorization: Bearer <jwt-token> |
| Vehicle Identification Number | VIN | XXXXXXXXXXXXXXXXX | GET https://www.recognition.ws/vinfix/v3?VIN=XXXXXXXXXXXXXXXXX |
| Data Format | format | XML or JSON (default: XML) | GET https://www.recognition.ws/vinfix/v3?VIN=XXXXXXXXXXXXXXXXX&format=JSON |
POST https://identity.vinquery.com/connect/token using an API Consumer with audience vinquery:api:vinfix.Output in XML or JSON
VINfix API 1.0 has now been deprecated. It produces suggestions made by two machine learning algorithms: Algorithm 1 and Algorithm 2.
- Algorithm 1 and Algorithm 2 don't always agree with each other;
- Algorithm 1 usually produces more accurate suggestions than Algorithm 2 does;
- Algorithm 1 always produces at least one suggestion;
- Algorithm 1 usually produces only one suggestion;
- Algorithm 2 often produces more than one suggestions;
- Algorithm 2 could produce no suggestions at all.
- It is recommended that the suggestions from Algorithm 2 should be hidden from end-users by default unless the suggestions from Algorithm 1 were not satifactory and a second opinion was needed.
<VINfix Date="4/22/2015" Version="1.0" Status="SUCCESS" Number="XXXXXXXXXXX123456>
<Algorithm1>
<Item Value="XXXXXXXXXXX123456" Key="Suggestion1"/>
<Item Value="..." Key="..."/>
<Item Value="XXXXXXXXXXX123456" Key="SuggestionM"/>
</Algorithm1>
<Algorithm2>
<Item Value="XXXXXXXXXXX123456" Key="Suggestion1"/>
<Item Value="..." Key="..."/>
<Item Value="XXXXXXXXXXX123456" Key="SuggestionN"/>
</Algorithm2>
</VINfix>
VINfix API 3.0 produces one high-confidence correction result and accepts JWT bearer authentication. It can deliver results in either format: XML or JSON.
API with XML return: GET https://www.recognition.ws/vinfix/v3?VIN=XXXXXXXXXXX123456&format=XML
Authorization: Bearer <jwt-token>
<VINfix>
<Version>3.0</Version>
<Date>3/30/2021 2:03:34 AM</Date>
<Status>SUCCESS</Status>
<Input>XXXXXXXXXXX123456</Input>
<Output>XXXXXXXXXXX123456</Output>
</VINfix>
API with JSON return: GET https://www.recognition.ws/vinfix/v3?VIN=XXXXXXXXXXX123456&format=JSON
Authorization: Bearer <jwt-token>
{
"service": "vinfix",
"version": "3.0",
"date": "3/30/2021 3:36:54 AM",
"status": "SUCCESS",
"input": "XXXXXXXXXXX123456",
"output": "XXXXXXXXXXX123456"
}
Error Codes
| Error Code (Key) | Description (Value) |
| 0 | Database Errors. |
| 17 | Insufficient balance for VINfix |
| 18 | Length of VIN too short for VINfix; It must be at least 10 digits. |
| 19 | Invalid VIN number: The last 4 digits of this VIN number must all be numeric. |
| 20 | Invalid VIN number: The last 6 digits of this VIN number must all be numeric. |
| 21 | Invalid VIN number: The 12th digit of this VIN number must be a letter. |
| 22 | Invalid VIN number: The 13th digit of this VIN number must be a letter. |
| 28 | VINfix data model not ready. |
A sample error message returned in XML format:
<VINfix>
<Version>3.0</Version>
<Date>3/30/2021 2:21:09 AM</Date>
<Status>FAILED</Status>
<Input>1F4W3MCB0VA807600</Input>
<Message_Key>0</Message_Key>
<Message>Database Errors.</Message>
</VINfix>
A sample error message returned in JSON format:
{
"service": "vinfix",
"version": "3.0",
"date": "3/30/2021 5:38:03 AM",
"status": "FAILED",
"input": "1F4W3MCB0VA807600",
"message_key": 0,
"message": "Database Errors."
}
VINfix XML Samples
VINfix JSON Samples
Coding Examples (JWT Authentication)
These server-side examples keep API Consumer credentials private, cache and reuse a valid VINfix JWT, renew shortly before expiration, and perform one refresh-and-retry after an unexpected 401. The implementations are copied from the Server-Side Proxy Guide.
import express from "express";
const app = express();
// Store API Consumer credentials only in trusted server-side configuration.
// These values must never be shipped to browser JavaScript, mobile apps, or public source code.
const clientId = process.env.VINQUERY_VINFIX_CLIENT_ID;
const clientSecret = process.env.VINQUERY_VINFIX_CLIENT_SECRET;
const audience = "vinquery:api:vinfix";
const identityTokenUrl = "https://identity.vinquery.com/connect/token";
const vinfixUrl = "https://www.recognition.ws/vinfix/v3";
// Renew shortly before expiry so a user request is not made with a nearly expired token.
const refreshBufferMs = 60 * 1000;
// This in-memory cache is process-local. In a multi-instance deployment, each instance
// should maintain its own token cache rather than asking Identity for every API call.
let cachedToken = null;
// A shared promise prevents simultaneous requests from all refreshing the token at once.
let refreshInFlight = null;
function tokenIsUsable() {
return cachedToken && Date.now() < cachedToken.expiresAtMs - refreshBufferMs;
}
async function getJwtToken() {
// Reuse the cached JWT when it is still comfortably valid.
if (tokenIsUsable()) {
return cachedToken.jwtToken;
}
// If another request is already refreshing, wait for the same refresh operation.
if (refreshInFlight) {
return refreshInFlight;
}
refreshInFlight = (async () => {
if (!clientId || !clientSecret) {
throw new Error("VINquery API Consumer credentials are not configured.");
}
const response = await fetch(identityTokenUrl, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ clientId, clientSecret, audience })
});
if (!response.ok) {
throw new Error(`Identity token request failed with HTTP ${response.status}.`);
}
// Current Identity contract returns jwtToken, expiresIn, and expiresUtc.
const token = await response.json();
if (!token.jwtToken || !token.expiresUtc) {
throw new Error("Identity response did not include jwtToken and expiresUtc.");
}
cachedToken = {
jwtToken: token.jwtToken,
expiresAtMs: Date.parse(token.expiresUtc)
};
return cachedToken.jwtToken;
})().finally(() => {
refreshInFlight = null;
});
return refreshInFlight;
}
function invalidateRejectedToken(rejectedToken) {
// Do not erase a newer token that another request may already have refreshed.
if (cachedToken?.jwtToken === rejectedToken) {
cachedToken = null;
}
}
app.get("/api/vinfix", async (req, res) => {
try {
// The browser calls this proxy. The proxy adds the bearer token server-side.
let jwtToken = await getJwtToken();
const apiUrl = `${vinfixUrl}?VIN=${encodeURIComponent(String(req.query.vin || "").trim())}&format=JSON`;
let apiResponse = await fetch(apiUrl, {
headers: { Authorization: `Bearer ${jwtToken}` }
});
// A token can be revoked before expiresUtc. Invalidate and retry exactly once.
if (apiResponse.status === 401) {
invalidateRejectedToken(jwtToken);
jwtToken = await getJwtToken();
apiResponse = await fetch(apiUrl, {
headers: { Authorization: `Bearer ${jwtToken}` }
});
}
res.status(apiResponse.status).type("application/json").send(await apiResponse.text());
} catch (error) {
// Return a safe error. Log full details server-side, not in the browser response.
console.error("VINfix proxy failed", error);
res.status(502).json({ message: "VINquery request could not be completed." });
}
});
import express, { Request, Response } from "express";
const app = express();
type TokenResponse = {
jwtToken: string;
expiresIn: number;
expiresUtc: string;
};
type CachedToken = {
jwtToken: string;
expiresAtMs: number;
};
// Credentials and audience are server-side configuration. Never expose them to the client.
const clientId = process.env.VINQUERY_VINFIX_CLIENT_ID || "";
const clientSecret = process.env.VINQUERY_VINFIX_CLIENT_SECRET || "";
const audience = "vinquery:api:vinfix";
const refreshBufferMs = 60_000;
let cachedToken: CachedToken | null = null;
let refreshInFlight: Promise<string> | null = null;
function cachedTokenIsValid(): boolean {
return !!cachedToken && Date.now() < cachedToken.expiresAtMs - refreshBufferMs;
}
async function requestFreshToken(): Promise<string> {
if (!clientId || !clientSecret) {
throw new Error("VINquery API Consumer credentials are missing.");
}
const response = await fetch("https://identity.vinquery.com/connect/token", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ clientId, clientSecret, audience })
});
if (!response.ok) {
throw new Error(`Identity token request failed with HTTP ${response.status}.`);
}
const token = (await response.json()) as TokenResponse;
if (!token.jwtToken || !token.expiresUtc) {
throw new Error("Identity response did not include jwtToken and expiresUtc.");
}
cachedToken = {
jwtToken: token.jwtToken,
expiresAtMs: Date.parse(token.expiresUtc)
};
return cachedToken.jwtToken;
}
async function getJwtToken(): Promise<string> {
// Use the cached token until it is close to expiration.
if (cachedTokenIsValid()) {
return cachedToken!.jwtToken;
}
// Share one refresh promise across concurrent requests.
refreshInFlight ??= requestFreshToken().finally(() => {
refreshInFlight = null;
});
return refreshInFlight;
}
function invalidateRejectedToken(rejectedToken: string): void {
// Preserve a newer token installed concurrently by another request.
if (cachedToken?.jwtToken === rejectedToken) {
cachedToken = null;
}
}
app.get("/api/vinfix", async (req: Request, res: Response) => {
try {
let jwtToken = await getJwtToken();
const apiUrl = `https://www.recognition.ws/vinfix/v3?VIN=${encodeURIComponent(String(req.query.vin || "").trim())}&format=JSON`;
let apiResponse = await fetch(apiUrl, {
headers: { Authorization: `Bearer ${jwtToken}` }
});
if (apiResponse.status === 401) {
invalidateRejectedToken(jwtToken);
jwtToken = await getJwtToken();
apiResponse = await fetch(apiUrl, {
headers: { Authorization: `Bearer ${jwtToken}` }
});
}
return res.status(apiResponse.status).type("application/json").send(await apiResponse.text());
} catch (error) {
console.error("VINfix proxy failed", error);
return res.status(502).json({ message: "VINquery request could not be completed." });
}
});
from datetime import datetime, timezone, timedelta
import os
import requests
from threading import Lock
from fastapi import FastAPI, HTTPException, Response
app = FastAPI()
# API Consumer credentials stay in trusted server-side configuration.
CLIENT_ID = os.environ.get("VINQUERY_VINFIX_CLIENT_ID", "")
CLIENT_SECRET = os.environ.get("VINQUERY_VINFIX_CLIENT_SECRET", "")
AUDIENCE = "vinquery:api:vinfix"
IDENTITY_TOKEN_URL = "https://identity.vinquery.com/connect/token"
VINFIX_URL = "https://www.recognition.ws/vinfix/v3"
REFRESH_BUFFER = timedelta(seconds=60)
_cached_token = None
_token_expires_at = datetime.min.replace(tzinfo=timezone.utc)
_refresh_lock = Lock()
def _token_is_usable() -> bool:
# Refresh before the exact expiry time so normal traffic does not hit an expired token.
return bool(_cached_token) and datetime.now(timezone.utc) < (_token_expires_at - REFRESH_BUFFER)
def get_jwt_token() -> str:
global _cached_token, _token_expires_at
if _token_is_usable():
return _cached_token
# The lock prevents concurrent requests from creating duplicate token refreshes.
with _refresh_lock:
if _token_is_usable():
return _cached_token
if not CLIENT_ID or not CLIENT_SECRET:
raise RuntimeError("VINquery API Consumer credentials are missing.")
token_response = requests.post(
IDENTITY_TOKEN_URL,
json={"clientId": CLIENT_ID, "clientSecret": CLIENT_SECRET, "audience": AUDIENCE},
timeout=15
)
token_response.raise_for_status()
# Current Identity response contract: jwtToken, expiresIn, expiresUtc.
token_json = token_response.json()
if not token_json.get("jwtToken") or not token_json.get("expiresUtc"):
raise RuntimeError("Identity response did not include jwtToken and expiresUtc.")
_cached_token = token_json["jwtToken"]
_token_expires_at = datetime.fromisoformat(token_json["expiresUtc"].replace("Z", "+00:00"))
return _cached_token
def invalidate_rejected_token(rejected_token: str) -> None:
global _cached_token, _token_expires_at
# Compare under the same lock so a concurrent refresh is never discarded.
with _refresh_lock:
if _cached_token == rejected_token:
_cached_token = None
_token_expires_at = datetime.min.replace(tzinfo=timezone.utc)
@app.get("/api/vinfix")
def vinfix(vin: str):
try:
if len(vin.strip()) != 17:
raise HTTPException(status_code=400, detail="A valid 17-character VIN is required.")
jwt_token = get_jwt_token()
api_response = requests.get(
VINFIX_URL,
params={"VIN": vin, "format": "JSON"},
headers={"Authorization": f"Bearer {jwt_token}"},
timeout=30
)
if api_response.status_code == 401:
api_response.close()
invalidate_rejected_token(jwt_token)
jwt_token = get_jwt_token()
api_response = requests.get(
VINFIX_URL,
params={"VIN": vin, "format": "JSON"},
headers={"Authorization": f"Bearer {jwt_token}"},
timeout=30
)
return Response(
content=api_response.text,
status_code=api_response.status_code,
media_type="application/json"
)
except HTTPException:
raise
except Exception as exc:
# Log the detailed exception server-side and return a safe message to the client.
print(f"VINfix proxy failed: {exc}")
raise HTTPException(status_code=502, detail="VINquery request could not be completed.")
<?php
// This example uses APCu for process-local in-memory caching and a lock file to
// prevent duplicate token refreshes. Keep credentials in server environment variables.
$clientId = getenv("VINQUERY_VINFIX_CLIENT_ID");
$clientSecret = getenv("VINQUERY_VINFIX_CLIENT_SECRET");
$audience = "vinquery:api:vinfix";
$identityTokenUrl = "https://identity.vinquery.com/connect/token";
$vinfixUrl = "https://www.recognition.ws/vinfix/v3";
$refreshBufferSeconds = 60;
function getJwtToken() {
global $clientId, $clientSecret, $audience, $identityTokenUrl, $refreshBufferSeconds;
if (!function_exists("apcu_fetch") || !function_exists("apcu_store")) {
throw new RuntimeException("APCu must be enabled for this in-memory token cache example.");
}
$cached = apcu_fetch("vinquery_vinfix_jwt");
if ($cached && time() < ($cached["expiresAt"] - $refreshBufferSeconds)) {
return $cached["jwtToken"];
}
$lock = fopen(sys_get_temp_dir() . "/vinquery-vinfix-token.lock", "c");
if (!$lock || !flock($lock, LOCK_EX)) {
throw new RuntimeException("Could not acquire token refresh lock.");
}
try {
// Re-check inside the lock because another request may have refreshed the token.
$cached = apcu_fetch("vinquery_vinfix_jwt");
if ($cached && time() < ($cached["expiresAt"] - $refreshBufferSeconds)) {
return $cached["jwtToken"];
}
if (!$clientId || !$clientSecret) {
throw new RuntimeException("VINquery API Consumer credentials are missing.");
}
$tokenPayload = json_encode([
"clientId" => $clientId,
"clientSecret" => $clientSecret,
"audience" => $audience
]);
$curl = curl_init($identityTokenUrl);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"],
CURLOPT_POSTFIELDS => $tokenPayload,
CURLOPT_TIMEOUT => 15
]);
$body = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("Identity token request failed with HTTP " . $status . ".");
}
// Current Identity response contract: jwtToken, expiresIn, expiresUtc.
$token = json_decode($body, true);
if (empty($token["jwtToken"]) || empty($token["expiresUtc"])) {
throw new RuntimeException("Identity response did not include jwtToken and expiresUtc.");
}
$expiresAt = strtotime($token["expiresUtc"]);
apcu_store("vinquery_vinfix_jwt", [
"jwtToken" => $token["jwtToken"],
"expiresAt" => $expiresAt
], max(1, $expiresAt - time()));
return $token["jwtToken"];
} finally {
flock($lock, LOCK_UN);
fclose($lock);
}
}
function invalidateRejectedToken(string $rejectedToken): void {
$lock = fopen(sys_get_temp_dir() . "/vinquery-vinfix-token.lock", "c");
if (!$lock || !flock($lock, LOCK_EX)) {
throw new RuntimeException("Could not acquire token refresh lock.");
}
try {
$cached = apcu_fetch("vinquery_vinfix_jwt");
// Delete only the rejected token while holding the same lock used by refresh.
if ($cached && hash_equals($cached["jwtToken"], $rejectedToken)) {
apcu_delete("vinquery_vinfix_jwt");
}
} finally {
flock($lock, LOCK_UN);
fclose($lock);
}
}
function callVinFix(string $vinfixUrl, string $vin, string $jwtToken): array {
$curl = curl_init($vinfixUrl . "?VIN=" . urlencode($vin) . "&format=JSON");
curl_setopt_array($curl, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Authorization: Bearer " . $jwtToken],
CURLOPT_TIMEOUT => 30
]);
$body = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
return [$status, $body];
}
try {
$vin = strtoupper(trim($_GET["vin"] ?? ""));
if (!preg_match("/^[A-HJ-NPR-Z0-9]{17}$/", $vin)) {
http_response_code(400);
header("Content-Type: application/json");
echo json_encode(["message" => "A valid 17-character VIN is required."]);
exit;
}
$jwtToken = getJwtToken();
[$apiStatus, $apiBody] = callVinFix($vinfixUrl, $vin, $jwtToken);
if ($apiStatus === 401) {
invalidateRejectedToken($jwtToken);
$jwtToken = getJwtToken();
[$apiStatus, $apiBody] = callVinFix($vinfixUrl, $vin, $jwtToken);
}
http_response_code($apiStatus);
header("Content-Type: application/json");
echo $apiBody;
} catch (Throwable $ex) {
error_log("VINfix proxy failed: " . $ex->getMessage());
http_response_code(502);
header("Content-Type: application/json");
echo json_encode(["message" => "VINquery request could not be completed."]);
}
?>
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"sync"
"time"
)
const (
audience = "vinquery:api:vinfix"
identityTokenURL = "https://identity.vinquery.com/connect/token"
vinfixURL = "https://www.recognition.ws/vinfix/v3"
refreshBuffer = time.Minute
)
type tokenResponse struct {
JwtToken string `json:"jwtToken"`
ExpiresIn int `json:"expiresIn"`
ExpiresUtc time.Time `json:"expiresUtc"`
}
type tokenCache struct {
sync.Mutex
jwtToken string
expiresAt time.Time
}
var cache tokenCache
func getJWTToken() (string, error) {
cache.Lock()
defer cache.Unlock()
// Reuse the JWT until it is close to expiration.
if cache.jwtToken != "" && time.Now().UTC().Before(cache.expiresAt.Add(-refreshBuffer)) {
return cache.jwtToken, nil
}
clientID := os.Getenv("VINQUERY_VINFIX_CLIENT_ID")
clientSecret := os.Getenv("VINQUERY_VINFIX_CLIENT_SECRET")
if clientID == "" || clientSecret == "" {
return "", fmt.Errorf("VINquery API Consumer credentials are missing")
}
payload, _ := json.Marshal(map[string]string{
"clientId": clientID,
"clientSecret": clientSecret,
"audience": audience,
})
req, _ := http.NewRequest("POST", identityTokenURL, bytes.NewReader(payload))
req.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(req)
if err != nil {
return "", err
}
defer response.Body.Close()
if response.StatusCode < 200 || response.StatusCode >= 300 {
return "", fmt.Errorf("Identity token request failed with HTTP %d", response.StatusCode)
}
var token tokenResponse
if err := json.NewDecoder(response.Body).Decode(&token); err != nil {
return "", err
}
if token.JwtToken == "" || token.ExpiresUtc.IsZero() {
return "", fmt.Errorf("Identity response did not include jwtToken and expiresUtc")
}
cache.jwtToken = token.JwtToken
cache.expiresAt = token.ExpiresUtc
return cache.jwtToken, nil
}
func invalidateRejectedToken(rejectedToken string) {
cache.Lock()
defer cache.Unlock()
// Keep a newer token if another request refreshed while this call was running.
if cache.jwtToken == rejectedToken {
cache.jwtToken = ""
cache.expiresAt = time.Time{}
}
}
func vinFixHandler(w http.ResponseWriter, r *http.Request) {
vin := r.URL.Query().Get("vin")
if len(vin) != 17 {
http.Error(w, "A valid 17-character VIN is required.", http.StatusBadRequest)
return
}
jwtToken, err := getJWTToken()
if err != nil {
fmt.Println("VINfix token failure:", err)
http.Error(w, "VINquery request could not be completed.", http.StatusBadGateway)
return
}
apiURL := vinfixURL + "?VIN=" + url.QueryEscape(vin) + "&format=JSON"
req, _ := http.NewRequest("GET", apiURL, nil)
req.Header.Set("Authorization", "Bearer "+jwtToken)
apiResponse, err := http.DefaultClient.Do(req)
if err != nil {
fmt.Println("VINfix API failure:", err)
http.Error(w, "VINquery request could not be completed.", http.StatusBadGateway)
return
}
if apiResponse.StatusCode == http.StatusUnauthorized {
io.Copy(io.Discard, apiResponse.Body)
apiResponse.Body.Close()
invalidateRejectedToken(jwtToken)
jwtToken, err = getJWTToken()
if err != nil {
http.Error(w, "VINquery request could not be completed.", http.StatusBadGateway)
return
}
retryRequest, _ := http.NewRequest("GET", apiURL, nil)
retryRequest.Header.Set("Authorization", "Bearer "+jwtToken)
apiResponse, err = http.DefaultClient.Do(retryRequest)
if err != nil {
http.Error(w, "VINquery request could not be completed.", http.StatusBadGateway)
return
}
}
defer apiResponse.Body.Close()
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(apiResponse.StatusCode)
io.Copy(w, apiResponse.Body)
}
using System.Net.Http.Headers;
using System.Net.Http.Json;
using System.Text.Json.Serialization;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient();
// Register one token provider for the application process. It owns the in-memory
// JWT cache and prevents every request from calling the Identity service.
builder.Services.AddSingleton<VinqueryTokenProvider>();
var app = builder.Build();
app.MapGet("/api/vinfix", async (
string vin,
IHttpClientFactory httpClientFactory,
VinqueryTokenProvider tokenProvider) =>
{
if (string.IsNullOrWhiteSpace(vin) || vin.Length != 17)
{
return Results.BadRequest(new { message = "A valid 17-character VIN is required." });
}
try
{
// The browser never receives the API Consumer secret. It calls this proxy,
// and the proxy attaches the cached bearer token server-side.
var jwtToken = await tokenProvider.GetJwtTokenAsync();
var requestUrl = $"https://www.recognition.ws/vinfix/v3?VIN={Uri.EscapeDataString(vin)}&format=JSON";
using var request = new HttpRequestMessage(HttpMethod.Get, requestUrl);
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", jwtToken);
using var response = await httpClientFactory.CreateClient().SendAsync(request);
if (response.StatusCode == System.Net.HttpStatusCode.Unauthorized)
{
tokenProvider.InvalidateRejectedToken(jwtToken);
jwtToken = await tokenProvider.GetJwtTokenAsync();
using var retryRequest = new HttpRequestMessage(HttpMethod.Get, requestUrl);
retryRequest.Headers.Authorization = new AuthenticationHeaderValue("Bearer", jwtToken);
using var retryResponse = await httpClientFactory.CreateClient().SendAsync(retryRequest);
return Results.Content(
await retryResponse.Content.ReadAsStringAsync(),
"application/json",
statusCode: (int)retryResponse.StatusCode);
}
return Results.Content(
await response.Content.ReadAsStringAsync(),
"application/json",
statusCode: (int)response.StatusCode);
}
catch (Exception ex)
{
app.Logger.LogError(ex, "VINfix proxy failed.");
return Results.Problem("VINquery request could not be completed.", statusCode: 502);
}
});
app.Run();
public sealed class VinqueryTokenProvider
{
private static readonly TimeSpan RefreshBuffer = TimeSpan.FromSeconds(60);
private readonly IHttpClientFactory _httpClientFactory;
private readonly IConfiguration _configuration;
private readonly SemaphoreSlim _refreshLock = new(1, 1);
private TokenResponse? _cachedToken;
public VinqueryTokenProvider(IHttpClientFactory httpClientFactory, IConfiguration configuration)
{
_httpClientFactory = httpClientFactory;
_configuration = configuration;
}
public async Task<string> GetJwtTokenAsync()
{
if (TokenIsUsable())
{
return _cachedToken!.JwtToken;
}
await _refreshLock.WaitAsync();
try
{
if (TokenIsUsable())
{
return _cachedToken!.JwtToken;
}
var clientId = _configuration["VINquery:VINfix:ClientId"];
var clientSecret = _configuration["VINquery:VINfix:ClientSecret"];
if (string.IsNullOrWhiteSpace(clientId) || string.IsNullOrWhiteSpace(clientSecret))
{
throw new InvalidOperationException("VINquery API Consumer credentials are missing.");
}
var response = await _httpClientFactory.CreateClient().PostAsJsonAsync(
"https://identity.vinquery.com/connect/token",
new
{
clientId,
clientSecret,
audience = "vinquery:api:vinfix"
});
response.EnsureSuccessStatusCode();
_cachedToken = await response.Content.ReadFromJsonAsync<TokenResponse>()
?? throw new InvalidOperationException("Identity token response could not be parsed.");
if (string.IsNullOrWhiteSpace(_cachedToken.JwtToken))
{
throw new InvalidOperationException("Identity response did not include jwtToken.");
}
return _cachedToken.JwtToken;
}
finally
{
_refreshLock.Release();
}
}
public void InvalidateRejectedToken(string rejectedToken)
{
// Atomic compare/exchange prevents an old 401 from deleting a newer token.
var cached = _cachedToken;
if (cached is not null &&
string.Equals(cached.JwtToken, rejectedToken, StringComparison.Ordinal))
{
Interlocked.CompareExchange(ref _cachedToken, null, cached);
}
}
private bool TokenIsUsable()
{
// Use expiresUtc from the current Identity response and refresh before
// exact expiry to avoid edge-of-expiration request failures.
return _cachedToken is not null
&& !string.IsNullOrWhiteSpace(_cachedToken.JwtToken)
&& DateTimeOffset.UtcNow < _cachedToken.ExpiresUtc.Subtract(RefreshBuffer);
}
}
public sealed class TokenResponse
{
[JsonPropertyName("jwtToken")]
public string JwtToken { get; set; } = "";
[JsonPropertyName("expiresIn")]
public int ExpiresIn { get; set; }
[JsonPropertyName("expiresUtc")]
public DateTimeOffset ExpiresUtc { get; set; }
}
@RestController
public class VinFixProxyController {
private final RestClient restClient = RestClient.create();
// This lock prevents multiple simultaneous requests from all refreshing the
// same JWT at the same time. The cache is intentionally process-local.
private final ReentrantLock refreshLock = new ReentrantLock();
private final Duration refreshBuffer = Duration.ofSeconds(60);
private volatile TokenResponse cachedToken;
@GetMapping("/api/vinfix")
public ResponseEntity<String> vinFix(@RequestParam String vin) {
if (vin == null || vin.trim().length() != 17) {
return ResponseEntity.badRequest().body("{\"message\":\"A valid 17-character VIN is required.\"}");
}
try {
// The client application calls this proxy. Only the proxy knows the
// Client Secret and only the proxy sends Authorization to VINquery.
String jwtToken = getJwtToken();
ResponseEntity<String> response = callVinFix(vin, jwtToken);
if (response.getStatusCode() == HttpStatus.UNAUTHORIZED) {
invalidateRejectedToken(jwtToken);
jwtToken = getJwtToken();
response = callVinFix(vin, jwtToken);
}
return ResponseEntity.status(response.getStatusCode())
.contentType(MediaType.APPLICATION_JSON)
.body(response.getBody());
} catch (Exception ex) {
// Log full details server-side and return a safe message to the client.
System.err.println("VINfix proxy failed: " + ex.getMessage());
return ResponseEntity.status(HttpStatus.BAD_GATEWAY)
.body("{\"message\":\"VINquery request could not be completed.\"}");
}
}
private String getJwtToken() {
if (tokenIsUsable()) {
return cachedToken.jwtToken();
}
refreshLock.lock();
try {
if (tokenIsUsable()) {
return cachedToken.jwtToken();
}
String clientId = System.getenv("VINQUERY_VINFIX_CLIENT_ID");
String clientSecret = System.getenv("VINQUERY_VINFIX_CLIENT_SECRET");
if (clientId == null || clientId.isBlank() || clientSecret == null || clientSecret.isBlank()) {
throw new IllegalStateException("VINquery API Consumer credentials are missing.");
}
Map<String, String> payload = Map.of(
"clientId", clientId,
"clientSecret", clientSecret,
"audience", "vinquery:api:vinfix"
);
cachedToken = restClient.post()
.uri("https://identity.vinquery.com/connect/token")
.contentType(MediaType.APPLICATION_JSON)
.body(payload)
.retrieve()
.body(TokenResponse.class);
if (cachedToken == null || cachedToken.jwtToken() == null || cachedToken.jwtToken().isBlank()) {
throw new IllegalStateException("Identity response did not include jwtToken.");
}
return cachedToken.jwtToken();
} finally {
refreshLock.unlock();
}
}
private void invalidateRejectedToken(String rejectedToken) {
refreshLock.lock();
try {
// Do not invalidate a newer token installed by another request.
if (cachedToken != null && cachedToken.jwtToken().equals(rejectedToken)) {
cachedToken = null;
}
} finally {
refreshLock.unlock();
}
}
private ResponseEntity<String> callVinFix(String vin, String jwtToken) {
// exchange() preserves a 401 response instead of throwing before retry logic runs.
return restClient.get()
.uri("https://www.recognition.ws/vinfix/v3?VIN={vin}&format=JSON", vin)
.header("Authorization", "Bearer " + jwtToken)
.exchange((request, response) -> ResponseEntity
.status(response.getStatusCode())
.headers(response.getHeaders())
.body(new String(response.getBody().readAllBytes(), java.nio.charset.StandardCharsets.UTF_8)));
}
private boolean tokenIsUsable() {
// Use expiresUtc from Identity and renew shortly before expiration.
return cachedToken != null
&& cachedToken.jwtToken() != null
&& Instant.now().isBefore(cachedToken.expiresUtc().minus(refreshBuffer));
}
// Current Identity response contract: jwtToken, expiresIn, expiresUtc.
public record TokenResponse(String jwtToken, int expiresIn, Instant expiresUtc) { }
}
