@complycube/react-native/README.md

ComplyCube's React Native Mobile SDK library for Identity Verification, KYC, and AML

# ComplyCube React Native SDK

[![Version](https://img.shields.io/npm/v/@complycube/react-native)](https://www.npmjs.org/package/@complycube/react-native@0.70.6)

The official React Native SDK for integrating ComplyCube's Identity Verification UI into your mobile app.

[ComplyCube](https://www.complycube.com) enables you to automate your AML/KYC workflows effortlessly.

Documentation and minimum requirements can be found at <https://docs.complycube.com/documentation/guides/mobile-sdk-guide>.

## Installation

### Install the SDK

Install the React Native library by running:

```sh
npm install --save @complycube/react-native
```

### CocoaPods

1. Before using the ComplyCube SDK, install the CocoaPods plugin by running the following command in your terminal:

    ```sh
    sudo gem install cocoapods
    ```

2. Open your `ios/Podfile` and add the following configuration:

    ```ruby
    source 'https://github.com/CocoaPods/Specs.git'

    platform :iOS, '13.0'

    target 'YourApp' do
        use_frameworks!
        use_modular_headers!

        # Other existing pod configurations

        post_install do |installer|
            installer.pods_project.targets.each do |target|
                target.build_configurations.each do |build_configuration|
                    build_configuration.build_settings['ENABLE_BITCODE'] = 'NO'
                    build_configuration.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
                    build_configuration.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '13.1'
                    build_configuration.build_settings['ARCHS'] = ['$(ARCHS_STANDARD)', 'x86_64']
                    build_configuration.build_settings['GENERATE_INFOPLIST_FILE'] = 'YES'
                end
            end
        end

        $static_frameworks = [
            'react-native-blurhash',
            'RNScreens',
            'RNScreen',
            'RNCMaskedView',
            'RNReactNativeHapticFeedback',
            'RNReanimated'
        ]

        pre_install do |installer|
            Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {}

            installer.pod_targets.each do |target|
                if $static_frameworks.include?(target.name)
                    puts "Overriding the static_framework method for #{target.name}"
                    def target.build_type;
                        Pod::BuildType.static_library
                    end
                end
            end
        end
    end
    ```

3. Save the `Podfile`.

4. Run `pod install` in your `ios` directory to install the pods and apply the configurations.


#### Application Permissions

Our SDK uses the device camera and microphone for capture. You must add the following keys to your application's `ios/Info.plist` file.

1. `NSCameraUsageDescription`
    ```xml
    <key>NSCameraUsageDescription</key>
    <string>Used to capture facial biometrics and documents</string>
    ```

2. `NSMicrophoneUsageDescription`
    ```xml
    <key>NSMicrophoneUsageDescription</key>
    <string>Used to capture video biometrics</string>
    ```
### Android

Our SDK is available on Maven Central.

Update your application's `android/build.gradle` file with the ComplyCube SDK repository Maven settings and SDK dependency:

```gradle
repositories {
    mavenCentral()
}
 
dependencies {
    implementation "com.complycube:complycube-sdk:+"
}
```

## Getting Started

Visit our [step-by-step guide](https://docs.complycube.com/documentation/guides/mobile-sdk-guide) to quickly get started with our SDK.

## More Documentation

Our Mobile SDK integration documentation and code examples can be found at <https://docs.complycube.com/documentation/guides/mobile-sdk-guide>.

Our sample React Native Mobile SDK project can be found at <https://github.com/complycube/complycube-react-native-sdk>.

Further information on ComplyCube can be found at <https://www.complycube.com>.