Constructor Detail

• SessionConfig.Builder

  SessionConfig.Builder()

Method Detail

• setInterviewId

   final SessionConfig.Builder setInterviewId(String interviewId)

  Parameters:

  interviewId - Identifies the session to resume.

  Returns:

  Builder

• setConfigurationId

   final SessionConfig.Builder setConfigurationId(String configurationId)

  Sets the configuration ID of a Flow defined in the Incode Dashboard to read server-side configuration settings from and merge them into this session.

  Note: The "configuration ID" is identical to the "flow ID" that can be copied from the Incode dashboard by selecting the "Copy flow ID" action for the desired Flow.

  Parameters:

  configurationId - Predefined configuration ID for the current onboarding Flow.

  Returns:

  Builder

• setValidationModuleList

   final SessionConfig.Builder setValidationModuleList(List<OnboardingValidationModule> validationModuleList)

  Parameters:

  validationModuleList - Validation modules that contribute to the total Onboarding score.

  Returns:

  Builder

• setRegionIsoCode

  @Deprecated(message = "This method is deprecated as the region is no longer necessary in the onboarding flow.") final SessionConfig.Builder setRegionIsoCode(String regionIsoCode)

  Parameters:

  regionIsoCode - Region for the onboarding.

  Returns:

  Builder

• setQueueName

   final SessionConfig.Builder setQueueName(String queueName)

  Parameters:

  queueName - Name of the video conference queue.

  Returns:

  Builder

• setExternalId

   final SessionConfig.Builder setExternalId(String externalId)

  Assigns an ID from a client's system to this session. If a session exists with this externalId, it will be resumed instead of creating a new one should the first session be interrupted.

  Note: externalId is ignored if externalCustomerId is specified.

  Parameters:

  externalId - ID that is used outside of Incode Omni platform.

  Returns:

  Builder

• setExternalCustomerId

   final SessionConfig.Builder setExternalCustomerId(String externalCustomerId)

  Assigns an ID from a client's system to this session. Unlike externalId, this is used purely for referential purposes. If a session exists with this externalCustomerId, a new session will be created should the first session be interrupted.

  Note: externalCustomerId takes precedence over externalId if both are specified.

  Parameters:

  externalCustomerId - ID that is used outside of Incode Omni platform.

  Returns:

  Builder

• setExternalToken

   final SessionConfig.Builder setExternalToken(String externalToken)

  Sets the token of the onboarding session. Specify this in order to resume an existing onboarding session without calling the omni/start API. For example, this token could come from a previous invocation of the omni/start API.

  Parameters:

  externalToken - External JSON Web Token (JWT) created in an external backend used to resume the onboarding.

  Returns:

  Builder

• setCustomFields

   final SessionConfig.Builder setCustomFields(Map<String, String> customFields)

  Parameters:

  customFields - Map of custom fields.

  Returns:

  Builder

• setDownloadImagesEnabled

   final SessionConfig.Builder setDownloadImagesEnabled(Boolean downloadImagesEnabled)

  Parameters:

  downloadImagesEnabled - Ensures that ID and Selfie images are downloaded and stored on the device.

  Returns:

  Builder

• setE2eEncryptionEnabled

   final SessionConfig.Builder setE2eEncryptionEnabled(Boolean e2eEncryptionEnabled)

  Enable or disable end-to-end encryption (E2EE). After E2EE is enabled, all calls will be encrypted and decrypted on device.

  Parameters:

  e2eEncryptionEnabled - A boolean value indicating whether end-to-end encryption is enabled.

  Returns:

  Builder

  Since:

  5.21.0

• setE2eEncryptionAlgorithm

   final SessionConfig.Builder setE2eEncryptionAlgorithm(SessionConfig.E2eEncryptionAlgorithm e2eEncryptionAlgorithm)

  Sets the end-to-end encryption (E2EE) algorithm used in this session if E2EE is used.

  Note: This setting has no effect if isE2eEncryptionEnabled() is false.

  Parameters:

  e2eEncryptionAlgorithm - The encryption algorithm to use; can be SHA1 (default) or SHA256.

  Returns:

  Builder

  Since:

  5.37.0

• setMergeSessionRecordings

   final SessionConfig.Builder setMergeSessionRecordings(Boolean mergeSessionRecordings)

  Enables or disables server-side merging of video recordings from the IdScan and SelfieScan modules.

  Parameters:

  mergeSessionRecordings - A boolean value indicating whether videos should be merged server-side or not.

• setLanguage

   final SessionConfig.Builder setLanguage(String languageCode)

  Sets the language for voice consent in VideoSelfie module.

  Parameters:

  languageCode - Supported values: en-US, es-ES, pt-BR

• build

   final SessionConfig build()

  Builds a SessionConfig object with the configured parameters.

  Returns:

  SessionConfig object with the specified configuration settings.

• from

   final static SessionConfig.Builder from(SessionConfig existingConfig)