Dashboard platform administration, Add Modules

ID Capture

The ID Capture module captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing. It also allows users to submit a digital ID they already have saved in their device's wallet (such as Apple or Google Wallet).

For an overview of this module and how it works, see ID Capture.

Supported with:

✅ Workflows | ✅ Flows

Add ID Capture to Workflows

  1. In the left menu in Dashboard, click Flow Builder > Workflows.
  2. Click New or select an existing Workflow.
  3. Add the ID Capture module. Do one of the following, depending on whether you have the New or Classic view enabled in the toggle in the top right:
    • New: Click Add node Icon of a plus sign > Modules, then search for and select ID Capture.
    • Classic: From the Modules list, drag and drop the ID Capture module into the builder.
  4. You can click Options Icon of three dots stacked on top of each other > Edit on the module node to open the Configuration Options panel and adjust settings as needed.

Add ID Capture to Flows

  1. In the left menu in Dashboard, click Flow Builder > Flows.
  2. Click New or select an existing Flow.
  3. On the Select Modules tab, find the ID Capture module and click Add.
  4. You can click Details & Configurations to open the Configuration Options panel and adjust settings as needed.

Configuration Options

This section details all the configuration options available for this module. The options that appear depend on whether you have the New or Classic view enabled in the toggle in the top right in your Flow or Workflow. After changing anything, click Save configuration before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

Configuration Options: New

In New view, the ID Capture module's configuration panel has four tabs that categorize its settings:

  • Documents & countries: Choose which identity documents the module accepts, such as passports and driver's licenses. Set the defaults for all countries, then override them for specific countries and document types.
  • Capture options: Customize the standard capture experience with elements such as tutorials, automatic capture, and ID-detection timeouts. Enable alternative capture methods, including supported digital ID options.
  • Fraud prevention: Configure safeguards against fraud. If Deepsight is enabled for your organization, and in your Flow or Workflow settings, Deepsight settings appear on this tab as well.
  • Exceptions: Handle less common capture requirements and special cases.

Some capture settings must be configured by your Incode representative.

Documents & Countries

Setting Description
Accept digital IDs Opens a modal that allows you to select acceptable digital IDs for this Flow or Workflow; see Manage digital IDs below for instructions. This allows users to verify their identity using a digital ID stored in their device wallet (such as Apple Wallet or Google Wallet) as an alternative to camera capture. See Digital ID Verification and Supported Digital IDs for more information about this capability.
Allow digital ID upload Allow users to upload a supported PDF or image of a digital ID, such as a document downloaded from or a screenshot taken in an official government app.
National IDs Choose the government-issued documents to allow as primary proof of identity: Drivers License, Identification Card, Voter Identification, Federal ID, and Passport.*
Residency & immigration Accept documents that confirm a person’s residency or immigration status: Residence Document, Travel Document, and Visa.*
Permits & licenses Accept government-issued documents granting permission or authorization: Permit, Weapon License, Tax Identification, and Vehicle Registration.*
Other documents Accept additional supported document types: Birth Certificate, Medical Card, Currency, Military, Tribal Identification, Other, and Unknown.*
Other documents are recognized, supported types that Incode deliberately does not classify because they do not fit the processing rules of other classifications. Unknown documents are those the system cannot classify against a supported document template.

* Click Settings Icon of a gear next to each document you enable to specify if the ID should be accepted from All countries or Specific countries. If you select Specific countries, add countries and click Add selected. Then, in the drop-down for each country, enable the document checks you want to run:

Check Description
Disable ID alignment correction Disable automatic correction of the document’s alignment before processing. Use this when the captured image should be processed in its original orientation.
US barcode classification Check that the barcode on the back of a US identity document has the expected format and can be read correctly. The capture fails if the barcode is invalid or unreadable.
Allow manual review Send the session for manual review if the document cannot be captured successfully within the allowed number of attempts.
Front side only Capture and process only the front of the document without asking the user to capture the back.
Back side only Capture only the back or barcode side of the document, typically for barcode-based data extraction.
Capture additional page Allow the user to capture an optional additional page when relevant information appears elsewhere in the document.

