1. IronOCR
2. Get Started
3. Using License Keys

Using IronOCR License Keys

ByChaknith Bin

August 28, 2018

Updated  June 22, 2025

Share:

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 key or sign up for a free 30 day trial key here.

Step 1: Download the Latest Version of IronOCR

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

First Step:

Start for Free

Install via DLL

Download the IronOcr DLL directly to your machine.

Install via NuGet

Alternatively, you can install through NuGet.

# Run the following command in your terminal to install IronOcr via NuGet
nuget install IronOcr

# Run the following command in your terminal to install IronOcr via NuGet
nuget install 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.

// Set your IronOCR license key at the beginning of your application
IronOcr.License.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01";

// Set your IronOCR license key at the beginning of your application
IronOcr.License.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01";

' Set your IronOCR license key at the beginning of your application
IronOcr.License.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01"

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>
    <!-- Set your IronOCR license key here -->
    <add key="IronOcr.LicenseKey" value="IRONOCR-MYLICENSE-KEY-1EF01"/>
  </appSettings>
  ...
</configuration>

<configuration>
  ...
  <appSettings>
    <!-- Set your IronOCR license key here -->
    <add key="IronOcr.LicenseKey" value="IRONOCR-MYLICENSE-KEY-1EF01"/>
  </appSettings>
  ...
</configuration>

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.

// Validate the license key
bool result = IronOcr.License.IsValidLicense("IRONOCR-MYLICENSE-KEY-1EF01");

// Validate the license key
bool result = IronOcr.License.IsValidLicense("IRONOCR-MYLICENSE-KEY-1EF01");

' Validate the license key
Dim result As Boolean = IronOcr.License.IsValidLicense("IRONOCR-MYLICENSE-KEY-1EF01")

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

Chaknith Bin

  Chat with engineering team now

Software Engineer

Chaknith works on IronXL and IronBarcode. He has deep expertise in C# and .NET, helping improve the software and support customers. His insights from user interactions contribute to better products, documentation, and overall experience.

Ready to Get Started?

Free NuGet Download Total downloads: 3,904,374

View Licenses