Skip to content
GBG Documents & Biometrics Documentation
Product
All products
IDscan Enterprise
AssureID Connect
AssureID Sentinel
AcuFill SDK
SmartCapture
Search
Ctrl
K
Cancel
Contact support
(opens in a new tab)
Select theme
Dark
Light
Auto
Overview
Portal user guides
APIs & SDKs
Installation
User guides
Release notes
Menu
Overview
Portal user guides
APIs & SDKs
Installation
User guides
Release notes
SmartCapture
Overview
Concepts
Integrate
Deploy
Release notes
Overview
Install and configure
SDK and REST API
Applications
Release notes
Overview
Install and program
Libraries
Reference
Release notes
IDscan Core
Introduction
Get started
Authentication
Requests and responses
OpenAPI definitions
Document Verification
Overview
ClassifyDocument
/ClassifyDocument/id
POST
/ClassifyDocument
POST
ProofOfAddress
/ProofOfAddress
POST
/ProofOfAddress/id
POST
/ProofOfAddress/lite
POST
/ProofOfAddress/lite/id
POST
/ProofOfAddress/verify
POST
/ProofOfAddress/verify/id
POST
VerifyDocument
/VerifyDocument
POST
/VerifyDocument/Id
POST
Liveness and biometrics
Overview
AgeEstimation
/AgeEstimation
POST
/AgeEstimation/id
POST
Biometrics
/Biometrics
POST
/Biometrics/id
POST
CelebrityCheck
/CelebrityCheck
POST
/CelebrityCheck/id
POST
EnhancedLiveness
/EnhancedLiveness
POST
/EnhancedLiveness/id
POST
ExtractImage
/ExtractImage
POST
/ExtractImage/id
POST
Liveness
/Liveness
POST
/Liveness/id
POST
Face Match
Overview
FaceMatch
/FaceMatch
POST
/FaceMatch/Id
POST
IEOS Web API 9.2 (21.4)
Overview
API Overview
Actions
Token Authentication
Retrieve JourneyDefinitionID
Upload
Retrieval
Download PDF Report
Download PDF Report across multiple date range
Webhooks
Delete Person
Refer the Journey to FDE Team
FDE Chat Transcript
API controller for IDES communication in IDWS
Overview
Actions
Annex 1: Supported document types
Annex 2: Extracted fields
Annex 3: Document type and subtype names
WebSDK (21.8)
Overview
Integration/Quick Start Guide
What This SDK Offers
Web SDK Basic Integration Guide
Overview
SDK Journey Container
Templates
Translation
CSS
Device Capabilities and Camera Selection
Migration Guide for Web SDK
Supported Platforms
Known Issues, Workarounds, Fall-back Mechanisms and Gotchas
Annexure A: Translation keys
JourneyContainer
Advanced Angular Integration with Typescript
LanguageService
Advanced React Integration with JSS
Templates
SDK
Overview
Enumerations
CapturingMedia
ChangeMode
ChannelType
CurrentResult
DocumentRole
DocumentSide
DocumentSource
FlowState
HighLevelResult
HighLevelResultDetails
HighLevelResultDetailValues
IdesMicroWorkerMessages
ImageFormat
InputProvider
JourneyEvent
JourneyState
PreProcessor
RequiredAction
ReticleType
ScannerError
ScannerState
ScanProcess
Templates
TemplateType
TranslationKey
Interfaces
IAuthSettings
IBase64Components
ICamera
ICameraOptions
IContainerConfiguration
IDataStoreFormat
IDeviceCapabilities
IDocument
IDocumentImage
IEndpoints
IExtendedDocument
IExtractedField
IFinalResult
IFunctionTemplateConfiguration
IHttpServiceConfiguration
IIdScanData
IImageCoordinates
IImageResult
IJourneyDefinition
IJourneyEntryDefinition
IJourneyEventMetaData
IJourneyInformation
IJourneyState
IMetaData
INullTemplateConfiguration
IOverlayConfiguration
IPersistenceSettings
IPerson
IPersonAddress
IProcessedDocument
IPromiseTemplateConfiguration
IRange
IResolution
IReticleConfiguration
IScannerState
ISmartCaptureConfiguration
IStorageItem
IStringTemplateConfiguration
IUrlTemplateConfiguration
IWorkerMessage
IWorkerMessageEvent
Type Aliases
Callback
ITemplateConfiguration
TemplateDictionary
TemplateFunction
TranslationDictionary
Translator
MJCS SDK Guide for Android v10.6.3 (21.4)
Introduction
Overview
Requirements
Using the SDK
Adding the MJCS API Dependency
Overview
Android Studio – General Project Setup
Split final app (optional)
Build Architectures
ProGuard
High-Level Implementation
Overview
Customer Journey / Digital Journey / Onboarding Customers
Overview
SSL pinning Customer Journey
Multiple Journey Definitions for Customer Journey
CustomerJourney Additional Data
Component Base Integration
Overview
Smart Capture Usage
Overview
Additional Options for Smart Capture
Usage of Camera Overlay (Alert Dialog)
Possible Stream Actions
Possible onProcessingFailed (ScannerError) codes
Customising Customer Journey Flow
BETA: Hot-Swapping
Switching back to default (Maven) profile.
Utility functionality
Offline OCR (BETA)
Enterprise Service Usage
Simple Upload Operation
Request Builder for Upload functionality
Get Journey Details
Multiple journeys definitions for Enterprise Service
SSL pinning for Enterprise Service
Concept of IEOS driven Onboarding Journeys
Implementation of on-boarding journeys
Using a native or third-party camera
Overview
Uploading Identity document
Uploading proof of address document
Uploading selfie
Liveness Component
Overview
Implementing OnlineLivenessFragment
Implementing OfflineLivenessFragment
NFC Scanning
Overriding Device Language
Migrating from older version to newer ones
Migrating from 9.1.2 to 9.2.3
Migration from 8.4.1 to 9.0.2
Migration from 8.3.0 to 8.3.1
Migration from 8.2.1 to 8.3.0
Migration from 8.2.0 to 8.2.1
Migration from 8.1.1 to 8.2.0
Migrating from 8.1.0 to 8.1.1
Migrating from 1.6.14 to 8.1.0
Common Questions and Answers
Appendix 1: Proof of Address documents
Appendix 2: Extracted field IDs
Appendix 3: SDK size
Appendix 4: Proof of Address and field IDs
MJCS iOS SDK 10.6 (21.4)
Overview
Requirements
Using the SDK
Start Using the SDK
Code Integration
IDSCustomerJourney
Concept of IEOS driven Onboarding Journeys
Overview
Implementation of on-boarding journeys
Profile Hot-Swapping
Offline OCR
SSL Pinning
Localisation
Using native or third-party camera
Migrations
Face Match API (8.5.3 version)
Summary
Actions
Guidance on making the best use of the engine
Contact support
(opens in a new tab)
Select theme
Dark
Light
Auto
Support
(opens in a new tab)
Blog
(opens in a new tab)
IAuthSettings
Signature:
export interface IAuthSettings
Properties
Section titled “Properties”
Property
Type
persistence
IPersistenceSettings