Capture Options

Info

By default, these settings are configured to Incode's recommendations for successful ID capture. Changing them may weaken session completion, image quality, and fraud protection.

To change these settings, click Customize, acknowledge the warning, then click Continue customizing in the dialog. At any time, you can click Reset to Recommended at the top to return to Incode's defaults.

Setting Description
Document type selector Show a screen where users select the type of document they want to capture, such as an identity card or passport.
Capture tutorial Show instructions before capture to help users position their document and take a suitable image.
Document sides Choose which sides of the document the user must capture: Both sides, Front only, or Back only.
Require date of birth Require the date of birth to be extracted from the document. If it is not found on the front, the user is prompted to capture the back—even when front-only capture is configured.
Capture attempts Set the number of attempts the user has to capture the document successfully before the capture ends or follows the configured failure path. The suggested value is 3. This number balances capture success with user friction. With fewer attempts, a valid document may fail because of glare or poor alignment. With more attempts, users are more likely to grow frustrated and drop off.
Allow a second ID Ask the user to capture a second identity document during the same verification. To ask for a second ID if the first one fails verification, use Workflow conditions, not this setting.
Autocapture timeout Set how long the system waits after detecting the document for it to meet the automatic-capture requirements before offering manual capture.
ID detection timeout Set how long the system waits to detect a document in the camera view before offering manual capture.

Fraud Prevention

Setting Description
Record ID capture Record video during the ID capture process for later review and fraud analysis. This is a separately licensed feature that must be enabled for your organization.
Allow manual review Send the session for review by an authorized agent when the document cannot be captured successfully within the allowed number of attempts. If disabled, the session follows the configured failure path instead.

Exceptions

Setting Description
Allow a third ID Ask the user to capture a third identity document during the same verification. It is an additional required capture, not a fallback triggered by an earlier ID failing. That can be set using Workflow conditions.
Force back side capture on front failure Continue to the back-side capture when the front cannot be captured or classified successfully, allowing the back to provide additional document or barcode information.
Optional ID page capture Give the user the option to capture an additional document page when relevant information appears on another page, such as the address page of a passport.
US barcode capture (DMV face match) Enable a guided capture experience optimized for scanning the barcode on US identity documents. This option is available when DMV Face Match is enabled.
Add watermark to cropped ID Apply a visible watermark to the processed, cropped document image to reduce the risk of unauthorized reuse or reproduction and support local compliance requirements.
Compliance redaction Redact selected personal data fields from captured document images for supported countries and document types to meet privacy or regulatory requirements. Select a Country, then a State if applicable, then a Document type, then a Document subtype and Issuing year. Finally, select the fields to be redacted. Click Add country to repeat.

Configuration Options: Classic

In Classic view, the ID Capture module's configuration panel has two tabs that categorize its settings: General and Redaction. If Deepsight is enabled for your organization, and in your Flow or Workflow settings, Deepsight settings appear on the General tab as well.

General

View image of Workflow configuration panel

Image of ID Capture module configuration panel in Workflows. Has many configurable settings.

View image of Flow configuration panel

Image of ID Capture module configuration panel in Flows. Has many configurable settings.

