Core/com.jumio.sdk.credentials/JumioIDCredential

JumioIDCredential

class JumioIDCredential : JumioCredential

Takes care of the ID verification process.

Properties

val ~~countries~~: Map<String, List<JumioPhysicalDocument>>

Represents all supported countries in ISO 3166 ALPHA-3 with a corresponding List of JumioPhysicalDocuments.

credentialParts

open override val credentialParts: List<JumioCredentialPart>

Represents all the JumioScanPart that are required for this credential.

open override val isConfigured: Boolean

Indicates if this credential is configured and credentialParts are available.

suggestedCountry

val suggestedCountry: String?

Suggests a country in ISO 3166 ALPHA-3 based on the device IP, if this country is supported.

supportedCountries

val supportedCountries: List<String>

Represents all supported country codes in ISO 3166 ALPHA-3.

Functions

open override fun cancel()

Cancels the credential

open override fun finish()

Finishes the credential in case isComplete is true, otherwise an IllegalArgumentException will be thrown

getDigitalDocumentsForCountry

fun getDigitalDocumentsForCountry(countryCode: String): List<JumioDigitalDocument>

Returns the list of available JumioDigitalDocuments for a given countryCode.

getPhysicalDocumentsForCountry

fun getPhysicalDocumentsForCountry(countryCode: String): List<JumioPhysicalDocument>

Returns the list of available JumioPhysicalDocuments for a given countryCode.

open override fun initScanPart(credentialPart: JumioCredentialPart, scanPartInterface: JumioScanPartInterface): JumioScanPart

Initializes and returns a JumioScanPart based on the provided JumioCredentialPart

isSupportedConfiguration

fun isSupportedConfiguration(country: String, document: JumioDocument): Boolean

Validates a given country and document combination

setConfiguration

fun setConfiguration(country: String, document: JumioDocument)

Sets a given country and document combination

© Jumio Corporation, 100 Mathilda Place Suite 100 Sunnyvale, CA 94086

The source code and software available on this website (“Software”) is provided by Jumio Corp. or its affiliated group companies (“Jumio”) ”as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall Jumio be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including but not limited to procurement of substitute goods or services, loss of use, data, profits, or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this Software, even if advised of the possibility of such damage. In any case, your use of this Software is subject to the terms and conditions that apply to your contractual relationship with Jumio. As regards Jumio’s privacy practices, please see our privacy notice available here: Privacy Policy.

Generated by dokka