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.

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.1.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.1-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: structocr-1.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 ef7b22dbb0b3de22b4280a87f90258c07c4e1c2f638a7187028b70e9b56dbf39
MD5 b634ec4e76b1da39d8549656583bc85d
BLAKE2b-256 42925bd565b882d6945e32ee93bf663bd029d675a3a16607663f93eab6203f37

See more details on using hashes here.

File details

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

File metadata

  • Download URL: structocr-1.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8de4bda99203ca8ba7566346b3f127047be3c6908ed00ef20f711f958fd9f51a
MD5 44760e285773e45d1969bd6f93a063f9
BLAKE2b-256 3239519119221daa84b5fd3e36a7364fc97a172e1ca8548f8bd6f76a40ea12f6

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