SDK

Classes

Class	Description
JourneyContainer	Primary container for the IDScan Journey
LanguageService

Enumerations

Enumeration	Description
CapturingMedia
ChangeMode	The mode to use when changing input providers
ChannelType
CurrentResult	The current result state of the journey.
DocumentRole	Type for DocumentRole
DocumentSide	Type for DocumentSide
DocumentSource	Enum for user Document Source which is used in the upload
FlowState	The current capture state of the journey. The value of this is dictated by the server. These values are usually used alongside the `RequiredAction` enum values returned with events.
HighLevelResult	The current result of the journey. This will change as the journey progresses and will only be finalised at the end of the journey process.
HighLevelResultDetails
HighLevelResultDetailValues
IdesMicroWorkerMessages
ImageFormat	Type for ImageFormat
InputProvider	The available input providers for the system. Which input provider should be used is dictated by the services and should not be overridden unless absolutely necessary.
JourneyEvent	An event which can occur during the lifetime of the Journey.
JourneyState	The current state of the Journey
PreProcessor	The pro-processor to run the template string through before writing it to the DOM. Please check the integration documents or the `Templates`documentation for information on which properties will be passed in for processors to use, and guidelines for defining templates. All pre-processors will be provided with the same data unless otherwise stated.
RequiredAction	The currently required action
ReticleType
ScannerError	The error state of the scanner.
ScannerState	The current state of the scanner.
ScanProcess	The current stage of the scanning process.
Templates	Possible templates which can be specified. For suggested template modifications, default values and template flow, please consult the integration documentation.
TemplateType	The way the template should be processed to gain the template string for use in this particular UI situation. For more detailed information, please consult the integration guide.
TranslationKey	These are the available translatable objects which will be referenced by the SDK internally when templating the UI.NOTE: Some of these are non-standard as they’re used to control translations for values coming back from the API. Please be mindful of this when altering this object.

Interfaces

Interface	Description
IAuthSettings
IBase64Components
ICamera
ICameraOptions	Options for the camera
IContainerConfiguration	ContainerConfiguration object interface for JourneyContainer.
IDataStoreFormat	The data stored in the DataStore. This can be extended by other entities, so be sure to check the documentation for those too.
IDeviceCapabilities
IDocument	A document description returned from the services
IDocumentImage	Configuration object interface for DocumentImage
IEndpoints	Endpoints used to retrieve data from the services.NOTE: You should not need to alter any of these settings under normal circumstances. Please refer to the integration guide before making changes.
IExtendedDocument	An extended document description returned from the services
IExtractedField	Configuration object interface for ExtractedField
IFinalResult	Configuration object interface for FinalResult
IFunctionTemplateConfiguration	Configuration type which uses a synchronous function to retrieve the template string.
IHttpServiceConfiguration	Interface for configuring the HttpService
IIdScanData	The data stored in the DataStore.
IImageCoordinates
IImageResult
IJourneyDefinition	Interface for JourneyDefinitions
IJourneyEntryDefinition	Interface for IJourneyEntryDefinition
IJourneyEventMetaData	This meta data will be emitted alongside a `JourneyEvent`. For more detailed information about what to expect with each event, please consult the integration documentation.
IJourneyInformation	Data structure for Journey
IJourneyState	The current state of the journey.
IMetaData	Configuration object interface for MetaData
INullTemplateConfiguration	An empty template provider.NOTE: This will throw an intentional exception when passed into configuration.
IOverlayConfiguration	Options for the camera overlay
IPersistenceSettings	Persistence settings for the instance of the SDK
IPerson	The data about the person which has been extrapolated from the provided identity documents.
IPersonAddress	Address for the Person
IProcessedDocument	Configuration object interface for ProcessedDocument
IPromiseTemplateConfiguration	Configuration type which uses a promise function to retrieve the template string.
IRange
IResolution
IReticleConfiguration	Configuration options for a reticle
IScannerState
ISmartCaptureConfiguration	Configuration for the Smart Capture component.
IStorageItem
IStringTemplateConfiguration	Configuration type which returns a static string as the template string.
IUrlTemplateConfiguration	Configuration type which provides a URL to retrieve the template string from.NOTE: Nothing is prepended to the URL string before the request is made, so it is possible to use either fully qualified addresses or relative addresses for the provider configuration.
IWorkerMessage
IWorkerMessageEvent

Type Aliases

Type Alias	Description
Callback	General interface for the callback functions
ITemplateConfiguration	Combined type for template configuration blocks. Please refer to the union types within for further documentation.
TemplateDictionary	The set of templates which can be overridden. Any templates which are not overridden will fall back to the defaults. Take care to follow the integration guide when overriding templates.
TemplateFunction
TranslationDictionary	A collection of `TranslationKey`s and their translations
Translator	Function which accepts a key, language and props to produce a translated string