Skip to content

Commit d679ad2

Browse files
author
shekhar.gupta
committed
update README
1 parent 51ce003 commit d679ad2

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,35 @@
11
# Predictive DocV Android SDK v3
22

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

55
## Minimum Requirements
66

7-
| Feature | Minimum Requirements |
8-
|----------------------------------|---------------------------------------------|
9-
| Android SDK | Version 22 (Android 5.1) and later |
7+
- Android SDK Version 22 (OS Version 5.1) and later
8+
- Android SDK is compiled with `compileSdkVersion 32` and Java 11
109

1110
## Configuration and integration
1211

13-
The DocV Android SDK v3 allows integration as simple as writing a single line of code:
12+
The Predictive DocV Android SDK v3 allows integration as simple as writing a single line of code:
1413
```
1514
SocureDocVHelper.getIntent(context, socure-api-key, config)
1615
```
1716

1817
| Argument | Description |
1918
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2019
| `SocureDocVHelper` | A framework helper class. |
21-
| `socure-api-key` | The unique SDK key obtained from Admin Dashboard. For more information on SDK keys, see the [Admin Dashboard User Guide](../../../../../docs/getting-started.md#retrieve-your-api-keys). |
20+
| `socure-api-key` | The unique SDK key obtained from Admin Dashboard. For more information on SDK keys, see the Admin Dashboard User Guide. |
2221
| `context` | Activity context |
23-
| `config` | An optional JSON string or null value that specifies a custom flow. The `flow_1` value specifies the name of the flow (created in Admin Dashboard) that the DocV SDK should use. <br /> <br />`{"flow": {"name": "flow_1"}}` <br /> <br />If the value is `null`, the DocV SDK will fetch Socure's default flow. |
22+
| `config` | An optional JSON string or null value that specifies a custom flow. The `flow_1` value specifies the name of the flow (created in Admin Dashboard) that the Predictive DocV SDK should use. <br /> <br />`{"flow": {"name": "flow_1"}}` <br /> <br />If the value is `null`, the Predictive DocV SDK will fetch Socure's default flow. |
2423

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

2726
- [Add SDK dependencies](#add-sdk-dependencies)
28-
- [Request camera permissions](#request-camera-permissions)
27+
- [Request camera permissions](#camera-permissions)
2928
- [Launch Socure DocV SDK](#launch-socure-docv-sdk)
3029

3130
### Add SDK dependencies
3231

33-
In your root `build.gradle` file, at the end of the `allprojects` > `repositories` section, add the Socure DocV SDK Maven repository.
32+
In your root `build.gradle` file, at the end of the `allprojects` > `repositories` section, add the Socure DocV SDK Maven repository.
3433

3534
```kotlin {4}
3635
allprojects {
@@ -45,35 +44,39 @@ In your module level `build.gradle` file, add the following Socure DocV SDK depe
4544

4645
```kotlin {2}
4746
dependencies {
48-
implementation 'com.github.socure-inc:socure-docv:x.y.z'
47+
implementation 'com.github.socure-inc:socure-docv:x.y.z'
4948
}
5049
```
5150

52-
### Request camera permissions
51+
### Camera permissions
5352

54-
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.
53+
The Predictive 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.
5554

56-
**Note**: We recommend you check for camera permissions before calling the SocureSDK’s launch API.
55+
**Note**: We recommend you check for camera permissions before calling the Socure DocV SDK’s launch API.
5756

5857
#### Required permissions
5958

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

6261
```
6362
<uses-feature android:name="android.hardware.camera" />
64-
63+
6564
<!-- Declare permissions -->
6665
<uses-permission android:name="android.permission.CAMERA" />
6766
<uses-permission android:name="android.permission.INTERNET" />
6867
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
68+
6969
```
7070

7171
### Launch Socure DocV SDK
7272

73-
To launch Socure DocV SDK, call the launch function to initiate the DocV SDK flow:
73+
To launch the Socure DocV SDK, call the launch function using `ActivityResultLauncher`.
7474

7575
```
76+
val startForResult: ActivityResultLauncher<Intent> = registerForActivityResult(...)
77+
...
7678
startForResult.launch(SocureDocVHelper.getIntent(context, socure-api-key, config))
79+
7780
```
7881

7982
Once the Socure DocV SDK is successfully launched, you will be able to set up a listener for Callback Events and customize the most aspect of the interface. For more information, see the [Android SDK documentation](https://developer.socure.com/docs/sdks/docv/android-sdk/android-sdk-v3/) on DevHub.

0 commit comments

Comments
 (0)