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, Driver License OCR and Invoice 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.
  • Invoice OCR: Extract invoice number, currency, merchant, customer.
  • 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 or Invoice

# 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')

# Invoice OCR
license_data = client.scan_invoice('./docs/invoice.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.3.tar.gz (3.7 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.3-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: structocr-1.1.3.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

Hashes for structocr-1.1.3.tar.gz
Algorithm Hash digest
SHA256 57c2947bb69f2de2c93b3dc944ae0377f3574e06fc93636e145e9621c368b68b
MD5 f4d21ccebc8815e3ec60f0332fe8024e
BLAKE2b-256 5268d7a527624d1ea04e97aca2cd2640486d391abe8bae1d0d17292b41e57492

See more details on using hashes here.

File details

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

File metadata

  • Download URL: structocr-1.1.3-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

Hashes for structocr-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 62ed1aff985f402e8355149e2e1a57b1a5d5079912ef78235bff882db34aefbc
MD5 9522c4201ab3a2a6c85aa7ea9885ea73
BLAKE2b-256 77e6b9fec45709d03c94955c0a6054fd8190729627034d2801cdc3e9e505f016

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