MrzScannerSDK 1.0.1

.NET MRZ Scanner SDK

The .NET MRZ Scanner SDK is a C# wrapper for Dynamsoft C++ Label Recognizer SDK. It is used to recognize MRZ information for passport, Visa, ID card and travel documents.

License Activation

Click here to get a valid license key.

Supported Platforms

• Windows (x64)
• Linux (x64)

Download .NET 6 SDK

• Windows
• Linux

Methods

• public static void InitLicense(string license)
• public static MrzScanner Create()
• public Result[]? DetectFile(string filename)
• public Result[]? DetectBuffer(IntPtr pBufferBytes, int width, int height, int stride, ImagePixelFormat format)
• public static string? GetVersionInfo()
• public int LoadModel()

Usage

• Set the license key:

  MrzScanner.InitLicense("DLS2eyJoYW5kc2hha2VDb2RlIjoiMjAwMDAxLTE2NDk4Mjk3OTI2MzUiLCJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSIsInNlc3Npb25QYXNzd29yZCI6IndTcGR6Vm05WDJrcEQ5YUoifQ=="); 
  

• Initialize the MRZ scanner object:

  MrzScanner scanner = MrzScanner.Create();
  

• Detect MRZ from an image file:

  Result[]? resultArray = scanner.DetectFile(filename);
  

• Detect MRZ from a buffer:

  Mat mat = Cv2.ImRead(filename, ImreadModes.Color);
  Result[]? resultArray = scanner.DetectBuffer(copy.Data, copy.Cols, copy.Rows, (int)copy.Step(), MrzScanner.ImagePixelFormat.IPF_RGB_888);
  

• Get SDK version number:

  string? version = MrzScanner.GetVersionInfo();
  

• Load the MRZ detection model:

  scanner.LoadModel();
  

• Parse the MRZ information:

  string[] lines = new string[_results.Length];
  var index = 0;
  foreach (Result result in _results)
  {
      lines[index++] = result.Text;
  }
  
  JsonNode? info = Parse(lines);
  

Quick Start

using System;
using System.Runtime.InteropServices;
using Dynamsoft;

namespace Test
{
    class Program
    {
        static void Main(string[] args)
        {
            MrzScanner.InitLicense("DLS2eyJoYW5kc2hha2VDb2RlIjoiMjAwMDAxLTE2NDk4Mjk3OTI2MzUiLCJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSIsInNlc3Npb25QYXNzd29yZCI6IndTcGR6Vm05WDJrcEQ5YUoifQ=="); // Get a license key from https://www.dynamsoft.com/customer/license/trialLicense?product=dlr
            Console.WriteLine("Version: " + MrzScanner.GetVersionInfo());
            MrzScanner scanner = MrzScanner.Create();
            int ret = scanner.LoadModel();
            Console.WriteLine("LoadModel: " + ret);

            MrzScanner.Result[]? results = scanner.DetectFile("1.png");
            if (results != null)
            {
                foreach (MrzScanner.Result result in results)
                {
                    Console.WriteLine(result.Text);
                    Console.WriteLine(result.Points[0] + ", " +result.Points[1] + ", " + result.Points[2] + ", " + result.Points[3] + ", " + result.Points[4] + ", " + result.Points[5] + ", " + result.Points[6] + ", " + result.Points[7]);
                }
            }

        }
    }
}

Example

• Command-line MRZ Scanner (Windows & Linux)

  # DEBUG
  dotnet run
  # RELEASE
  dotnet run --configuration Release
  

• Command-line MRZ Scanner with OpenCVSharp Windows runtime. To make it work on Linux, you need to install OpenCVSharp4.runtime.ubuntu.18.04-x64 package.

  dotnet run
  

• WinForms Desktop MRZ Scanner (Windows Only)

  dotnet run
  

  

Building NuGet Package from Source Code

dotnet build --configuration Release