Official SDK

StructOCR Python SDK

Add passport and document OCR to your Python backend without manually encoding files or maintaining REST request code.

Get API Key — 200 Free Credits View on PyPI GitHub source

Install the SDK

Install or upgrade the official structocr package from PyPI.

BASH EXAMPLE

pip install --upgrade structocr

Passport OCR quickstart

Store the API key in STRUCTOCR_API_KEY, keep it on the server, and pass a supported local file to the SDK.

Never expose your StructOCR API key in browser or mobile client code.

import os
from structocr import StructOCR

client = StructOCR(api_key=os.environ["STRUCTOCR_API_KEY"])
result = client.scan_passport("./passport.jpg")

if result.get("success"):
    passport = result["data"]
    print(passport.get("passport_number"))
    print(passport.get("given_names"), passport.get("surname"))
else:
    print(result.get("error"))

For the complete request and response schema, see the Passport OCR API reference.

The SDK converts paths or in-memory data to Base64 locally. The REST API itself accepts JSON with an img Base64 string, not file paths, binary bodies, URLs, or multipart uploads.

Supported OCR methods

Document type	SDK method
Passport	scan_passport()
National ID	scan_national_id()
Driver License	scan_driver_license()
Invoice	scan_invoice()
Receipt	scan_receipt()
VIN	scan_vin()
HIN	scan_hin()
Shipping Container	scan_container()
License Plate	scan_license_plate()
Vehicle Registration	scan_vehicle_registration()
ATM Cassette	scan_atm_cassette()
Account Balance	get_account_balance()

Package registries are the source of truth for the latest published version and release notes.

Runtime

Python 3.7+

Input

Local JPG, PNG, WebP, or PDF path; or bytes

Output

Structured result with success, data, and error fields

Authentication and errors

Read the API key from a server-side environment variable.
Check the returned success value before using data.
Handle invalid input, insufficient credits, and temporary service failures in your application.
Use the API reference for HTTP status codes and detailed error layouts.

Ready to make your first SDK call?

Create an account, receive 200 free credits, and test up to 100 passport scans.

Get your API key