› Modules and plugins › Extraction module › Identification Extraction plugin

Identification Extraction plugin

Identification (ID) Extraction quickly extracts ID document type information from your batch classes without setting up extraction rules. The ID Extraction plugin is available as part of the QuickScreen solution. Contact your sales representative for more details on how to purchase this plugin.

The following topic is applicable for Transact on Windows OS.

This plugin supports a single page of an ID at a time. To process the front and back side of an ID, the images need to be split into two documents. The returned data from each side must be merged using a custom script.

Licensing

To check if the feature is enabled in your Transact environment, follow these steps:

  1. Go to System Configuration > Licensing Details.
  2. Verify that Identification Extraction Switch is set to ON.

ID Extraction document type library batch class setup

Transact provides a document type library that includes document type information for supported countries and ID types, allowing quick integration with the ID Extraction plugin.

Each document type contains preset index fields that are mapped to the returned data from the ID Extraction plugin.

The ID extraction document type library batch class is not meant to process batch instances. Export the selected document types to a new or separate batch class.

  1. Download the IDExtractionLibraryBC.zip file from the Customer Support Portal Downloads page.
  2. Import the IDExtractionLibraryBC.zip file as a batch class.

    See Import and export batch classes for the steps to import the identification extraction library.

Export the document type

  1. To use a specific country and ID type in your batch class, open the identification extraction library that you imported earlier.
  2. In the Document Types folder, select the country and ID type.

    Example: UNITED_STATES_PASSPORT

  3. Click Export to save the exported .zip file.

    This .zip file contains the information of your selected document type.

    Exporting the document type may take some time.

  4. Click Close to exit the document type batch class.

Import the document type

  1. To use the country and ID type in your batch class, open the batch class that uses the ID Extraction plugin.

    When a document type is used in any batch class before making it a global document type, then extraction pauses. It is recommended not to use a document type from the identification extraction library as a global document type.

  2. Select the Document Types folder.
  3. Drag and drop the exported document type .zip file that you exported earlier.

    This .zip file contains the information of your selected document type.

  4. Click OK when prompted to click Learn Files to regenerate the indexes.

    You can edit the values for the index fields, such as the name, description, category, or field order.

    Index fields can be exported and imported between ID document types of similar country and ID type.

You have successfully set up the ID extraction document type library and imported a specific country and ID document type into your batch class. Continue to Add the ID Extraction plugin for the steps to add the plugin to your batch class.

Add the ID Extraction plugin

To add the ID Extraction plugin to your batch class workflow, follow these steps:

  1. In your selected batch class, go to Modules > Extraction.
  2. In the Associated Plugins column, select IDENTIFICATION_EXTRACTION.
  3. Click the right arrow to add the plugin to the Selected Plugins column.
  4. Click Applyand then click Deploy.
  5. Under Extraction, select IDENTIFICATION_EXTRACTION.
  6. Verify that Identification Extraction Switch is set to ON.
  7. Click Deploy.

You have successfully added the ID Extraction plugin to your batch class workflow. You can send documents through your batch class and review the results in the Review and Validation screen.

The ID Extraction plugin does not provide classification capabilities. Build the classification rules for the type of ID you want to process in order to train Transact to recognize the different document types.

Recommended plugin configuration

If batch instances stop in the Ready for Validation state, some index fields may not be extracted by the ID Extraction plugin. Add the Default Index Value plugin to your batch class workflow to set a default "N/A" value for these index fields. This plugin automatically processes and provides default values to the document level index fields to prevent manual approval.

See Default Index Field Value plugin for configuration steps.