Skip to main content

Regula's Document Reader python client

Project description

Regula Document Reader web API Python 3.5+ 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


Performing request:

from regula.documentreader.webclient.ext.api import DocumentReaderApi
from regula.documentreader.webclient.ext.models import *
from regula.documentreader.webclient.gen.models import *

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

with DocumentReaderApi(host='http://localhost:8080') as api:
    params = ProcessParams(
        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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for regula.documentreader.webclient, version 5.2.0
Filename, size File type Python version Upload date Hashes
Filename, size regula.documentreader.webclient-5.2.0-py3-none-any.whl (155.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size regula.documentreader.webclient-5.2.0.tar.gz (74.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page