The official Python SDK for StructOCR API - Passport, ID, and Driver License OCR.
Project description
StructOCR Python SDK
The official Python client for StructOCR.
StructOCR is a powerful API tailored for developers to extract structured data from identity documents with high accuracy. This SDK helps you integrate Passport OCR, National ID OCR, and Driver License OCR into your Python applications in minutes.
Features
- Passport OCR API: Instantly extract MRZ, name, DOB, and expiry date from passports of 200+ countries.
- National ID OCR: Support for ID cards with automatic field mapping.
- Driver License OCR: Extract vehicle class, license number, and personal details.
- Secure & Fast: Enterprise-grade encryption and sub-second response times.
Installation
Install the package via pip:
pip install structocr
Quick Start
1. Initialize the Client
from structocr import StructOCR
# Initialize with your API Key
client = StructOCR(api_key="sk_live_xxxxxxxx")
2. Scan a Passport (Passport OCR)
# Pass the path to the passport image file
result = client.scan_passport('./docs/passport_sample.jpg')
print(f"Name: {result['data']['name']}")
print(f"Passport Number: {result['data']['document_number']}")
3. Scan a National ID or Driver License
# National ID OCR
id_data = client.scan_national_id('./docs/id_card.png')
# Driver License OCR
license_data = client.scan_driver_license('./docs/license.jpg')
Documentation
For full API documentation, response examples, and error codes, please visit the StructOCR Developer Docs.
Requirements
- Python 3.6+
requestslibrary
License
MIT License. See LICENSE for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file structocr-1.0.1.tar.gz.
File metadata
- Download URL: structocr-1.0.1.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e0c25da71be0994421d23ada97fc3fc338d1bb499f1304cfc3cbaf617ae6502
|
|
| MD5 |
b74cba6d6efb9c6e6b00abe6185ab651
|
|
| BLAKE2b-256 |
23b1989c01723e53b391104eb8ae3c7908cfeafbe7ade16475299183d5ae7419
|
File details
Details for the file structocr-1.0.1-py3-none-any.whl.
File metadata
- Download URL: structocr-1.0.1-py3-none-any.whl
- Upload date:
- Size: 3.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1e2af79705c6f85c7ac1d2f5b0e51a3c5d7d0c079d9500dea1e7fe6b629e96f2
|
|
| MD5 |
11574c68c8956177755ef3d85a2aae75
|
|
| BLAKE2b-256 |
cdbc088d9b8ccccd36105f160c7bddb12af55417ce8a89bbf1eb909c0fbd5ad4
|