Setting Description
Set country specific Restricts accepted document types to those issued by a specific country. Enable this when your use case requires country-level document validation.
Manage digital IDs Opens a modal that allows you to select acceptable digital IDs for this Flow or Workflow; see Manage digital IDs below for instructions. This allows users to verify their identity using a digital ID stored in their device wallet (such as Apple Wallet or Google Wallet) as an alternative to camera capture. See Digital ID Verification and Supported Digital IDs for more information about this capability.
Accepted Documents The document types that users can present for ID capture. Select one or more from the available options (Drivers License, Passport, Federal ID). Only the selected document types will be accepted during the capture flow.
Select ID
Workflows only
Specifies which ID in a multi-ID session this module applies to (First ID or Second ID). Use this when your Workflow captures more than one identity document.
Show document chooser screen When enabled, displays a screen prompting the user to select their document type before capture begins. Recommended when multiple document types are accepted.
ID capture tutorial When enabled, displays an instructional screen before the capture step to guide the user through the process.
Second ID
Flows only
When enabled, designates this ID Capture module as the second ID in a multi-ID session. Use this when your Flow captures more than one identity document.
Third ID
Flows only
When enabled, designates this ID Capture module as the third ID in a multi-ID session. Use this when your Flow captures more than two identity documents.
Enable ID recording When enabled, records the ID capture session for review purposes.
Only Front Capture Id When enabled, captures only the front of the ID, skipping the back. Use this for document types that do not require a back-side scan.
Back Id Only (barcode) When enabled, captures only the back of the ID and reads the barcode. Use this when only barcode data from the back of the ID is required.
Barcode Capture When enabled, activates barcode scanning during ID capture.
US Smart Capture When enabled, uses enhanced capture logic optimized for US-issued identity documents.
Unordered ID Capture When enabled, allows the front and back of the ID to be captured in any order, rather than requiring front first.
Always capture back of ID When enabled, always requires capture of the back of the ID, regardless of document type.
Do not redact unknown images. When enabled, images that are not recognized are not redacted.
Require date of birth When enabled, users will be prompted to scan the back of their ID if date of birth is not detected on the front side. This applies even when the flow is configured as front-only capture, and ensures date of birth is always extracted regardless of document template.
Add watermark to cropped ID When enabled, watermark text is added to cropped ID images to indicate they have been processed.
Capture optional ID page When enabled, prompts the user to capture an additional optional page of the ID, such as a visa page.
Disable Alignment Classification When enabled, turns off alignment classification during capture, which checks that the ID is properly aligned before accepting the image. Disabling this may speed up capture but can reduce image quality.
US Barcode Classification When enabled, uses barcode classification logic specific to US-issued documents.
Allow manual review
Flows only
Sends the session to a human reviewer if the ID isn’t captured successfully within the configured attempts. The reviewer can inspect the session and decide whether to approve or reject it.
Enable Digital ID upload When enabled, allows users to submit a digital ID file as an alternative to live camera capture. See Supported Digital IDs for supported schemes by region.
Autocapture timeout (Seconds) The number of seconds the camera will attempt automatic capture before timing out. Default: 25. If autocapture does not succeed within this window, the user is prompted to retry or switch to manual capture.
ID Detection Timeout (Seconds) The number of seconds the system will attempt to detect an ID in the camera frame before timing out. Default: 60.
Onboarding flow attempts
Flows only
The number of onboarding attempts after which the user drops off. Default: 0.
Number of image capture attempts The maximum number of times a user can attempt to capture their ID before the session ends. Default: 3.

Redaction

The Redaction tab lets you define which fields should be redacted on captured identity documents, configured per country. Each country entry specifies the document type, the document subtype (the specific version or format of that document), the issuing year (which identifies the document version and determines which fields are available for redaction), and the fields to redact. You can add multiple country configurations to a single session using the Add country button.

View image of configuration panel

The Redaction tab in the ID Capture module's configuration panel. Has one configurable option: Country.

The following countries are available for redaction configuration. All country entries use State: ALL.

