Registry / auth-security / regula-documentreader-webclient

regula-documentreader-webclient

library9.4.829pypypiunverified

Official Python client for Regula's Document Reader API, enabling identity document authentication and data extraction. Current version 9.4.829, maintained by Regula. Release cadence follows API updates.

auth-security http-networking aws gcp azure

pip install regula-documentreader-webclient

package ↗homepage ↗

INSTALL

IMPORT

SIG · REGULA-DOCUMENTREA

regula-documentreader-webclient

auth-securitypythonv9.4.829

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ProcessingApi

✓ from regula.documentreader.webclient.api import ProcessingApi

✗ from regula.documentreader.webclient.api import ProcessingApi

Initialize API client with access token, create a process request with base64-encoded image, and call process.

from regula.documentreader.webclient import ProcessingApi from regula.documentreader.webclient.models import ProcessRequest import os api = ProcessingApi(access_token=os.environ.get('REGULA_API_KEY', '')) request = ProcessRequest(base64="base64_image_data") response = api.process(request) print(response)

Debug

Known issues

deprecatedThe synchronous client method `process` is deprecated in v9.x in favor of the asynchronous version.

fix

Use `async def` and `await api.process(request)` with an event loop.

affects: >=9.0.0

gotchaThe access token must be passed as `access_token` parameter, not as a header.

fix

Initialize `ProcessingApi(access_token='your_token')`.

affects: all

gotchaThe API expects images in base64 format without data URI prefix (e.g., 'data:image/png;base64,').

fix

Strip any prefix before setting the base64 property.

affects: all

Upgrade

Version history

9.4.829latest on PyPI · released Apr 29, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

48 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://pypi.org/project/regula-documentreader-webclient/ ↗

homepagehttps://regulaforensics.com ↗