Git Product home page Git Product logo

socure-docv-sdk-android's Introduction

Predictive DocV Android SDK v3

The Predictive Document Verification (DocV) Android SDK v3 provides a framework to add image capture and upload services to your mobile application.

Minimum Requirements

  • Android SDK Version 22 (OS Version 5.1) and later
  • Android SDK is compiled with compileSdkVersion 32 and Java 11

Configuration and integration

The DocV Android SDK v3 allows integration as simple as writing a single line of code:

SocureDocVHelper.getIntent(context, socure_sdk_key, config)
Argument Description
SocureDocVHelper A SDK helper class.
socure_sdk_key The unique SDK key obtained from Admin Dashboard. For more information on SDK keys, see the Getting Started.
context Activity context
config An optional JSON string or null value that specifies a custom flow. The your_custom_flow_name value specifies the name of the flow (created in Admin Dashboard) that the DocV SDK should use.

"{'flow':{'name':'your_custom_flow_name'}}"

If the value is null, the DocV SDK will fetch the default flow from Admin Dashboard.

Before you can use the DocV Android SDK v3, you must perform the following steps:

Add SDK dependencies

In your root build.gradle file, at the end of the allprojects > repositories section, add the Socure DocV SDK Maven repository.

allprojects {
        repositories {
            ...
            maven { url 'https://jitpack.io' }
        }
    }

In your module level build.gradle file, add the following Socure DocV SDK dependency:

 dependencies {
      implementation 'com.github.socure-inc:socure-docv:x.y.z'
 }

Camera permissions

The DocV Android SDK requires camera permission to capture identity documents. Upon the first invocation of the SDK, your app will request camera permission from the user.

Note: We recommend you check for camera permissions before calling the Socure DocV SDK’s launch API.

Required permissions

Ensure that your app manifest has been set up properly to request the following required permissions:

<uses-feature android:name="android.hardware.camera" />

<!-- Declare permissions -->
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

Launch Socure DocV SDK

To launch the Socure DocV SDK, call the launch function using ActivityResultLauncher.

val startForResult: ActivityResultLauncher<Intent> = registerForActivityResult(...)
...
startForResult.launch(SocureDocVHelper.getIntent(context, socure_sdk_key, config))

Once the Socure DocV SDK is successfully launched, you will be able to set up a listener for Callback Events and customize most aspect of the interface. For more information, see the Android SDK documentation on DevHub.

socure-docv-sdk-android's People

Contributors

amar-w avatar janartp avatar shekhar-socure avatar gauravlondhe avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.