Process Configuration

With ConfigurationService you can retrieve the configuration of the onboarding process from the server. The configuration contains information about which steps are required to be performed during the onboarding process and which document types are supported or required for scanning.

Retrieving the configuration

To retrieve the configuration, create an instance of ConfigurationService and call the getConfiguration method with the process type identifier.

Example:

lateinit var service: ConfigurationService // configured instance
val processType = "PROCESS_TYPE_IDENTIFIER"

service.getConfiguration(processType) { result ->
    result.onSuccess { data ->
        // Access configuration data using responseObject
        // e.g.: data.responseObject.otpForIdentification
    }.onFailure { error ->
        // Handle failure
    }
}

Configuration response

/** Configuration response */
data class ConfigurationResponseData(
    /** Is the onboarding process enabled */
    val enabled: Boolean,
    /** Is OTP required for the first part - identification/activation. */
    val otpForIdentification: Boolean,
    /** Is OTP required for the second part - identity verification. */
    val otpForIdentityVerification: Boolean,
    /** Documents required for identity verification. */
    val documents: ConfigurationDocuments
)

/** Documents required for identity verification */
data class ConfigurationDocuments(
    /** Number of total required documents */
    val totalRequiredDocumentsCount: Int,
    /** Groups of documents */
    val groups: List<ConfigurationDocumentGroup>
)

/** Configuration for a document */
class ConfigurationDocumentGroup(
    /** Number of required documents in the group */
    val requiredDocumentsCount: Int,
    /** Documents in the group */
    val items: List<ConfigurationDocument>
)

/** Group of documents in the configuration */
data class ConfigurationDocument(
    /** Type of the document */
    val type: String,
    /** Number of sides the document has */
    val sideCount: Int
)

Last updated on Jan 14, 2026 (09:48) Edit on Github Send Feedback
Search

develop

Digital Onboarding for Android