Skip to content

Processing Scenarios

Overview

A scenario is the main setting for Document Reader SDK. It controls all scanning processes of the Core framework and defines the way Core works. The set of available scenarios is different for each Core type.

Warning

The available scenarios are determined by both the Core capabilities and your license. Your license takes precedence. If your license has fewer capabilities than the Core, you will only see scenarios that align with your license capabilities.

Feel free to reach out to your personal manager for any questions or changes regarding your licensing options. Alternatively, you can submit an inquiry to our Support Portal and we will get back to you as soon as possible.

To get the list of available scenarios, after the initialization, invoke:

for scenario in DocReader.shared.availableScenarios {
    print(scenario)
}
for (RGLScenario *scenario in RGLDocReader.shared.availableScenarios) {
    NSLog(@"%@", scenario);
}
val scenarios = ArrayList<String>()
for (scenario in DocumentReader.Instance().availableScenarios) {
    scenarios.add(scenario.name)
}
ArrayList<String> scenarios = new ArrayList<>();
for (DocumentReaderScenario scenario : DocumentReader.Instance().availableScenarios) {
    scenarios.add(scenario.name);
}
for (var scenario in DocumentReader.instance.availableScenarios) {
  print(scenario.name);
}
DocumentReader.getAvailableScenarios((jstring) => {
    // get available scenarios
}, e => { }, error => console.log(error))
DocumentReader.getAvailableScenarios().then(scenarios =>
    console.log(scenarios)
);
DocumentReader.getAvailableScenarios(
      function(scenarios) {
          // get scenarios
      },
      function (error) { console.log(error) });
);
// Android
var scenarios = new List<string>();
foreach (DocumentReaderScenario scenario in DocumentReader.Instance().AvailableScenarios)
{
    scenarios.Add(scenario.Name);
}

// iOS
foreach (var scenario in RGLDocReader.Shared.AvailableScenarios)
{
    Console.WriteLine(scenario);
}

Features

Different scenarios support different sets of features, below is the full list of available features.

Feature Description
Visual zone OCR Optical character recognition of the document visual zone text fields based on document templates included in the database.
Document type identification Automatic recognition of the document type: no need to manually select a country, document type, and series for processing.
MRZ OCR Reading and parsing the machine-readable zone lines into separate fields.
Barcode recognition Reading the 1D and 2D (PDF417, QR, Aztec, Datamatrix) barcodes and automatic parsing into text fields using included document template specifications. Can be performed only if the template database is available and the document type is identified.
Document location Detecting the document boundaries and cropping out the document from the supplied picture.
Graphics cropping Cropping graphic fields, such as a photo portrait and signature, based on templates included in the database.
Checking security features For each document type, certain security checks can be performed. For example, UV dull paper check, image patterns (VIS), IR transparency, etc. You can find the security checks by document types in the Documents list.
Hologram detection Automatically determining the location of a hologram and checking the hologram authenticity.
Multipage processing Processing child documents (second page, back side) if they are identified for the detected document type or if an ID1-sized document is processed.

Scenarios

Below is the full list of available processing scenarios.

Name ID Description
Full Processing FullProcess processing scenario for obtaining all document data
Authentication FullAuth processing scenario for obtaining all document data and document authentication
Visual OCR Ocr processing scenario for obtaining visual zone OCR results
Document Type DocType processing scenario for document type recognition
MRZ and Locate MrzAndLocate processing scenario for detecting document boundaries and obtaining MRZ data
Barcode and Locate BarcodeAndLocate processing scenario for detecting document boundaries and obtaining barcode data
MRZ Mrz processing scenario for obtaining MRZ data
Barcode Barcode processing scenario for obtaining barcode data
Bank Card CreditCard processing scenario for obtaining bank card data
Locate Locate processing scenario for detecting document boundaries
MRZ or Barcode MrzOrBarcode processing scenario for obtaining MRZ and/or barcode data
MRZ or Locate MrzOrLocate processing scenario for detecting document boundaries and/or obtaining MRZ data
MRZ or Visual OCR MrzOrOcr processing scenario for obtaining MRZ data or visual zone OCR results
MRZ or Visual OCR or Barcode MrzOrBarcodeOrOcr processing scenario for obtaining MRZ or barcode or visual zone OCR results
MRZ or Visual OCR (with Graphics) LocateVisual_And_MrzOrOcr processing scenario for detecting document boundaries and obtaining MRZ data or visual zone OCR results
Text OCR OcrFree processing scenario for obtaining OCR results of any image
Capture only Capture scenario for obtaining original image without any processing

