{"id":27918287,"url":"https://github.com/horia-apostol/regula-reader-minimal-api","last_synced_at":"2025-10-09T23:12:49.912Z","repository":{"id":290967763,"uuid":"976152994","full_name":"horia-apostol/regula-reader-minimal-api","owner":"horia-apostol","description":"This is a minimal REST API built with .NET 9, designed to expose structured data from identity documents processed by the Regula Document Reader via the COM interface.","archived":false,"fork":false,"pushed_at":"2025-05-01T15:41:50.000Z","size":149,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-01T16:40:24.998Z","etag":null,"topics":["document-reader","mrz","ocr","regula","regulaforensics"],"latest_commit_sha":null,"homepage":"https://app.swaggerhub.com/apis/HoriaApostol/regula-reader-minimal-api/1.0","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/horia-apostol.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-01T15:39:23.000Z","updated_at":"2025-05-01T15:46:01.000Z","dependencies_parsed_at":"2025-05-02T13:45:56.325Z","dependency_job_id":null,"html_url":"https://github.com/horia-apostol/regula-reader-minimal-api","commit_stats":null,"previous_names":["horia-apostol/regula-reader-minimal-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/horia-apostol%2Fregula-reader-minimal-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/horia-apostol%2Fregula-reader-minimal-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/horia-apostol%2Fregula-reader-minimal-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/horia-apostol%2Fregula-reader-minimal-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/horia-apostol","download_url":"https://codeload.github.com/horia-apostol/regula-reader-minimal-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252741727,"owners_count":21797074,"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":["document-reader","mrz","ocr","regula","regulaforensics"],"created_at":"2025-05-06T18:20:53.119Z","updated_at":"2025-10-09T23:12:49.904Z","avatar_url":"https://github.com/horia-apostol.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://www.regulaforensics.com/\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://avatars.githubusercontent.com/u/19432176?s=200\u0026v=4\" alt=\"Regula\" height=\"70\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n# Regula Reader Minimal API (.NET 9)\n\n**[Regula Forensics – Official Website](https://www.regulaforensics.com/)**\n\nThis is a **minimal REST API** built with **.NET 9**, designed to expose structured data from identity documents processed by the **Regula Document Reader** via the COM interface.\n\n---\n\n## Regula Licensing\n\nThis project **does not include** or manage licensing for the Regula SDK. To run this project, you **must install the SDK yourself** and ensure that a valid license is provided and the COM interface is registered.\n\nRefer to official licensing docs:  \n[Regula Licensing Documentation](https://docs.regulaforensics.com/develop/doc-reader-sdk/overview/licensing/)\n\n---\n\n## API Documentation\n\nExplore the full SwaggerHub spec:  \n[SwaggerHub – Regula Reader Minimal API v1.0](https://app.swaggerhub.com/apis/HoriaApostol/regula-reader-minimal-api/1.0)\n\n---\n\n## Example Request\n\n```\nPOST /api/scanner/read?fields=surname,givenNames,documentNumber\u0026visual=true\u0026mrz=true Accept: application/vnd.regula-reader-minimal-api.hateoas.1+json\n```\n\n## Example Response\n\n```json\n{\n  \"data\": {\n    \"surname\": { \"visual\": \"DOE\", \"mrz\": \"DOE\" },\n    \"givenNames\": { \"visual\": \"JOHN\", \"mrz\": \"JOHN\" },\n    \"documentNumber\": { \"visual\": \"X123456\", \"mrz\": \"X123456\" }\n  },\n  \"links\": {\n    \"portrait\": \"http://localhost:5000/api/scanner/image/portrait\",\n    \"full\": \"http://localhost:5000/api/scanner/image/full\",\n    \"bw\": \"http://localhost:5000/api/scanner/image/bw\",\n    \"uv\": \"http://localhost:5000/api/scanner/image/uv\"\n  }\n}\n```\n\n## Official Regula Documentation\n\n- [Programmers Guide (PDF)](https://downloads.regulaforensics.com/work/SDK/doc/Programmers%20Guide%20(en).pdf)\n- [RFID Programmers Guide (PDF)](https://downloads.regulaforensics.com/work/SDK/doc/Programmers%20Guide%20RFID%20(en).pdf)\n- [COM Interface Documentation (PDF)](https://downloads.regulaforensics.com/work/SDK/doc/COM%20interface%20documentation.pdf)\n- [Test Application Guide (PDF)](https://downloads.regulaforensics.com/work/SDK/doc/Test%20Application%20(en).pdf)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoria-apostol%2Fregula-reader-minimal-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhoria-apostol%2Fregula-reader-minimal-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoria-apostol%2Fregula-reader-minimal-api/lists"}