{"id":22400057,"url":"https://github.com/regulaforensics/documentreader-web-csharp-client","last_synced_at":"2025-08-20T09:09:12.683Z","repository":{"id":41999373,"uuid":"279251758","full_name":"regulaforensics/DocumentReader-web-csharp-client","owner":"regulaforensics","description":"Regula Document Reader web API c# client compatible with .NET \u0026 .NET Core","archived":false,"fork":false,"pushed_at":"2025-07-07T10:23:27.000Z","size":7899,"stargazers_count":9,"open_issues_count":2,"forks_count":6,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-07-07T10:26:18.250Z","etag":null,"topics":["barcode","barcode-scanner","document-reader","document-recognition","idcard-check","idcard-ocr","mrz","mrz-codes","nuget","ocr","passport","regula","regulaforensics"],"latest_commit_sha":null,"homepage":"https://regulaforensics.com","language":"C#","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,"zenodo":null}},"created_at":"2020-07-13T09:05:33.000Z","updated_at":"2025-07-07T09:10:23.000Z","dependencies_parsed_at":"2023-02-18T08:31:19.380Z","dependency_job_id":"f86cd60c-49c2-45ed-8413-37b5a45b4487","html_url":"https://github.com/regulaforensics/DocumentReader-web-csharp-client","commit_stats":null,"previous_names":[],"tags_count":70,"template":false,"template_full_name":null,"purl":"pkg:github/regulaforensics/DocumentReader-web-csharp-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-csharp-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-csharp-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-csharp-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-csharp-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regulaforensics","download_url":"https://codeload.github.com/regulaforensics/DocumentReader-web-csharp-client/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-csharp-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265553200,"owners_count":23787034,"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","barcode-scanner","document-reader","document-recognition","idcard-check","idcard-ocr","mrz","mrz-codes","nuget","ocr","passport","regula","regulaforensics"],"created_at":"2024-12-05T08:11:08.794Z","updated_at":"2025-07-17T00:06:07.306Z","avatar_url":"https://github.com/regulaforensics.png","language":"C#","readme":"# Regula.DocumentReader.WebClient - the C# library for the Regula Document Reader Web API\n\n[![NuGet version (Regula.OpenApi.WebClient)](https://img.shields.io/nuget/v/Regula.DocumentReader.WebClient.svg?style=flat-square)](https://www.nuget.org/packages/Regula.DocumentReader.WebClient/)\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\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-web-csharp-client/issues).\nYou are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/DocumentReader-web-csharp-client/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.\n\n## Frameworks supported\n\n- .NET Standard 2.0\n- .NET Framework 4.6.1 or later\n- .Net Core 2.0 or later\n\n## Install package\n`Regula.DocumentReader.WebClient` is on the NuGet Package Index:\n\n```bash\nPM\u003e Install-Package Regula.DocumentReader.WebClient -Version 5.2.0\n```\n\n## Example\n\nPerforming request:\n```csharp\nvar imageBytes = File.ReadAllBytes(\"australia_passport.jpg\");\nvar image = new ProcessRequestImage(new ImageData(imageBytes), Light.WHITE);\n\nvar requestParams = new RecognitionParams()\n    .WithScenario(Scenario.FULL_PROCESS)\n    .WithResultTypeOutput(new List\u003cint\u003e { Result.STATUS, Result.TEXT, Result.IMAGES, Result.DOCUMENT_TYPE });\nvar request = new RecognitionRequest(requestParams, image);\n\nvar api = licenseFromEnv != null \n    ? new DocumentReaderApi(apiBaseUrl).WithLicense(licenseFromEnv)\n    : new DocumentReaderApi(apiBaseUrl).WithLicense(licenseFromFile);\n\nvar response = api.Process(request);\n```\n\nParsing results:\n```csharp\nvar response = api.Process(request);\n\n// status examples\nvar status = response.Status();\nstring docOverallStatus = status.OverallStatus == CheckResult.OK ? \"valid\" : \"not valid\";\nstring docOpticalTextStatus = status.DetailsOptical.Text == CheckResult.OK ? \"valid\" : \"not valid\";\n\n// text fields examples\nvar docNumberField = response.Text().GetField(TextFieldType.DOCUMENT_NUMBER);\nstring docNumberVisual = docNumberField.GetValue(Source.VISUAL);\nstring docNumberMrz = docNumberField.GetValue(Source.MRZ);\nint docNumberVisualValidity = docNumberField.SourceValidity(Source.VISUAL);\nint docNumberMrzValidity = docNumberField.SourceValidity(Source.MRZ);\nint docNumberMrzVisualMatching = docNumberField.CrossSourceComparison(Source.MRZ, Source.VISUAL);\n\n// images fields examples\nvar documentImage = response.Images().GetField(GraphicFieldType.DOCUMENT_FRONT).GetValue();\nvar portraitField = response.Images().GetField(GraphicFieldType.PORTRAIT);\nvar portraitFromVisual = portraitField.GetValue(Source.VISUAL);\n```\nYou can find this sample in [the example](https://github.com/regulaforensics/DocumentReader-web-csharp-client/tree/master/src/Regula.DocumentReader.NetCoreExample).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-csharp-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-csharp-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-csharp-client/lists"}