Regula Face SDK web API Python 3.9+ client

⚠️ Warning: Package Name Changed

Package name has been changed from `regula.facesdk.webclient` to `regula_facesdk_webclient`

Face 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_facesdk_webclient is on the Python Package Index (PyPI):

pip install regula_facesdk_webclient

Or using pipenv

pipenv install regula_facesdk_webclient

Example

Performing request:

from regula.facesdk.webclient import MatchImage, MatchRequest
from regula.facesdk.webclient.ext import FaceSdk, DetectRequest
from regula.facesdk.webclient.gen.model.image_source import ImageSource

with open("face1.jpg", "rb") as f:
    face_1_bytes = f.read()

with open("face2.jpg", "rb") as f:
    face_2_bytes = f.read()

with FaceSdk(host="http://0.0.0.0:41101") as sdk:
    images = [
        MatchImage(index=1, data=face_1_bytes, type=ImageSource.LIVE),
        MatchImage(index=2, data=face_1_bytes, type=ImageSource.DOCUMENT_RFID),
        MatchImage(index=3, data=face_2_bytes)
    ]
    match_request = MatchRequest(images=images)
    match_response = sdk.match_api.match(match_request)

    detect_request = DetectRequest(image=face_1_bytes)
    detect_response = sdk.match_api.detect(detect_request)

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

Metadata

Release files for regula-facesdk-webclient 8.4.875

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-facesdk-webclient 8.4.875
File	Size	Uploaded
regula_facesdk_webclient-8.4.875.tar.gz	64.8 kB	Oct 7, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for regula-facesdk-webclient 8.4.875
File	Interpreter	ABI	Platform	Reset
regula_facesdk_webclient-8.4.875-py3-none-any.whl 185.0 kB Oct 7, 2026	Python 3	none	any	Details

Total release size: 249.8 kB

Release files / regula_facesdk_webclient-8.4.875.tar.gz

Download URL	regula_facesdk_webclient-8.4.875.tar.gz
Size	64.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`43057bdb25c2b89adf4ae8f471205dbccf5108d5cabf3a715a223ba8b44a55e5`
BLAKE2b-256 checksum How to use checksums	`e2fd4ec2ccf35dcd23b4d0fa63321ee8cee246b3a33655c71638cada3db81016`
Upload date	Oct 7, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.10.14`

Release files / regula_facesdk_webclient-8.4.875-py3-none-any.whl

Download URL	regula_facesdk_webclient-8.4.875-py3-none-any.whl
Size	185.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`41f34a8d934ca1faeedeb0639b33952e16cc7d2ef5e4f7bd9265073eeddacc0b`
BLAKE2b-256 checksum How to use checksums	`37dcf13f38f645c4bc816ddf93a460913ac2f68a74c62231850f3c37efdc0190`
Upload date	Oct 7, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.10.14`