JourneyContainer

Primary container for the IDScan Journey

Signature:

export declare class JourneyContainer

Properties

Property	Type	Description
getAvailableProviders	() => InputProvider[]	Get a list of the currently available providers
getJourneyState	() => IJourneyState	Get the current state of the journey
initialize	() => Promise<this>	Initialise this instance of the JourneyContainer and begin the journey process for the user.
isMobileDevice	() => boolean	Calculates if the current device is a mobile device or not
requiresCamera	() => boolean	Does the current journey configuration require the use of a camera?
terminate	() => void	Terminate this instance of the JourneyContainer. This un-subscribes all event handlers throughout the system then terminates the journey.NOTE: To terminate the journey, the terminateJourneyfunction is automatically called and should not be called beforehand. If you only want to terminate the journey, call this method instead.
terminateJourney	() => Promise<void>	Terminate the current journey and halt the retina service currently associated with it.

JourneyContainer.getAvailableProviders property

Get a list of the currently available providers

Signature:

getAvailableProviders: () => InputProvider[];

JourneyContainer.getJourneyState property

Get the current state of the journey

Signature:

getJourneyState: () => IJourneyState;

JourneyContainer.initialize property

Initialise this instance of the JourneyContainer and begin the journey process for the user.

Signature:

initialize: () => Promise<this>;

JourneyContainer.isMobileDevice property

Calculates if the current device is a mobile device or not

Signature:

isMobileDevice: () => boolean;

JourneyContainer.requiresCamera property

Does the current journey configuration require the use of a camera?

Signature:

requiresCamera: () => boolean;

Remarks

This will only review the requirement of a camera for normal document upload, not the use of liveness as it’s not always possible to assert this.

JourneyContainer.terminate property

Terminate this instance of the JourneyContainer. This un-subscribes all event handlers throughout the system then terminates the journey.

NOTE: To terminate the journey, the terminateJourney function is automatically called and should not be called beforehand. If you only want to terminate the journey, call this method instead.

Signature:

terminate: () => void;

JourneyContainer.terminateJourney property

Terminate the current journey and halt the retina service currently associated with it.

Signature:

terminateJourney: () => Promise<void>;