Decode State ID Card PDF417 Barcodes with PHP
Read the barcode on the back of US state and Canadian provincial ID cards from PHP, branch on document_kind, and reject unreadable barcodes without AI guessing.
ID Cards Use the Same Barcode, but Not the Same Fields
People who do not drive carry a state or provincial identification card instead of a driver license. The back of most of these cards carries the same AAMVA PDF417 barcode as a license, so a check-in, age-verification, or onboarding flow will receive both. The difference is inside the record: an ID card has no license class, restrictions, or endorsements, and treating it as a license with missing fields leads to confusing validation errors.
One PHP Request for Licenses and ID Cards
Send the card back to the PDF417 API. StructOCR decodes the barcode, parses the record defined by the AAMVA DL/ID standard, and returns document_kind as id_card or driver_license. Test a sample first in the free PDF417 scanner.
Where ID Card Barcodes Show Up
- Age and identity checks: Accept non-drivers at alcohol, cannabis, and venue check-in without a separate ID card flow.
- Account onboarding: Pre-fill name, date of birth, and address from either card type and label the document correctly in your records.
- License-only workflows: Use document_kind to stop rental or fleet sign-ups that require a driver license when an ID card is presented.
Implementation: PHP REST Request
Base64 encode the card-back image, send it with the x-api-key header, branch on document_kind, and treat HTTP 422 as a request for a clearer image.
Prerequisite: PHP 8.1+ with the cURL extension
<?php
$image = base64_encode(file_get_contents('id-card-back.jpg'));
$payload = json_encode(['img' => $image], JSON_THROW_ON_ERROR);
$curl = curl_init('https://api.structocr.com/v1/driver-license-pdf417');
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'x-api-key: ' . getenv('STRUCTOCR_API_KEY'),
],
CURLOPT_POSTFIELDS => $payload,
]);
$body = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($body === false) throw new RuntimeException(curl_error($curl));
curl_close($curl);
$result = json_decode($body, true, flags: JSON_THROW_ON_ERROR);
if ($status === 422) {
echo 'Retake image: ' . $result['error'] . PHP_EOL;
} elseif ($status !== 200) {
throw new RuntimeException($result['message'] ?? $result['error']);
} else {
$data = $result['data'];
$label = $data['document_kind'] === 'id_card' ? 'State/provincial ID' : 'Driver license';
echo $label . ': ' . $data['document_number'] . ' (' . $data['region'] . ')' . PHP_EOL;
echo 'DOB: ' . $data['date_of_birth'] . PHP_EOL;
}Technical Specs
- •Endpoint: POST https://api.structocr.com/v1/driver-license-pdf417 (same endpoint for driver licenses and ID cards)
- •Authentication: x-api-key request header
- •Inputs: JPG, PNG, or WebP; Base64 JSON or multipart upload
- •Maximum file size: 4.5MB
- •Price: 2 credits for a successful decode; processing failures are refunded
- •Document kind: `document_kind` is `id_card` for identification-card records and `driver_license` for licenses
- •Output: Structured AAMVA JSON; raw barcode payload is not returned
Key Features
- •One integration for both cards: Licenses and non-driver ID cards share the AAMVA PDF417 layout, so the same request handles both.
- •Explicit document kind: Branch on `document_kind` instead of guessing from missing license class fields.
- •No AI guessing: Identity fields come from a decoded PDF417 payload and AAMVA parser, never from a generative model.
- •Retake-safe errors: PDF417_NOT_DECODED returns HTTP 422 with an optional `capture_issue` hint such as `out_of_focus` or `image_too_small`.
Sample ID Card JSON Output
The example uses fictional values. License-only elements such as vehicle_class are null for ID cards; type stays drivers_license for compatibility.
{
"success": true,
"data": {
"type": "drivers_license",
"document_kind": "id_card",
"source": "pdf417",
"country_code": "USA",
"region": "NY",
"document_number": "SAMPLEID123",
"surname": "SAMPLE",
"given_names": "ALEX MORGAN",
"first_name": "ALEX",
"middle_name": "MORGAN",
"name_suffix": null,
"sex": "F",
"date_of_birth": "1990-01-15",
"date_of_issue": "2025-01-15",
"date_of_expiry": "2033-01-15",
"address": "100 EXAMPLE AVE",
"city": "SAMPLE CITY",
"postal_code": "10001",
"vehicle_class": null,
"restrictions": null,
"endorsements": null,
"height": null,
"eye_color": null,
"document_discriminator": "SAMPLE-DISCRIMINATOR",
"issuer_identification_number": "636000",
"aamva_version": 10,
"jurisdiction_version": 0
}
}Frequently Asked Questions
How does PHP tell a state ID card from a driver license?
Read data.document_kind. It is id_card when the barcode carries an AAMVA identification-card record and driver_license otherwise. Do not infer it from an empty vehicle_class, because some jurisdictions fill that element on ID cards too.
Do I need a different endpoint for ID cards?
No. Use the same /v1/driver-license-pdf417 endpoint and request format. The type field remains drivers_license so existing integrations keep working.
Does a decoded ID card barcode prove the person’s identity?
No. It proves a usable barcode payload was decoded and parsed. Authenticity, identity, and eligibility decisions need separate controls such as document inspection or a face match.
You May Also Like
Related tutorials, platform guides, and comparisons
PHP US Driver License PDF417 API Tutorial
Decode US driver license PDF417 barcodes with PHP. Send a license-back image, parse AAMVA fields, and handle unreadable barcode errors safely.
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!
Saudi Arabia Driver License OCR: Extract Fields with Python
Extract visible fields from Saudi Arabia driver license images into JSON. Map identifiers, names and dates, with a review workflow for incomplete results.
Flask PDF417 Driver License API
Build a compact Python service that decodes US driver license PDF417 barcodes and returns normalized AAMVA JSON with safe retake handling.
Python Driver License OCR SDK & API
Stop struggling with manual data entry. Integrate our driver license OCR SDK (Python wrapper) to extract structured JSON in <3s. Upload an image for a free test! Secure, accurate, and developer-friendly.
Germany Driver License OCR: Extract Fields with Python
Extract visible fields from Germany driver license images into JSON. Map identifiers, names and dates, with a review workflow for incomplete results.
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.
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.
UK Driver License OCR with Python SDK
Extract structured fields from a United Kingdom photocard driving licence with the StructOCR Python SDK and FastAPI.
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.
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 Receipt OCR using Cursor in 5 Minutes
Step-by-step guide to integrating the StructOCR receipt API using the Cursor AI code editor. Build expense tracking and receipt scanning tools rapidly.
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.