1. IronOCR
  2. How-Tos
  3. Using License Keys

Using IronOCR License Keys

How to Get a License Key

Adding an IronOCR license key allows you to deploy your project live without restrictions or watermarks.

You can buy a license here or sign up for a free 30 day trial key here.

Step 1: Download the Latest Version of IronOCR

C# NuGet Library for OCR

Install with NuGet

Install-Package IronOcr
nuget.org/packages/IronOcr/
or
Java PDF JAR

Download DLL

Download DLL

Manually install into your project

C# NuGet Library for OCR

Install with NuGet

Install-Package IronOcr
nuget.org/packages/IronOcr/
or
Java PDF JAR

Download DLL

Download DLL

Manually install into your project

Start using IronPDF in your project today with a free trial.

First Step:
green arrow pointer

Check out IronOCR on Nuget for quick installation and deployment. With over 8 million downloads, it's transforming OCR with C#.

C# NuGet Library for OCR nuget.org/packages/IronOcr/
Install-Package IronOcr

Consider installing the IronOCR DLL directly. Download and manually install it for your project or GAC form: IronOcr.zip

Manually install into your project

Download DLL

Install via DLL

Download the IronOcr DLL directly to your machine.

Install via NuGet

Alternatively, you can install through NuGet .

Install-Package IronOcr

Step 2: Apply Your License Key

Set your IronOCR license key using code

Add this code to the startup of your application, before IronOCR is used.

IronOcr.License.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01";
IronOcr.License.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01";
IronOcr.License.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01"
VB   C#

You can validate that your software is licensed using either IronOcr.License.IsValidLicense(string LicenseKey) or the IronOcr.License.IsLicensed property.

Set your license key using Web.Config or App.Config

To apply a key globally to your application using Web.Config or App.Config, add the following key to your config file in appSettings.

<configuration>
....
  <appSettings>
    <add key="IronOcr.LicenseKey" value="IRONOCR-MYLICENSE-KEY-1EF01"/>
  </appSettings>
....
</configuration>
XML

There is a known licensing issue between IronOcr version 2023.4.13 - 2024.3.4 on project:

  • ASP.NET projects
  • .NET Framework version >= 4.6.2

The key stored in a Web.config file is NOT being picked up and used by the product. Visit the 'Setting License Key in Web.config' troubleshooting article to learn more.

Set your key using a .NET Core appsettings.json file

To apply a key globally to your application with .NET Core:

  • Add a JSON file to your project called appsettings.json in the root directory of your project
  • Add a 'IronOcr.LicenseKey' key to your JSON config file. The value should be your license key.
  • Ensure that the file properties include Copy to Output Directory: Copy always
  • Ensure that IronOcr.License.IsLicensed returns true to verify.

File: appsettings.json

{

    "IronOcr.LicenseKey":"IRONOCR-MYLICENSE-KEY-1EF01"

}

Step 3: Test your key

Test if your key has been installed correctly.

bool result = IronOcr.License.IsValidLicense("IRONOCR-MYLICENSE-KEY-1EF01");
bool result = IronOcr.License.IsValidLicense("IRONOCR-MYLICENSE-KEY-1EF01");
Dim result As Boolean = IronOcr.License.IsValidLicense("IRONOCR-MYLICENSE-KEY-1EF01")
VB   C#

Step 4: Get started with your project

Follow our tutorial on how to Get Started with IronOCR.

Questions?

If you have any questions, reach out to support@ironsoftware.com