Skip to main content

The official Python SDK for StructOCR API - Passport, ID card, Driver License OCR, and Invoice.

Project description

StructOCR Python SDK

PyPI version License: MIT

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.

👉 Get your Free API Key here

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+
  • requests library

License

MIT License. See LICENSE for details.cd

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

structocr-1.1.2.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

structocr-1.1.2-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file structocr-1.1.2.tar.gz.

File metadata

  • Download URL: structocr-1.1.2.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.9

File hashes

Hashes for structocr-1.1.2.tar.gz
Algorithm Hash digest
SHA256 d651e31646dc2a6cbb3d092aec6ff3703838be0cdda84d6ace846f8bc0c97e8c
MD5 ccbc4b99446dda98d4c423bb28f9e52c
BLAKE2b-256 4b5897dd127d8db508fa2a23b42bee506412d22d644b839ea61a58a70802a487

See more details on using hashes here.

File details

Details for the file structocr-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: structocr-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.9

File hashes

Hashes for structocr-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ac98a95c351cc8d45f57db7a9781b290b9d4b1e5ed5abba62c765963405b3090
MD5 36fb439bce022b9e5e44d31230cb8fa9
BLAKE2b-256 7078f93f13f9ee72778530d72810ef8427074e9bf3ac191b998b6f147dc37a9f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page