Skip to content

Commit

Permalink
DEP-398: Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
asklausen committed Aug 4, 2023
1 parent fa0269d commit 8d532e8
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 34 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Yoti IDV, React Native

[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/getyoti/yoti-doc-scan-react-native?label=latest%20release)](https://github.com/getyoti/yoti-doc-scan-react-native/releases)
[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/getyoti/yoti-doc-scan-react-native?label=latest%20release)](https://github.com/getyoti/yoti-doc-scan-react-native/releases)
[![Publish Release](https://github.com/getyoti/yoti-doc-scan-react-native/workflows/Publish%20Release/badge.svg)](https://github.com/getyoti/yoti-doc-scan-react-native/actions?query=workflow%3A%22Publish+Release%22)
![Illustration](./Illustration.png)

A react native wrapper of Yoti IDV for [Android](https://github.com/getyoti/yoti-doc-scan-android) and [iOS](https://github.com/getyoti/yoti-doc-scan-ios). Yoti IDV allows a user of your app to take a photo of their document, as well as to scan or capture their face, we then verify this instantly and prepare a response, which your system can then retrieve on your hosted site.s
A react native wrapper of Yoti IDV for [Android](https://github.com/getyoti/yoti-doc-scan-android) and [iOS](https://github.com/getyoti/yoti-doc-scan-ios). Yoti IDV allows a user of your app to take a photo of their document, as well as to scan or capture their face, we then verify this instantly and prepare a response, which your system can then retrieve on your hosted site.

## Prerequisites
To integrate with Yoti IDV, a working infrastructure is needed (see [developers.yoti.com](https://developers.yoti.com/identity-verification/overview) for more details or get in touch with us [here](https://developers.yoti.com/support)).
Expand All @@ -26,7 +26,7 @@ Continuing with your integration for Android, add the following property and rep
```groovy
buildscript {
ext {
yotiSdkVersion = "3.1.0"
yotiSdkVersion = "3.1.1"
}
}
allprojects {
Expand Down Expand Up @@ -76,7 +76,7 @@ target 'TargetName' do
pod 'YotiSDKFaceCapture' // Optional
end
```
In addition, you should add [`NSCameraUsageDescription`](https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription) to your `Info.plist`.
In addition, you should add [`NSCameraUsageDescription`](https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription) to your `Info.plist`.

And if you have included `YotiSDKIdentityDocument` in your target, make sure to also:
- Add [`NFCReaderUsageDescription`](https://developer.apple.com/documentation/bundleresources/information_property_list/nfcreaderusagedescription) to your `Info.plist`
Expand All @@ -86,10 +86,10 @@ And if you have included `YotiSDKIdentityDocument` in your target, make sure to
## Usage
### 1. Import module
```javascript
import RNYotiDocScan from '@getyoti/-yoti-doc-scan-react-native';
import RNYotiDocScan from '@getyoti/yoti-doc-scan-react-native';
```
### 2. Launch a session
Launch a session with its required parameters using the `startSession` function.
Launch a session with its required parameters using the `startSession` function.
```javascript
const successCallback = (code, description) => {
...
Expand All @@ -105,11 +105,11 @@ On iOS, you can set the primary color using the following API:
```javascript
RNYotiDocScan.setPrimaryColorRGB(0, 0, 0); // default: (34, 157, 255)
```
To customize the colors on Android, please refer to its separate [documentation](https://github.com/getyoti/yoti-doc-scan-android#colours).
To customize the colors on Android, please refer to its separate [documentation](https://github.com/getyoti/yoti-doc-scan-android#colours).

In addition, you can choose to also specify a request code on Android:
```javascript
YotiDocScan.setRequestCode(0); // default: 9001
RNYotiDocScan.setRequestCode(0); // default: 9001
```

## Supported languages
Expand Down Expand Up @@ -155,7 +155,7 @@ Code | Description
7000 | The user did not have the required documents

## Support
If you have any questions, please do not hesitate to contact clientsupport@yoti.com. Once we have answered your question, we may contact you again to discuss Yoti products and services. If you'd prefer us not to do this, please let us know when you e-mail.
For any questions or support please contact us [here](https://support.yoti.com). Once we have answered your question, we may contact you again to discuss Yoti products and services. If you'd prefer us not to do this, please let us know when you e-mail.

## Licence
See the licence for our SDK [here](https://www.yoti.com/terms/identity-verification).
See the licence [here](https://www.yoti.com/terms/identity-verification).
2 changes: 1 addition & 1 deletion example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To run this example, a working working React Native environment is needed (see [
Install the wrapper's dependencies by running `yarn install` from the `example` directory, and then proceed to the relevant platform section below.

### Android
To continue your installation with Android, you should run `yarn start` and `adb -s DEVICE_ID_HERE reverse tcp:8081 tcp:8081` (or `adb reverse tcp:8081 tcp:8081` if using a simulator) from the `example` directory. , and then open the `example/android` project in Android Studio. You can now sync Gradle and build the app.
To continue your installation with Android, you should run `yarn start` and `adb -s DEVICE_ID_HERE reverse tcp:8081 tcp:8081` (or `adb reverse tcp:8081 tcp:8081` if using an emulator) from the `example` directory. , and then open the `example/android` project in Android Studio. You can now sync Gradle and build the app.

### iOS
To continue your installation with iOS, you should run `pod install` from the `example/ios` directory, and then open the project in Xcode through the `Demo.xcworkspace` file.
2 changes: 1 addition & 1 deletion example/android/app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ dependencies {
implementation "com.facebook.react:react-native:0.68.5"
implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan:${rootProject.ext.yotiSdkVersion}"
//implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-sup:${rootProject.ext.yotiSdkVersion}"
//implementation "com.yoti.mobile.android.sdk:yoti-sdk-liveness-zoom:${rootProject.ext.yotiSdkVersion}"
implementation "com.yoti.mobile.android.sdk:yoti-sdk-liveness-zoom:${rootProject.ext.yotiSdkVersion}"
//implementation "com.yoti.mobile.android.sdk:yoti-sdk-facecapture:${rootProject.ext.yotiSdkVersion}" // With embedded AI model
//implementation "com.yoti.mobile.android.sdk:yoti-sdk-facecapture-unbundled:${rootProject.ext.yotiSdkVersion}" // Without embedded AI model - around 20 MB smaller in size

Expand Down
2 changes: 1 addition & 1 deletion example/android/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ buildscript {
minSdkVersion = 21
compileSdkVersion = 29
targetSdkVersion = 29
yotiSdkVersion = "3.1.0"
yotiSdkVersion = "3.1.1"
}
repositories {
google()
Expand Down
7 changes: 0 additions & 7 deletions example/ios/Demo/AppDelegate.h
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

#import <React/RCTBridgeDelegate.h>
#import <UIKit/UIKit.h>

Expand Down
7 changes: 0 additions & 7 deletions example/ios/Demo/AppDelegate.m
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

#import "AppDelegate.h"
#import <React/RCTBridge.h>
#import <React/RCTBundleURLProvider.h>
Expand Down
7 changes: 0 additions & 7 deletions example/ios/Demo/main.m
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

#import <UIKit/UIKit.h>
#import "AppDelegate.h"

Expand Down

0 comments on commit 8d532e8

Please sign in to comment.