Regula Document Reader web API Python 3.9+ client

⚠️ 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 8.4.536rc0

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 8.4.536rc0
File	Size	Uploaded
regula_documentreader_webclient-8.4.536rc0.tar.gz	136.5 kB	Oct 16, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for regula-documentreader-webclient 8.4.536rc0
File	Interpreter	ABI	Platform	Reset
regula_documentreader_webclient-8.4.536rc0-py3-none-any.whl 384.7 kB Oct 16, 2025	Python 3	none	any	Details

Total release size: 521.2 kB

Release files / regula_documentreader_webclient-8.4.536rc0.tar.gz

Download URL	regula_documentreader_webclient-8.4.536rc0.tar.gz
Size	136.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`43f73c4bdd0313867996f28add7f1f3b352af754bf787da2eff0f3d2f8f187be`
BLAKE2b-256 checksum How to use checksums	`e19f4665f8f22362006197afa3d3c3ef8be6439704715a5791d50c9742da3f4e`
Upload date	Oct 16, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.24`

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

Download URL	regula_documentreader_webclient-8.4.536rc0-py3-none-any.whl
Size	384.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`496f22a6f1f1c237517c0ae97bd7ac90cfdd9b07c88062e8f3ad2bf35b9cdbf5`
BLAKE2b-256 checksum How to use checksums	`dd5b75b4ed7bc3b0b1275af5be056efdc0b1ffa404d93270dc3a1c5aa4b13255`
Upload date	Oct 16, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.24`