Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@complycube/cordova-plugin

complycube26MIT1.0.1

ComplyCube's Cordova SDK library for Identity Verification, KYC, and AML

complycube, kyc, aml, identity, verification, document verification, mobile, cordova, sdk

readme

ComplyCube Cordova SDK

Version

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

ComplyCube 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 cordova library by running:

cordova plugin add @complycube/cordova-plugin

CocoaPods

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

     sudo gem install cocoapods
  2. Add plugin repos and install the pod using your ios/Podfile:

     source 'https://github.com/CocoaPods/Specs.git'
     …
     platform :iOS, '11.0'
    
     target 'YourApp' do
         …
         pod 'ComplyCubeMobileSDK'
     end

Application Permissions

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

  1. NSCameraUsageDescription

    <key>NSCameraUsageDescription</key>
    <string>Used to capture facial biometrics and documents</string>
  2. NSMicrophoneUsageDescription

    <key>NSMicrophoneUsageDescription</key>
    <string>Used to capture video biometrics</string>

Android

Our SDK is available on Maven Central.

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

repositories {
    mavenCentral()
}

dependencies {
    implementation "com.complycube:complycube-sdk:+"
}

Getting Started

Visit our step-by-step 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 Cordova Mobile SDK project can be found at https://github.com/complycube/complycube-cordova-sdk.

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