public final class DocumentVerificationSDK extends MobileSDK
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EXTRA_ERROR_CODE |
static java.lang.String |
EXTRA_ERROR_MESSAGE |
static java.lang.String |
EXTRA_SCAN_REFERENCE |
static int |
REQUEST_CODE |
Modifier and Type | Method and Description |
---|---|
static DocumentVerificationSDK |
create(android.app.Activity rootActivity,
java.lang.String apiToken,
java.lang.String apiSecret,
JumioDataCenter dataCenter)
Creates an DocumentVerificationSDK instance
|
void |
destroy()
Destroys the instance and frees all resources
|
android.content.Intent |
getIntent()
Returns the intent to start the SDK activity
|
static boolean |
isSupportedPlatform(android.content.Context context)
Checks if the device platform is supported by the sdk
|
void |
setCallbackUrl(java.lang.String callbackUrl)
Callback URL (max.
|
void |
setCameraPosition(JumioCameraPosition cameraPosition)
Set the default camera position
|
void |
setCountry(java.lang.String country)
Specify a country to skip selection by the user (format: ISO 3166-1 Alpha 3 code)
|
void |
setCustomDocumentCode(java.lang.String customDocumentCode)
Use the following method to pass your custom document code.
|
void |
setCustomerInternalReference(java.lang.String customerInternalReference)
Identify the scan in the Jumio merchant UI.
|
void |
setDocumentName(java.lang.String documentName)
Use setDocumentName to override the document label on Help screen.
|
void |
setEnableExtraction(boolean enableExtraction)
When data extraction should be used, set the following parameter that enables or disables extraction for each transaction.
|
void |
setReportingCriteria(java.lang.String reportingCriteria)
Identify the scan in your reports.
|
void |
setType(java.lang.String type)
One of the configured DocumentTypeCodes:
BC, BS, CAAP, CB, CCS, CRC, HCC, IC, LAG, LOAP,
MEDC, MOAP, PB, SEL, SENC, SS, STUC, TAC, TR,
UB, SSC, VC, VT, WWCC, CUSTOM
|
void |
setUserReference(java.lang.String userReference)
Specifies how the user is registered on your system.
|
void |
start()
Starts the scan.
|
getMissingPermissions, getRequiredPermissions, getSDKVersion, hasAllRequiredPermissions, hasPermissionsFor, isRooted, setCustomTheme
public static final java.lang.String EXTRA_SCAN_REFERENCE
public static final java.lang.String EXTRA_ERROR_MESSAGE
public static final java.lang.String EXTRA_ERROR_CODE
public static int REQUEST_CODE
public static DocumentVerificationSDK create(android.app.Activity rootActivity, java.lang.String apiToken, java.lang.String apiSecret, JumioDataCenter dataCenter) throws PlatformNotSupportedException, java.lang.NullPointerException
rootActivity
- activity which starts the DocumentVerificationSDKapiToken
- The API token of your Jumio merchant accountapiSecret
- The corresponding API secretdataCenter
- Select the JumioDataCenter (US, EU)PlatformNotSupportedException
- if the current platform is not supported by the sdkjava.lang.NullPointerException
- the provided rootActivity must not be nullpublic static boolean isSupportedPlatform(android.content.Context context)
public void destroy()
public void setUserReference(java.lang.String userReference)
userReference
- user referencepublic void setCountry(java.lang.String country)
country
- public void setType(java.lang.String type)
type
- public void setCustomerInternalReference(java.lang.String customerInternalReference)
customerInternalReference
- scan reference stringpublic void setReportingCriteria(java.lang.String reportingCriteria)
reportingCriteria
- reporting critieriapublic void setCameraPosition(JumioCameraPosition cameraPosition)
cameraPosition
- JumioCameraPositionpublic android.content.Intent getIntent() throws MissingPermissionException
MissingPermissionException
public void start() throws MissingPermissionException
start
in class MobileSDK
MissingPermissionException
- if any of the required permissions is not grantedpublic void setCustomDocumentCode(java.lang.String customDocumentCode)
customDocumentCode
- the custom document codepublic void setCallbackUrl(java.lang.String callbackUrl)
callbackUrl
- custom callback urlpublic void setDocumentName(java.lang.String documentName)
documentName
- the new labelpublic void setEnableExtraction(boolean enableExtraction)
enableExtraction
- true to activate extraction© Jumio Corp. 268 Lambert Avenue, Palo Alto, CA 94306
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.