api.invoket.com

{
  "properties": {
    "data": {
      "properties": {
        "attributes": {
          "properties": {
            "Body Class": {
              "type": "string"
            },
            "Model": {
              "type": "string"
            }
          },
          "required": [
            "Body Class",
            "Model"
          ],
          "type": "object"
        },
        "check_digit_applicable": {
          "description": "Whether the check digit is REGULATORY for this VIN: true in North America only (49 CFR 565 in the United States, aligned Canadian and Mexican rules), false everywhere else, where position 9 is unconstrained and usually carries a serial character. When false, check_digit_valid: false is NOT a rejection reason — most European VINs, valid ones included, fail a checksum no law requires them to satisfy, so filtering on the boolean alone discards them. Always present, derived from the same source as region: a VIN is never served with region 'Europe' and check_digit_applicable true",
          "type": "boolean"
        },
        "check_digit_valid": {
          "description": "Whether the position-9 check digit matches the ISO 3779 checksum; reported for information, never a rejection reason. Read it together with check_digit_applicable: outside North America a false here says nothing about the VIN being genuine",
          "type": "boolean"
        },
        "country": {
          "type": "string"
        },
        "coverage": {
          "description": "Honest decode coverage: complete=true only when every expected field is resolved — make, model, model year, at least one unambiguous positional attribute, and a country consistent with the VIN region. Expect complete=false on many European VINs: vPIC is a US register and often describes only the assembly plant. Always a 200 with a named reason, never a guessed value, never a 5xx",
          "properties": {
            "complete": {
              "type": "boolean"
            },
            "reason": {
              "description": "Names which expected fields could not be resolved, present when complete is false, several joined by '; ' — the fields themselves are omitted rather than guessed. Closed list of causes: the vPIC country of registration contradicting the VIN region (country then omitted), no make for this WMI, no model for this VIN, undecodable model year, no deterministic positional attributes, attributes dropped as ambiguous",
              "type": "string"
            }
          },
          "required": [
            "complete"
          ],
          "type": "object"
        },
        "make": {
          "description": "Brand of the vehicle, omitted rather than guessed when no source resolves it. Same brand as the one /vehicle/recalls searches for this VIN, never a different one, and never a corporate group badge (FCA, PSA, Stellantis)",
          "type": "string"
        },
        "make_source": {
          "description": "Where the make comes from, present exactly when make is. Closed enumeration, by priority: 'wmi' (make column of the vPIC WMI table), 'pattern' (Make element of a positional pattern), 'manufacturer_bridge' (pipeline-built VIN-to-brand bridge: legal entity name, then the decoded model for multi-brand corporate parents such as FCA US LLC). A make already resolved by a higher-priority source is never overwritten",
          "type": "string"
        },
        "manufacturer": {
          "type": "string"
        },
        "model_year": {
          "description": "Model year decoded from position 10, disambiguated against the snapshot date; omitted when the 30-year cycle cannot be resolved",
          "type": "integer"
        },
        "model_year_ambiguous": {
          "description": "Present and true when the position-10 code maps to more than one year of the 30-year cycle: the model year is then the most plausible one and the ambiguity is stated rather than hidden",
          "type": "boolean"
        },
        "region": {
          "type": "string"
        },
        "vin": {
          "type": "string"
        },
        "wmi": {
          "description": "World Manufacturer Identifier resolved from the VIN prefix (3 characters, or 6 for low-volume manufacturers)",
          "type": "string"
        }
      },
      "required": [
        "check_digit_applicable",
        "check_digit_valid",
        "coverage",
        "manufacturer",
        "vin",
        "wmi"
      ],
      "type": "object"
    },
    "provenance": {
      "properties": {
        "fetched_at": {
          "type": "string"
        },
        "freshness": {
          "properties": {
            "as_of": {
              "type": "string"
            },
            "kind": {
              "type": "string"
            }
          },
          "required": [
            "as_of",
            "kind"
          ],
          "type": "object"
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "fetched_at",
        "freshness",
        "source"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "provenance"
  ],
  "type": "object"
}