public final class NetverifySDK 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_DATA |
static java.lang.String |
EXTRA_SCAN_REFERENCE |
static int |
REQUEST_CODE |
static int |
REQUEST_CODE_NFC_DETECTED |
Modifier and Type | Method and Description |
---|---|
void |
checkDeallocation(NetverifyDeallocationCallback deallocationCallback)
Assign a callback to be notified as soon as the SDK is fully deallocated
|
static NetverifySDK |
create(android.app.Activity rootActivity,
java.lang.String offlineToken,
java.lang.String preferredCountry)
Creates an NetverifySDK instance
|
static NetverifySDK |
create(android.app.Activity rootActivity,
java.lang.String apiToken,
java.lang.String apiSecret,
JumioDataCenter dataCenter)
Creates an NetverifySDK instance
|
void |
destroy()
Destroys the instance and frees all resources
|
static java.lang.String |
getDebugID()
Obtains the Jumio Analytics session ID if one already exists.
|
android.content.Intent |
getIntent()
Returns the intent to start the SDK rootActivity
|
void |
initiate(NetverifyInitiateCallback loadingCallback)
Initiates the SDK asynchronously
All the SDK settings will be loaded before the SDK is displayed.
|
static boolean |
isSupportedPlatform(android.content.Context context)
Checks if the device platform is supported by the sdk
|
void |
sendDebugInfoToJumio(boolean send)
Enable sending debug information to Jumio servers even if that feature is disabled on server-side
|
void |
setCallbackUrl(java.lang.String callbackUrl)
Callback URL (max.
|
void |
setCameraPosition(JumioCameraPosition cameraPosition)
Set the default camera position
|
void |
setCustomerInternalReference(java.lang.String customerInternalReference)
Identify the scan in the Jumio merchant UI.
|
void |
setDataExtractionOnMobileOnly(boolean dataExtractionOnMobileOnly)
Use the following method to only support IDs where data can be extracted on mobile only
|
void |
setEnableEMRTD(boolean enable)
Setting this to true will enable reading the NFC chip embedded in IDs and use
it to increase verification speed and security.
|
void |
setEnableIdentityVerification(boolean enableIdentityVerification)
Enable a face match check between a camera still image and the document front side (default: true)
|
void |
setEnableVerification(boolean enableVerification)
Enable verification of a scanned identity (default: true)
|
void |
setPreselectedCountry(java.lang.String country)
Specify a country to skip selection by the user (format: ISO 3166-1 Alpha 3 code)
|
void |
setPreselectedDocumentTypes(java.util.ArrayList<NVDocumentType> documentTypes)
Preselect selection to one or more documentTypes to restrict or skip selection by the user
|
void |
setPreselectedDocumentVariant(NVDocumentVariant documentVariant)
Specify a document variant to skip selection by user
|
void |
setReportingCriteria(java.lang.String reportingCriteria)
Identify the scan in your reports.
|
void |
setUserReference(java.lang.String userReference)
Specifies how the user is registered on your system.
|
void |
setWatchlistScreening(NVWatchlistScreening watchlistScreening)
Override the server default for the watchlist search
|
void |
setWatchlistSearchProfile(java.lang.String watchlistSearchProfile)
Define the watchlist search profile for the upcoming session
|
void |
start()
Starts the scan.
|
NetverifyCustomSDKController |
start(NetverifyCustomSDKInterface customSDKInterface)
Starts an custom scan.
|
getMissingPermissions, getRequiredPermissions, getSDKVersion, hasAllRequiredPermissions, hasPermissionsFor, isRooted, setCustomTheme
public static final java.lang.String EXTRA_SCAN_REFERENCE
public static final java.lang.String EXTRA_SCAN_DATA
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 final int REQUEST_CODE_NFC_DETECTED
public static NetverifySDK create(android.app.Activity rootActivity, java.lang.String apiToken, java.lang.String apiSecret, JumioDataCenter dataCenter) throws PlatformNotSupportedException, java.lang.NullPointerException
rootActivity
- rootActivity which starts the NetverifySDKapiToken
- 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 NetverifySDK create(android.app.Activity rootActivity, java.lang.String offlineToken, java.lang.String preferredCountry) throws PlatformNotSupportedException, SDKExpiredException, java.lang.NullPointerException
rootActivity
- rootActivity which starts the NetverifySDKofflineToken
- The API token of your Jumio merchant accountpreferredCountry
- The preferred country (format: ISO 3166-1 Alpha 3 code)PlatformNotSupportedException
- if the current platform is not supported by the sdkjava.lang.NullPointerException
- the provided rootActivity must not be nullSDKExpiredException
- if the provided offline token has already expiredpublic static boolean isSupportedPlatform(android.content.Context context)
public static java.lang.String getDebugID()
public void destroy()
public void checkDeallocation(NetverifyDeallocationCallback deallocationCallback)
deallocationCallback
- a NetverifyDeallocationCallback
instancepublic void setUserReference(java.lang.String userReference)
userReference
- user referencepublic void setPreselectedCountry(java.lang.String country)
country
- preselected countrypublic void setPreselectedDocumentTypes(java.util.ArrayList<NVDocumentType> documentTypes)
documentTypes
- list of supported NVDocumentTypepublic void setPreselectedDocumentVariant(NVDocumentVariant documentVariant)
documentVariant
- NVDocumentvariantpublic void setCustomerInternalReference(java.lang.String customerInternalReference)
customerInternalReference
- scan reference stringpublic void setEnableIdentityVerification(boolean enableIdentityVerification)
enableIdentityVerification
- enable/disablepublic void setEnableVerification(boolean enableVerification)
enableVerification
- enable/disablepublic void setReportingCriteria(java.lang.String reportingCriteria)
reportingCriteria
- reporting critieriapublic void setCameraPosition(JumioCameraPosition cameraPosition)
cameraPosition
- JumioCameraPositionpublic void setDataExtractionOnMobileOnly(boolean dataExtractionOnMobileOnly)
dataExtractionOnMobileOnly
- enable/disablepublic void setCallbackUrl(java.lang.String callbackUrl)
callbackUrl
- custom callback urlpublic void setEnableEMRTD(boolean enable)
setEnableVerification(boolean)
is set to trueenable
- if set to false, reading eMRTDs is not offered. If set to true and all of the above
mentioned criteria are met, scanning eMRTDs is enabled.public void sendDebugInfoToJumio(boolean send)
send
- if set to true, the server setting is overridden. setting it to false will use the server setting.public void setWatchlistScreening(NVWatchlistScreening watchlistScreening)
watchlistScreening
- ENABLED, DISABLED or DEFAULTpublic void setWatchlistSearchProfile(java.lang.String watchlistSearchProfile)
watchlistSearchProfile
- profile namepublic void initiate(NetverifyInitiateCallback loadingCallback) throws java.lang.IllegalArgumentException
NetverifyInitiateCallback
is calledjava.lang.IllegalArgumentException
- if the callback is nullpublic void start() throws MissingPermissionException
start
in class MobileSDK
MissingPermissionException
- if any of the required permissions is not grantedpublic android.content.Intent getIntent() throws MissingPermissionException
MissingPermissionException
public NetverifyCustomSDKController start(NetverifyCustomSDKInterface customSDKInterface) throws MissingPermissionException
customSDKInterface
- - implementation of the CustomScanInterfaceNetverifyCustomSDKController
MissingPermissionException
© 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.