Flask PDF417 Driver License API

Designing a Safe PDF417 Route in Flask

A production Flask 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 Flask Integration

Flask is useful for a small server-side adapter that accepts a multipart image, validates it, and forwards bytes through the official SDK. 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 Flask 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.

Flask 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 flask

import os
from flask import Flask, jsonify, request
from structocr import StructOCR, StructOCRError

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

@app.post("/api/license/pdf417")
def decode_pdf417():
    image = request.files.get("image")
    if image is None:
        return jsonify(error="image is required"), 400
    content = image.read()
    if len(content) > 4_500_000:
        return jsonify(error="image exceeds 4.5 MB"), 413
    try:
        return jsonify(client.scan_driver_license_pdf417(content))
    except StructOCRError as error:
        return jsonify(error=error.code, message=str(error)), error.status_code or 502

Flask 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
  }
}