Norway
Document type Subtype Issuing year Fields to be redacted
Identification Card IDENTIFICATION_CARD 2015 creditCardNumber, ccv
Indonesia
Document type Subtype Issuing year Fields to be redacted
Identification Card IDENTIFICATION_CARD 2000 documentNumber
Passport NATIONAL_PASSPORT 2013, 2015, 2022 documentNumber
Germany
Document type Subtype Issuing year Fields to be redacted
Identification Card IDENTIFICATION_CARD 2007 documentNumber
Identification Card IDENTIFICATION_CARD 2010, 2021 documentNumber, refNumber
Identification Card TEMP_GERMAN_IDCARD 2004 documentNumber
Passport NATIONAL_PASSPORT 2007, 2017 documentNumber
Residence Document RESIDENCE_PERMIT 2011, 2019 documentNumber, refNumber
Residence Document FICTIONAL_CERTIFICATE 2020, 2024 documentNumber
Hong Kong
Document type Subtype Issuing year Fields to be redacted
Passport NATIONAL_PASSPORT 2005 documentNumber, personalNumber
Residence Document PERMANENT_RESIDENT_IDENTITY 2003, 2018 documentNumber
Netherlands
Document type Subtype Issuing year Fields to be redacted
Identification Card DIPLOMATIC_IDENTIFICATION_CARD 2016 personalNumber
Identification Card IDENTIFICATION_CARD 2014 personalNumber
Passport NATIONAL_PASSPORT 2006, 2014 personalNumber
Residence Document RESIDENCE_PERMIT 2014, 2020, 2022 personalNumber
Drivers License DRIVER_LICENSE 1990, 2006, 2013, 2018, 2025 personalNumber
Japan
Document type Subtype Issuing year Fields to be redacted
Identification Card IDENTIFICATION_CARD 2020 personalNumber
Thailand
Document type Subtype Issuing year Fields to be redacted
Identification Card IDENTIFICATION_CARD 2001 religion
Singapore
Document type Subtype Issuing year Fields to be redacted
Identification Card IDENTIFICATION_CARD 2001 documentNumber
Passport NATIONAL_PASSPORT 2005, 2017 documentNumber, personalNumber
Residence Document RESIDENCE_PERMIT 2005 documentNumber
Drivers License DRIVER_LICENSE 2002 documentNumber
Military MILITARY_IDENTIFICATION_CARD 2010 documentNumber
India
Document type Subtype Issuing year Fields to be redacted
Identification Card IDENTIFICATION_CARD 2005, 2010, 2015 documentNumber
Identification Card MASKED_IDENTIFICATION_CARD 2005, 2015 documentNumber
Korea, Republic of
Document type Subtype Issuing year Fields to be redacted
Identification Card IDENTIFICATION_CARD 2000 personalNumber
Passport NATIONAL_PASSPORT 2008, 2022 documentNumber, personalNumber
Residence Document RESIDENCE_PERMIT 2018, 2023 documentNumber
Drivers License DRIVER_LICENSE 2000, 2020 documentNumber, personalNumber

Manage Digital IDs

This modal allows you to select acceptable digital IDs for this flow. This allows users to verify their identity using a digital ID stored in their device wallet (such as Apple Wallet or Google Wallet) as an alternative to camera capture. See Digital ID Verification and Supported Digital IDs for more information about this capability.

Click Manage digital IDs to open the following modal:

Expand to view image

The Digital ID Acceptance modal, allowing you to select different device wallets acceptable for the flow.

  1. Find the wallet type you want to enable for the flow. You can search by name or filter by region.
  2. Click the toggle to enable the wallet. Some wallets require you to contact support to enable them.
  3. You can click View Details on an available wallet to select which data points to collect. Users will only be asked to share what you choose.
  4. Click Done.

Deepsight Settings

If Deepsight is enabled for your organization, and in your Flow or Workflow settings, the following settings appear in the ID Capture configuration panel.

Deepsight Setting Description
Ignore missing metadata Prevents missing capture metadata from automatically making the Deepsight result unavailable. Recommended for API integrations.
In-browser debugger detection Detects when browser inspection tools are open during capture.
Mocked browser detection Detects when the browser identity appears altered or simulated.
Motion Checks for natural device movement during selfie capture.
Monotonic borders Detects uniform-color borders in the selfie that can occur in some injection attempts.
Detection values deviation Checks for image patterns that may indicate a static or replayed image.
Camera label check Detects suspicious camera labels that may indicate a virtual camera.
Camera challenges Checks camera responses to security challenges to help identify virtual or injected camera feeds.

Was this page helpful?