Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Regula Document Reader web API Python 3.9+ client

pypi OpenAPI documentation live

⚠️ Warning: Package Name Changed

Package name has been changed from regula.documentreader.webclient to regula_documentreader_webclient

Documents recognition as easy as reading two bytes.

If you have any problems with or questions about this client, please contact us through a GitHub issue. You are invited to contribute new features, fixes, or updates, large or small; We are always thrilled to receive pull requests, and do our best to process them as fast as we can. See dev guide

Install package

regula_documentreader_webclient is on the Python Package Index (PyPI):

pip install regula_documentreader_webclient

Or using pipenv

pipenv install regula_documentreader_webclient

Example

Performing request:

from regula_documentreader_webclient import *

with open("australia_passport.jpg", "rb") as f:
    input_image = f.read()

with DocumentReaderApi(host='http://localhost:8080') as api:
    params = ProcessParams(
        scenario=Scenario.FULL_PROCESS,
        result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
    )
    request = RecognitionRequest(process_params=params, images=[input_image])
    response = api.process(request)

Parsing results:

# status examples
response_status = response.status
doc_overall_status = "valid" if response_status.overall_status == CheckResult.OK else "not valid"

# text fields example
doc_number_field = response.text.get_field(TextFieldType.DOCUMENT_NUMBER)
doc_number_mrz = doc_number_field.get_value()
doc_number_visual = doc_number_field.get_value(Source.VISUAL)
doc_number_visual_validity = doc_number_field.source_validity(Source.VISUAL)
doc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ)
doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)

# images fields example
normalized_input_image = response.images.document_image()
portrait_field = response.images.get_field(GraphicFieldType.PORTRAIT)
portrait_from_visual = portrait_field.get_value(Source.VISUAL)
portrait_from_rfid = portrait_field.get_value(Source.RFID, original=True)

You can find more detailed guide and run this sample in example folder.

Metadata

Release files for regula-documentreader-webclient 9.7.962rc0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for regula-documentreader-webclient 9.7.962rc0
File Size Uploaded Provenance Actions
regula_documentreader_webclient-9.7.962rc0.tar.gz 145.8 kB Without provenance Details for regula_documentreader_webclient-9.7.962rc0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for regula-documentreader-webclient 9.7.962rc0
File Interpreter ABI Platform Actions
regula_documentreader_webclient-9.7.962rc0-py3-none-any.whl Python 3 none any Details for regula_documentreader_webclient-9.7.962rc0-py3-none-any.whl

Total release size: 567.8 kB

Release files / regula_documentreader_webclient-9.7.962rc0.tar.gz

Download URL regula_documentreader_webclient-9.7.962rc0.tar.gz
Size 145.8 kB
Tags Source
SHA-256 checksum
How to use checksums
b86d24db2f4f29847578e3ad0206e7ab7938591edd88a11d9b519f4ce52be44b
BLAKE2b-256 checksum
How to use checksums
0acca603f557741177bde3ffb9d1b81c0606316b28baa773bef1804291c2370b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.14

Release files / regula_documentreader_webclient-9.7.962rc0-py3-none-any.whl

Download URL regula_documentreader_webclient-9.7.962rc0-py3-none-any.whl
Size 422.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
31daa190811d6c6e116cabb852b0054af78c7388c4c95cddc9657993945a9337
BLAKE2b-256 checksum
How to use checksums
4056f52111d2e7ff047f67693a1adb9bba4b3f71a87403f41fbd9ee06a08e14e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.14

Security for regula-documentreader-webclient 9.7.962rc0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page