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.8+ client

pypi OpenAPI documentation live

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 7.5.161rc0

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 7.5.161rc0
File Size Uploaded Provenance Actions
regula_documentreader_webclient-7.5.161rc0.tar.gz 131.7 kB Without provenance Details for regula_documentreader_webclient-7.5.161rc0.tar.gz

Built distribution (wheel)

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

Total release size: 440.7 kB

Release files / regula_documentreader_webclient-7.5.161rc0.tar.gz

Download URL regula_documentreader_webclient-7.5.161rc0.tar.gz
Size 131.7 kB
Tags Source
SHA-256 checksum
How to use checksums
89e2330a66d7443b434552105883ccf195f9f3d4d56728a8d0955bdf0a27c2ac
BLAKE2b-256 checksum
How to use checksums
5f179e9bc7b0c9ac2d4fc0b1b5e8e6dbb1788936fa239570e6f368c03e2eab38
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.8.20

Release files / regula.documentreader.webclient-7.5.161rc0-py3-none-any.whl

Download URL regula.documentreader.webclient-7.5.161rc0-py3-none-any.whl
Size 309.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
90573991e77386caa567c598e74607906019a58660a0c70ba1bab0ff230e87ac
BLAKE2b-256 checksum
How to use checksums
82a4742ed49af95ffa38fcd7c0436fe3413bb533cf216ce57d49ad50ca87a347
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.8.20

Security for regula-documentreader-webclient 7.5.161rc0

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