Skip to content

horia-apostol/regula-reader-minimal-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Regula


Regula Reader Minimal API (.NET 9)

Regula Forensics – Official Website

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.


Regula Licensing

This 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.

Refer to official licensing docs:
Regula Licensing Documentation


API Documentation

Explore the full SwaggerHub spec:
SwaggerHub – Regula Reader Minimal API v1.0


Example Request

POST /api/scanner/read?fields=surname,givenNames,documentNumber&visual=true&mrz=true Accept: application/vnd.regula-reader-minimal-api.hateoas.1+json

Example Response

{
  "data": {
    "surname": { "visual": "DOE", "mrz": "DOE" },
    "givenNames": { "visual": "JOHN", "mrz": "JOHN" },
    "documentNumber": { "visual": "X123456", "mrz": "X123456" }
  },
  "links": {
    "portrait": "http://localhost:5000/api/scanner/image/portrait",
    "full": "http://localhost:5000/api/scanner/image/full",
    "bw": "http://localhost:5000/api/scanner/image/bw",
    "uv": "http://localhost:5000/api/scanner/image/uv"
  }
}

Official Regula Documentation

About

Minimal REST API built with .NET 9, designed to expose structured data from IDs processed by the Regula Document Reader via the COM interface.

Topics

Resources

License

Stars

Watchers

Forks

Languages