A string containing the identifier of this item
A string describing the consent item. You need to display this text to the user and the link holder must be clickable and open the privacy url. The link holder will be wrapped by ({}), e.g. "Jumio stores sensitive data. Click ({here}) to get more information.". Alternatively, you can also display the spannedText, which already contains a clickable link to the privacy url.
ConsentType differentiates between JumioConsentType.ACTIVE and JumioConsentType.PASSIVE consent and describes how the consent item should be collected from the user
A string containing the privacy policy url for this item
Returns a spanned string that contains the text and the link holder parsed and underlined. A click on the link starts an ACTION_VIEW Intent with the privacy policy url.
a formatted spanned string
sets the color of the url part inside the spanned string
Cancels the workflow
the controller can not be used anymore
Finishes the workflow in case isComplete is true, otherwise an IllegalArgumentException will be thrown
the SDK can not be finished
Indicates if all JumioCredential have been successfully completed
Persist the state of the Controller - this needs to be called from the onSaveInstanceState function in the hosting activity or fragment in case the workflow is not yet finished or canceled.
Retry the specified JumioError if it is retryable.
Starts and returns a JumioCredential based on the provided JumioCredentialInfo
Stop the controller - this needs to be called from the onDestroy function in the hosting activity or fragment in case the workflow is not yet finished or canceled.
Needs to be called in case one or more JumioConsentItem are specified in JumioControllerInterface.onInitialized
the data bundle
JumioError that was received in JumioControllerInterface.onError.
if the error is invalid or non retryable.
the controller can not be used anymore.
JumioCredential instance
JumioCredentialInfo that was received in JumioControllerInterface.onInitialized
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.
Supported credential categories
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
if this enum type has no constant with the specified name
This method may be used to iterate over the constants.
unique identifier for the credential
Cancels the credential
the credential can not be used anymore
Represents all the JumioCredentialParts that are required for this credential
Finishes the credential in case isComplete is true, otherwise an IllegalArgumentException will be thrown
the workflow is not completed and the credential can't be finished
Returns an addon scan part if available
JumioScanPart or null
Indicates if all JumioCredentialParts of this credential have been successfully completed
Indicates if this credential is configured and credentialParts are available
Initializes and returns a JumioScanPart based on the provided JumioCredentialPart
JumioScanPart instance
JumioCredentialPart
JumioScanPartInterface reference
in case an invalid parameter is passed
in case the credential's state is currently not capable of initiating a new JumioScanPart
in case the credential or it's data is not configured correctly or outdated
Validates a given acquire mode
Sets an acquire mode
if acquire mode is supported
JumioAcquireMode
The acquire option is not supported
Initializes and returns a JumioScanPart for JumioCredentialPart.FACE
Use supportedCountries together with getPhysical/DigitalDocumentsForCountry(country) instead
Represents all supported countries in ISO 3166 ALPHA-3 with a corresponding List of JumioPhysicalDocuments.
Represents all the JumioScanPart that are required for this credential.
Returns the list of available JumioDigitalDocuments for a given countryCode.
Returns the list of available JumioPhysicalDocuments for a given countryCode.
Suggests a country in ISO 3166 ALPHA-3 based on the device IP, if this country is supported.
Represents all supported country codes in ISO 3166 ALPHA-3.
Validates a given country and document combination
Sets a given country and document combination
whether the provided country and document are supported
ISO 3166 ALPHA-3 country code
JumioDocument reference from getPhysicalDocumentsForCountry or getPhysicalDocumentsForCountry
JumioDocument reference from getPhysicalDocumentsForCountry or getDigitalDocumentsForCountry
The country and document combination is not valid
String The title of this digital document, same as type if not set.
String The type of this digital document.
Supported document types
Supported document variants