{"id":28136,"library":"regula-documentreader-webclient","title":"Regula Document Reader WebClient","description":"Official Python client for Regula's Document Reader API, enabling identity document authentication and data extraction. Current version 9.4.829, maintained by Regula. Release cadence follows API updates.","status":"active","version":"9.4.829","language":"python","source_language":"en","source_url":"https://github.com/regulaforensics/DocumentReader-web-api-client-python","tags":["document-reader","identity-verification","ocr","regula"],"install":[{"cmd":"pip install regula-documentreader-webclient","lang":"bash","label":"Install via pip"}],"dependencies":[],"imports":[{"note":"Package uses underscores in import path, not hyphens.","wrong":"from regula_documentreader_webclient.api import ProcessingApi","symbol":"ProcessingApi","correct":"from regula.documentreader.webclient.api import ProcessingApi"},{"note":"","wrong":"from regula.documentreader.webclient import ProcessingApi","symbol":"ProcessingApi","correct":"from regula.documentreader.webclient import ProcessingApi"},{"note":"","wrong":"","symbol":"ProcessRequest","correct":"from regula.documentreader.webclient.models import ProcessRequest"}],"quickstart":{"code":"from regula.documentreader.webclient import ProcessingApi\nfrom regula.documentreader.webclient.models import ProcessRequest\nimport os\n\napi = ProcessingApi(access_token=os.environ.get('REGULA_API_KEY', ''))\nrequest = ProcessRequest(base64=\"base64_image_data\")\nresponse = api.process(request)\nprint(response)","lang":"python","description":"Initialize API client with access token, create a process request with base64-encoded image, and call process."},"warnings":[{"fix":"Use `async def` and `await api.process(request)` with an event loop.","message":"The synchronous client method `process` is deprecated in v9.x in favor of the asynchronous version.","severity":"deprecated","affected_versions":">=9.0.0"},{"fix":"Initialize `ProcessingApi(access_token='your_token')`.","message":"The access token must be passed as `access_token` parameter, not as a header.","severity":"gotcha","affected_versions":"all"},{"fix":"Strip any prefix before setting the base64 property.","message":"The API expects images in base64 format without data URI prefix (e.g., 'data:image/png;base64,').","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-09T00:00:00.000Z","next_check":"2026-08-07T00:00:00.000Z","problems":[{"fix":"Use `ProcessingApi(access_token='your_token')`","cause":"The parameter is named `access_token`, not `api_key`.","error":"TypeError: ProcessingApi.__init__() got an unexpected keyword argument 'api_key'"},{"fix":"Install: `pip install regula-documentreader-webclient`. Import: `from regula.documentreader.webclient.api import ProcessingApi`","cause":"Package installed with hyphens but imported with underscores incorrectly, or not installed.","error":"ModuleNotFoundError: No module named 'regula'"},{"fix":"Wrap API call in try/except catching `regula.documentreader.webclient.ApiException`.","cause":"The API returned an error response that was not handled; check the response object.","error":"AttributeError: 'NoneType' object has no attribute 'status_code'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}