FastAPI PDF417 Driver License API

Designing a Safe PDF417 Route in FastAPI

A production FastAPI integration must protect the API key, reject oversized uploads, preserve enough image quality for decoding, and translate recoverable 422 responses into a useful capture experience. A browser-only request would expose credentials and make abuse controls harder.

A Server-Side FastAPI Integration

FastAPI can receive the image as an UploadFile, enforce the 4.5 MB limit, and pass bytes to the official SDK without writing identity documents to disk. The PDF417 API reference documents the complete response and error model. Identity fields are only returned after deterministic barcode decoding and AAMVA parsing.

Where This Workflow Fits

• Protected upload endpoint: Keep STRUCTOCR_API_KEY inside FastAPI server configuration rather than client code.
• Structured form prefill: Map normalized AAMVA fields into an editable form and require user or staff confirmation.
• Recoverable retake flow: Turn PDF417_NOT_DECODED into a clear request for a sharper, complete license-back image.

FastAPI PDF417 Endpoint

The example accepts image data on the server and calls /v1/driver-license-pdf417. Adapt authentication, authorization, rate limits, and retention to your application.

Prerequisite: pip install structocr fastapi uvicorn python-multipart

import os
from fastapi import FastAPI, File, HTTPException, UploadFile
from structocr import StructOCR, StructOCRError

app = FastAPI()
client = StructOCR(os.environ["STRUCTOCR_API_KEY"])

@app.post("/api/license/pdf417")
async def decode_pdf417(image: UploadFile = File(...)):
    content = await image.read()
    if len(content) > 4_500_000:
        raise HTTPException(413, "Image exceeds 4.5 MB")
    try:
        return client.scan_driver_license_pdf417(content)
    except StructOCRError as error:
        raise HTTPException(error.status_code or 502, str(error)) from error

FastAPI Response Shape

The example contains fictional identity values. Optional AAMVA elements can be null, and production logs should avoid storing raw identity data.

{
  "success": true,
  "data": {
    "type": "drivers_license",
    "source": "pdf417",
    "country_code": "USA",
    "region": "CA",
    "document_number": "SAMPLE1234",
    "surname": "SAMPLE",
    "given_names": "ALEX MORGAN",
    "first_name": "ALEX",
    "middle_name": "MORGAN",
    "sex": "X",
    "date_of_birth": "1990-01-15",
    "date_of_issue": "2025-01-15",
    "date_of_expiry": "2030-01-15",
    "address": "100 EXAMPLE AVE",
    "city": "SAMPLE CITY",
    "postal_code": "00000",
    "vehicle_class": "C",
    "restrictions": null,
    "endorsements": null,
    "document_discriminator": "SAMPLE-DISCRIMINATOR",
    "issuer_identification_number": null,
    "aamva_version": 10,
    "jurisdiction_version": 0
  }
}