ID Bolt API Overview

ID Bolt is built around the concept of a session - a complete user journey from starting the ID scanning process to either successful completion or cancellation. The main class IdBoltSession represents this session and manages the entire workflow.

Quick Start Example

const idBoltSession = IdBoltSession.create(ID_BOLT_URL, {
  licenseKey: LICENSE_KEY,
  documentSelection: DocumentSelection.create({
    accepted: [new Passport(Region.Any)],
  }),
  returnDataMode: ReturnDataMode.Full,
  validation: [Validators.notExpired()],
  onCompletion: (result) => {
    console.log("Successfully completed workflow", result);
  },
  onCancellation: (reason) => {
    console.log("Scanning cancelled", reason);
  },
});
await idBoltSession.start();

Session Methods

Creating a Session

IdBoltSession.create(serviceUrl: string, options: IdBoltCreateSessionOptions): IdBoltSession

Creates a new ID Bolt session with your configuration. The session is not started until you call start().

Parameters:

• serviceUrl: Your ID Bolt service URL from the Scandit dashboard
• options: Configuration object defining the session behavior

note

The default value app.id-scanning.com is an alias that points to Scandit's servers. In a production environment it can be changed to your own domain name pointing to Scandit's servers. This will require you to configure a CNAME record in the DNS settings of your domain. Contact your Scandit account manager for more information.

Starting a Session

async session.start(): Promise<string>

Launches the ID Bolt user interface and begins the scanning workflow. Returns a unique session ID for tracking.

Resource Management

IdBoltSession.terminate(): void

When the keepAliveForNextSession (default: false) option is selected, this method can be used to clean up resources after the last session ended. If this option is not selected, there is no need to call this method.

Configuration Options

The following options can be configured when creating an ID Bolt session:

Option	Type	Required	Description	Details	Since
licenseKey	string	Yes	Your Scandit license key		1.0
documentSelection	DocumentSelection	Yes	Defines acceptable documents	Document Selection	1.0
returnDataMode	ReturnDataMode	Yes	Controls what data is returned	Data Handling	1.0
anonymizationMode	AnonymizationMode	No	Controls data anonymization	Data Handling	1.3
anonymizedFields	AnonymizedFields	No	Fine-grained control over which fields to anonymize	Data Handling	2.2
scanner	Scanner	No	Customizes scanner behavior	Workflow Options	1.2
validation	Validators[]	No	Validators to verify ID	Validators	1.0
locale	string	No	Interface language	Supported Locales	1.1
workflow	WorkflowOptions	No	Customizes workflow UI	Workflow Options	1.1
theme	Theme	No	Customizes visual appearance	Theming	1.1
textOverrides	TextOverrides	No	Customizes displayed text	Text Overrides	1.2
keepAliveForNextSession	boolean	No	Keeps resources for multiple sessions	Advanced Options	1.6
disableCloseOnBrowserBack	boolean	No	Prevents closing on browser back	Advanced Options	1.14
externalTransactionId	string	No	Your tracking ID for analytics	Advanced Options	1.17
learnMore	LearnMore	No	Customize the "learn more" section		2.0
onCompletion	Function	Yes	Completion callback	Callbacks	1.0
onCancellation	Function	No	Cancellation callback	Callbacks	1.0

Supported Locales

The following languages are supported:

• en-US (English, United States - default)
• de-DE (German, Germany)
• de-CH (German, Switzerland)
• es-ES (Spanish, Spain)
• fr-FR (French, France)
• it-IT (Italian, Italy)
• nl-NL (Dutch, Netherlands)
• pl-PL (Polish, Poland)
• pt-PT (Portuguese, Portugal)
• da-DK (Danish, Denmark)