IdParser.Core 3.0.0-alpha2

This is a prerelease version of IdParser.Core.
There is a newer version of this package available.
See the version list below for details.
dotnet add package IdParser.Core --version 3.0.0-alpha2                
NuGet\Install-Package IdParser.Core -Version 3.0.0-alpha2                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="IdParser.Core" Version="3.0.0-alpha2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add IdParser.Core --version 3.0.0-alpha2                
#r "nuget: IdParser.Core, 3.0.0-alpha2"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install IdParser.Core as a Cake Addin
#addin nuget:?package=IdParser.Core&version=3.0.0-alpha2&prerelease

// Install IdParser.Core as a Cake Tool
#tool nuget:?package=IdParser.Core&version=3.0.0-alpha2&prerelease                

IdParser.Core

publish NuGet

IdParser.Core can be used to parse AAMVA-compliant driver's licenses and ID cards into objects that you can work with. More information on the versions of the AAMVA standard can be found here. More information on the D20 Data Dictionary can be found here.

Usage

  1. Include the using
using IdParser.Core;
  1. Then you're off to the races!
var parseResult = Barcode.Parse(barcode);
Console.WriteLine(parseResult.Card.StreetLine1.Value); // "123 NORTH STATE ST."
Console.WriteLine(parseResult.Card.IssuerIdentificationNumber.Value.GetDescriptionOrDefault()); // "New York"

if (parseResult.Card is DriversLicense license)
{
    Console.WriteLine(license.Jurisdiction.VehicleClass.Value); // "C"
}

If a field fails to parse, you can inspect the field's raw value:

if (parseResult.Card.FirstName.HasError)
{
    Console.WriteLine(parseResult.Card.FirstName.Error); // The error message, if any.
    Console.WriteLine(parseResult.Card.FirstName.RawValue); // The raw value from the scanned ID text.
}

You can also check to see whether a field was present in the scanned ID text:

Console.WriteLine($"First Name present? {parseResult.Card.FirstName.Present}");

More Examples

Take a look at the unit test project for more examples and usage.

Client

The IdParser.Core.Client project is a handy GUI application to help test and verify that an ID will be parsed correctly. The app works with both OPOS and HID keyboard emulation scanners.

alternate text is missing from this package README image

Credit

This is a fork of Connor O'Shea's IdParser library. Big thanks to him for all of his work.

The main changes I made for v1.0.0 of IdParser.Core are:

  • Dropped support for .NET Framework. If you need that, please use the original IdParser.
  • Supports only .NET 6 and above. If you need support for earlier versions of .NET/.NET Core, please use the original IdParser.
  • The parser classes are now static and no longer instantiated by Activator.CreateInstance. This reduced memory allocations per call considerably, and also sped things up.
  • The Abbreviation, Country, and Description attribute values are now cached so that we don't have to repeatedly use reflection to get their values.
  • Unhandled parsing exceptions are now rethrown, regardless of what the caller passes for the validation level (None or Strict).
  • Where possible, modernized the code base to use newer framework and language features, such as Span<T>.
  • The return value of Parse is now an object that returns both the ID card and a collection of any unknown element Ids.
  • Parse now accepts an optional Microsoft.Extensions.Logging.ILoggerFactory parameter. When not null, the library will log to an instance of ILogger.
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.1.0 44 11/20/2024
3.0.0 475 3/28/2024
3.0.0-beta3 119 3/21/2024
3.0.0-beta2 79 3/21/2024
3.0.0-beta1 102 3/12/2024
3.0.0-alpha2 87 3/12/2024
3.0.0-alpha1 105 3/7/2024
2.0.0 143 3/7/2024
2.0.0-alpha5 184 1/10/2024
2.0.0-alpha4 96 1/10/2024
2.0.0-alpha3 86 1/10/2024
2.0.0-alpha2 133 12/23/2023
2.0.0-alpha1 135 12/16/2023
1.1.0 278 12/14/2023
1.0.4 212 12/5/2023
1.0.3 224 10/26/2023
1.0.2 184 9/27/2023
1.0.1 160 9/27/2023
1.0.0 150 9/20/2023
1.0.0-beta8 146 9/8/2023
1.0.0-beta7 140 9/8/2023
1.0.0-beta6 136 9/8/2023
1.0.0-beta5 134 9/8/2023
1.0.0-beta4 148 8/8/2023
1.0.0-beta3 152 7/24/2023
1.0.0-beta2 150 7/23/2023
1.0.0-beta1 146 7/22/2023
1.0.0-alpha9 149 7/22/2023
1.0.0-alpha8 144 7/22/2023
1.0.0-alpha7 159 7/22/2023
1.0.0-alpha6 153 7/22/2023
1.0.0-alpha5 144 7/22/2023
1.0.0-alpha4 143 7/22/2023
1.0.0-alpha3 145 7/22/2023
1.0.0-alpha2 139 7/22/2023
1.0.0-alpha11 150 7/22/2023
1.0.0-alpha10 148 7/22/2023
1.0.0-alpha1 141 7/22/2023