Developers · API

One gateway, five engines, one shape

Every engine is reached through a single base URL injected at load. Switch engines by changing one path segment; the request and response shapes never change.

Endpoints

ENGINEMETHODPATHRETURNS

API keys

Scope keys per environment. Keys authenticate against your gateway — they never reach VeriVision, because there is no VeriVision cloud.

vv_live_8Kd2••••••••••••••a91f

response.json

{
  "engine": "VV-MRZ",
  "latency_ms": 96,
  "detected": 1,
  "instances": [{
    "id": "mrz-1",
    "fields": [
      { "key": "doc_number", "value": "RA0123456",
        "confidence": 0.96, "check_digit": "ok" },
      { "key": "expiry", "value": "2031-08-14",
        "confidence": 0.94, "check_digit": "warn" }
    ]
  }]
}

Consistent response shape

enginestringEngine code, e.g. VV-IDR

latency_msnumberServer-side recognition time

detectednumberCount of instances found

instances[]arrayOne per card / vehicle / document

instances[].fields[]arraykey, label, value, confidence

check_digitenum?ICAO validity — MRZ only

Open OpenAPI / Swagger