Full Processing

This scenario detects an identity document, identifies the document type, recognizes MRZ, Visual zone and barcodes, and parses data in text fields.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

Authentication

This scenario detects an identity document, identifies the document type, recognizes MRZ, Visual zone and barcodes, performs checking of security features, if any, and parses data in text fields.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

Visual OCR

This scenario detects an identity document, identifies the document type, recognizes MRZ and Visual zone, and parses data in text fields.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

Document Type

This scenario detects an identity document, identifies the document type, recognizes MRZ, if any, and parses data in text fields.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

MRZ and Locate

This scenario detects an identity document, crops it, recognizes MRZ, and parses data in text fields.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

Barcode and Locate

This scenario detects document boundaries and obtains the barcode data.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

MRZ

This scenario detects the MRZ, recognizes it, and parses data in text fields.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

Barcode

This scenario detects a barcode, recognizes it, and parses data in text fields.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

Bank Card

This scenario detects credit cards, recognizes the Visual zone, and parses data in text fields.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

To learn about all the other available scenarios, expand the section below or navigate to the API Reference documentation.

Click here to expand the complete list of scenarios

Locate

This scenario detects the identity document boundaries and crops the document image.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

MRZ or Barcode

This scenario detects MRZ or barcode, recognizes it, and parses data in text fields. Either MRZ or barcode is needed to finish processing.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

MRZ or Locate

This scenario detects the MRZ and recognizes it, or detects a document location and crops it. Either the MRZ recognition or cropping the identity document is needed to finish processing.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

MRZ or Visual OCR

This scenario detects the MRZ and recognizes it, or detects the Visual zone and recognizes it. Either MRZ recognition or Visual zone OCR is needed to finish processing. If the document contains both the MRZ and Visual zone, in most cases, the processing is finished once the MRZ is read.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

MRZ or Visual OCR or Barcode

This scenario detects the MRZ and recognizes it, or detects the Visual zone and recognizes it, or detects the barcode and recognizes it. Either MRZ recognition or Visual zone OCR or barcode recognition is needed to finish processing. If a document contains both the MRZ and Visual zone, in most cases, the processing is finished once the MRZ is read. If the document includes both the MRZ and barcode, the priority is given to whichever is detected first, meaning the initially recognized information will be processed.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

MRZ or Visual OCR (with Graphics)

This scenario detects the MRZ and recognizes it or detects the Visual zone and recognizes it. Either MRZ recognition or Visual zone OCR is needed to finish processing. If a document contains both the MRZ and Visual zone, the SDK typically prioritizes the MRZ, reads it, crops the document along with other graphic data, and completes the processing.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

Text OCR

This scenario detects any lines of text and recognizes them.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

 

Capture only

This scenario returns the original image that is sent to the processing.

  • Visual zone OCR
  • Document type identification
  • MRZ OCR
  • Barcode recognition
  • Document location
  • Graphics cropping
  • Checking security features
  • Hologram detection
  • Multipage processing

Core Types and Scenarios

The list of returned scenarios is based on the Core capabilities and your license. The license has priority.

Find the scenarios supported by each Core type in the table below. Note that the table can be scrolled to the right.

  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only
  • MRZ
  • Barcode
  • Locate
  • Visual OCR
  • Document Type
  • MRZ or Barcode
  • MRZ or Locate
  • MRZ and Locate
  • Barcode and Locate
  • MRZ or Visual OCR
  • MRZ or Visual OCR or Barcode
  • MRZ or Visual OCR (with Graphics)
  • Full Processing
  • Authentication
  • Text OCR
  • Bank Card
  • Capture only

Next Steps