NestJS PDF417 Driver License API
Build a typed NestJS controller that decodes US driver license PDF417 barcodes and returns normalized AAMVA JSON with safe retake handling.
Designing a Safe PDF417 Route in NestJS
A production NestJS 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 NestJS Integration
NestJS can keep transport validation in a controller while a service owns the SDK client and any application-specific review rules. 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 NestJS 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.
NestJS 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: npm install structocr @nestjs/platform-express multer
import { Controller, Post, UploadedFile, UseInterceptors } from "@nestjs/common";
import { FileInterceptor } from "@nestjs/platform-express";
import StructOCR = require("structocr");
@Controller("api/license")
export class LicenseController {
private readonly client = new StructOCR(process.env.STRUCTOCR_API_KEY!);
@Post("pdf417")
@UseInterceptors(FileInterceptor("image", { limits: { fileSize: 4_500_000 } }))
async decode(@UploadedFile() image: Express.Multer.File) {
if (!image) return { success: false, error: "image is required" };
return this.client.scanDriverLicensePdf417(image.buffer);
}
}Technical Specs
- •Endpoint: POST https://api.structocr.com/v1/driver-license-pdf417
- •Authentication: x-api-key kept in server-side configuration
- •Inputs: JPG, PNG, or WebP; maximum 4.5 MB
- •Success: Normalized AAMVA JSON with source set to pdf417
- •Recoverable errors: PDF417_NOT_DECODED and AAMVA_NOT_VALID return HTTP 422
- •Cost: 2 credits for a successful decode; processing failures are refunded
Key Features
- •No browser secret: The capture client uploads to your protected backend route.
- •No AI guessing: Unreadable barcodes fail explicitly instead of producing plausible identity values.
- •Data minimization: The route can select only the fields required by the calling workflow.
- •Operational control: Your service owns authorization, logging redaction, retry behavior, and retention.
NestJS 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
}
}Frequently Asked Questions
Should NestJS call the PDF417 API from the browser?
No. Keep the StructOCR API key on the server and expose only an authenticated application route to approved clients.
Should the integration retry a 422 response automatically?
No. A 422 normally requires a clearer or correct document image. Ask the user to retake it rather than resending the same input.
Does the endpoint authenticate a driver license?
No. It decodes and parses the AAMVA barcode record. Authenticity and identity decisions require additional controls.
You May Also Like
Related tutorials, platform guides, and comparisons
PHP Driver License OCR SDK
Struggling with manual driver's license data entry? Our PHP OCR SDK provides AES-256 encrypted data extraction in seconds, backed by SOC 2 Type II. Upload an image for a free test!
Philippines Driver License OCR with Python SDK
Extract structured fields from a Philippines LTO driver's license with the StructOCR Python SDK and FastAPI.
Texas Driver License OCR: Extract Fields with Python
Extract visible fields from Texas driver license images into JSON. Map identifiers, names and dates, with a review workflow for incomplete results.
Pennsylvania Driver License PDF417 API
Decode the PDF417 barcode on the back of a Pennsylvania driver license or State ID and return normalized AAMVA fields as structured JSON.
Go US Driver License PDF417 API Tutorial
Decode US driver license PDF417 barcodes with Go. Send a license-back image, parse AAMVA fields, and handle unreadable barcode errors safely.
US Driver License OCR with Node.js SDK
Extract structured fields from a United States state-issued driver license with the StructOCR Node.js SDK and TypeScript + Express.
UK Driver License OCR with Node.js SDK
Extract structured fields from a United Kingdom photocard driving licence with the StructOCR Node.js SDK and TypeScript + Express.
US Driver License OCR with Python SDK
Extract structured fields from a United States state-issued driver license with the StructOCR Python SDK and FastAPI.
New York Driver License PDF417 API
Decode the PDF417 barcode on the back of a New York driver license or State ID and return normalized AAMVA fields as structured JSON.
UK Driver License OCR with Python SDK
Extract structured fields from a United Kingdom photocard driving licence with the StructOCR Python SDK and FastAPI.
Technical Comparisons & Integrations
Explore platform integrations and competitive analysis
Add Driver's License OCR to Your Bolt.new App in 5 Minutes
Step-by-step guide to integrating the StructOCR Driver's License scanner API into a Bolt.new app. Build car rental and mobility onboarding flows right in your browser.
Add Driver's License OCR using Cursor in 5 Minutes
Step-by-step guide to integrating the StructOCR Driver's License scanner API using the Cursor AI code editor. Build car rental and mobility onboarding flows rapidly.
Add Driver's License OCR to Your Lovable.dev App in 5 Minutes
Step-by-step guide to integrating the StructOCR Driver's License scanner API into a Lovable.dev app. Build car rental and mobility onboarding flows with zero backend.
Add Driver's License OCR to Your Replit App in 5 Minutes
Step-by-step guide to integrating the StructOCR Driver's License scanner API into a Replit application. Build car rental and mobility onboarding flows using Replit Agent and Secrets.
Add Driver's License OCR to Your v0 App in 5 Minutes
Step-by-step guide to integrating the StructOCR Driver's License scanner API into a v0 by Vercel app. Build car rental and mobility onboarding flows with zero backend.
Add Invoice OCR to Your Lovable.dev App in 5 Minutes
Step-by-step guide to integrating the StructOCR invoice API into a Lovable.dev app. No backend required — just paste a prompt and add your API key.
From tutorial to production in 5 minutes.
You've seen the code. Now get your API key, grab your 200 free credits, and see it work with your own images. No credit card required.