{"id":22400056,"url":"https://github.com/regulaforensics/documentreader-web-java-client","last_synced_at":"2025-06-11T22:34:10.596Z","repository":{"id":41999745,"uuid":"279251217","full_name":"regulaforensics/DocumentReader-web-java-client","owner":"regulaforensics","description":"Regula Document Reader web API java client compatible with jvm and android","archived":false,"fork":false,"pushed_at":"2024-11-28T08:57:48.000Z","size":7708,"stargazers_count":5,"open_issues_count":6,"forks_count":6,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2024-11-28T09:35:04.021Z","etag":null,"topics":["barcode-reader","barcode-scanner","document-reader","document-recognition","idcard","mrz","mrz-codes","ocr","passport","regula","regulaforensics"],"latest_commit_sha":null,"homepage":"https://regulaforensics.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regulaforensics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-13T09:03:17.000Z","updated_at":"2024-11-25T15:32:23.000Z","dependencies_parsed_at":"2023-02-18T08:31:19.248Z","dependency_job_id":"9c6565b5-2fbd-4453-8020-f79ed08fa60f","html_url":"https://github.com/regulaforensics/DocumentReader-web-java-client","commit_stats":null,"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-java-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-java-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-java-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-java-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regulaforensics","download_url":"https://codeload.github.com/regulaforensics/DocumentReader-web-java-client/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228257726,"owners_count":17892652,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["barcode-reader","barcode-scanner","document-reader","document-recognition","idcard","mrz","mrz-codes","ocr","passport","regula","regulaforensics"],"created_at":"2024-12-05T08:11:07.491Z","updated_at":"2024-12-05T08:11:08.105Z","avatar_url":"https://github.com/regulaforensics.png","language":"Java","readme":"# Regula Document Reader java client compatible with jvm and android\n\n[![maven](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fmaven.regulaforensics.com%2FRegulaDocumentReaderWebClient%2Fcom%2Fregula%2Fdocumentreader%2Fwebclient%2Fmaven-metadata.xml\u0026style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)\n[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)\n[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)\n[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://api.regulaforensics.com/)\n\nDocuments recognition as easy as reading two bytes.\n\nIf you have any problems with or questions about this client, please contact us\nthrough a [GitHub issue](https://github.com/regulaforensics/DocumentReader-api-java-client/issues).\nYou are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/DocumentReader-api-java-clien/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small; \nWe are always thrilled to receive pull requests, and do our best to process them as fast as we can.\nSee [dev guide](./dev.md)\n\n\n## Install package\nAdd __Regula Forensics, Inc.__ maven repository to repositories section in your `build.gradle`,\nand declare client as regular dependency.\n\n```gradle\nrepositories {\n    maven {\n        url = uri(\"https://maven.regulaforensics.com/RegulaDocumentReaderWebClient\")\n    }\n}\n\ndependencies {\n    implementation(\"com.regula.documentreader:webclient:5.+\")\n}\n```\n\n## Example\nPerforming request:\n```java\nbyte[] imageBytes = readFile(\"australia_passport.jpg\");\nvar image = new ProcessRequestImage(imageBytes, Light.WHITE);\n\nvar requestParams = new RecognitionParams()\n        .withScenario(Scenario.FULL_PROCESS)\n        .withResultTypeOutput(Result.STATUS, Result.TEXT, Result.IMAGES);\n\nRecognitionRequest request = new RecognitionRequest(requestParams, List.of(image));\n\nvar api = new DocumentReaderApi();\nRecognitionResponse response = api.process(request);\n```\n\nParsing results:\n```java\nvar status = response.status();\nvar docOverallStatus = status.getComplete() == CheckResult.OK ? \"valid\" : \"not valid\";\nvar docOpticalTextStatus = status.getDetailsOptical().getText();\n\nvar docNumberField = response.text().getField(DOCUMENT_NUMBER);\nvar docNumberMrz = docNumberField.getValue(Source.MRZ);\nvar docNumberMrzValidity = docNumberField.sourceValidity(Source.MRZ);\nvar docNumberMrzVisualMatching = docNumberField.crossSourceComparison(Source.MRZ, Source.VISUAL);\n```\nYou can find a more detailed example in  [example](./example) folder.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-java-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-java-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-java-client/lists"}