api.invoket.com

{
  "properties": {
    "data": {
      "properties": {
        "coverage": {
          "description": "Sources actually consulted with their dated freshness, plus any expected source not yet ingested flagged missing=true with a reason; complete is true only when every expected source is served and fresh. A stale served source keeps its last good state (fresh=false), never a 5xx",
          "properties": {
            "complete": {
              "type": "boolean"
            },
            "reason": {
              "type": "string"
            },
            "sources": {
              "items": {
                "properties": {
                  "as_of": {
                    "type": "string"
                  },
                  "fresh": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "as_of",
                  "fresh",
                  "name"
                ],
                "type": "object"
              },
              "type": "array"
            }
          },
          "required": [
            "complete",
            "reason",
            "sources"
          ],
          "type": "object"
        },
        "make": {
          "type": "string"
        },
        "model": {
          "type": "string"
        },
        "recalls": {
          "description": "Candidate campaigns that may affect the vehicle, most recent first — an empty list is a successful, billed answer meaning no known recall, never a 404",
          "items": {
            "properties": {
              "campaign_id": {
                "type": "string"
              },
              "component": {
                "type": "string"
              },
              "match": {
                "description": "Why the campaign was retained (normalized make, optional model, optional year range) — honest matching by make/model/year, never a per-VIN 'confirmed for this exact vehicle'",
                "properties": {
                  "make": {
                    "type": "string"
                  },
                  "model": {
                    "type": "string"
                  },
                  "years": {
                    "properties": {
                      "from": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "to": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "from",
                      "to"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "make"
                ],
                "type": "object"
              },
              "published_at": {
                "type": "string"
              },
              "remedy": {
                "type": "string"
              },
              "source": {
                "type": "string"
              },
              "summary": {
                "type": "string"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "campaign_id",
              "match",
              "source",
              "summary"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "total": {
          "description": "Number of campaigns matched before any truncation; truncated=true says the returned list was capped",
          "type": "integer"
        },
        "truncated": {
          "type": "boolean"
        },
        "vin": {
          "description": "Present when the request used vin=: how the VIN was resolved (VIN, WMI, manufacturer, resolved make, model year) before matching campaigns — the matching itself stays by make/model/year",
          "type": "object"
        },
        "year": {
          "type": "integer"
        }
      },
      "required": [
        "coverage",
        "make",
        "recalls"
      ],
      "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"
}