|
2 | 2 |
|
3 | 3 | This repository provides a pre-built UI that uses the ComplyCube SDK. It guides you through the ComplyCube identity verification process, which includes collecting client ID documents, proof of address documents, and biometric selfies.
|
4 | 4 |
|
5 |
| -> :information_source: Please get in touch with your **Account Manager** or **[support](https://support.complycube.com/hc/en-gb/requests/new)** to get access to our Mobile SDK. |
6 |
| -
|
7 | 5 | ## To run the app
|
8 | 6 |
|
9 |
| -### Installing Flutter dependencies |
10 |
| - |
11 |
| -### Install the SDK |
12 |
| - |
13 |
| -Install the Flutter library by running: |
14 |
| - |
15 |
| -```sh |
16 |
| -flutter pub add complycube |
17 |
| -``` |
18 |
| - |
19 |
| -### CocoaPods |
20 |
| - |
21 |
| -1. Before using the ComplyCube SDK, install the CocoaPods plugin by running the following command in your terminal: |
22 |
| - |
23 |
| - ```sh |
24 |
| - sudo gem install cocoapods |
25 |
| - ``` |
26 |
| - |
27 |
| -2. Open your `ios/Podfile` and add the following configuration: |
28 |
| - |
29 |
| - ```ruby |
30 |
| - source 'https://github.com/CocoaPods/Specs.git' |
31 |
| -
|
32 |
| - platform :iOS, '13.0' |
33 |
| -
|
34 |
| - target 'YourApp' do |
35 |
| - use_frameworks! |
36 |
| - use_modular_headers! |
37 |
| -
|
38 |
| - # Other existing pod configurations |
39 |
| -
|
40 |
| - post_install do |installer| |
41 |
| - installer.pods_project.targets.each do |target| |
42 |
| - target.build_configurations.each do |build_configuration| |
43 |
| - build_configuration.build_settings['ENABLE_BITCODE'] = 'NO' |
44 |
| - build_configuration.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES' |
45 |
| - build_configuration.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '13.1' |
46 |
| - build_configuration.build_settings['ARCHS'] = ['$(ARCHS_STANDARD)', 'x86_64'] |
47 |
| - build_configuration.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = ['arm64', 'arm64e', 'armv7', 'armv7s'] |
48 |
| - build_configuration.build_settings['GENERATE_INFOPLIST_FILE'] = 'YES' |
49 |
| - end |
50 |
| - end |
51 |
| - end |
52 |
| -
|
53 |
| - $static_frameworks = [ |
54 |
| - # pods that must be built statically |
55 |
| - ] |
56 |
| -
|
57 |
| - pre_install do |installer| |
58 |
| - Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {} |
59 |
| -
|
60 |
| - installer.pod_targets.each do |target| |
61 |
| - if $static_frameworks.include?(target.name) |
62 |
| - puts "Overriding the static_framework method for #{target.name}" |
63 |
| - def target.build_type; |
64 |
| - Pod::BuildType.static_library |
65 |
| - end |
66 |
| - end |
67 |
| - end |
68 |
| - end |
69 |
| - end |
70 |
| - ``` |
71 |
| -
|
72 |
| -3. Save the `Podfile`. |
73 |
| -
|
74 |
| -4. Run `pod install` in your `ios` directory to install the pods and apply the configurations. |
75 |
| -
|
76 |
| -#### Application Permissions |
77 |
| -
|
78 |
| -Our SDK uses the device camera and microphone for capture. You must add the following keys to your application's `ios/Info.plist` file. |
79 |
| -
|
80 |
| -1. `NSCameraUsageDescription` |
81 |
| - ```xml |
82 |
| - <key>NSCameraUsageDescription</key> |
83 |
| - <string>Used to capture facial biometrics and documents</string> |
84 |
| - ``` |
85 |
| -
|
86 |
| -2. `NSMicrophoneUsageDescription` |
87 |
| - ```xml |
88 |
| - <key>NSMicrophoneUsageDescription</key> |
89 |
| - <string>Used to capture video biometrics</string> |
90 |
| - ``` |
91 |
| - |
92 |
| -### Run the apps |
93 |
| -
|
94 | 7 | 1. [Create a Client ID](https://docs.complycube.com/documentation/guides/mobile-sdk-guide/mobile-sdk-integration-guide#id-2.-create-a-client).
|
95 | 8 | 2. [Generate an SDK token](https://docs.complycube.com/documentation/guides/mobile-sdk-guide/mobile-sdk-integration-guide#id-3.-generate-an-sdk-token).
|
96 | 9 | 3. In the `main.dart` file, replace `CLIENT_ID` and `SDK_TOKEN` with the generated values from the previous steps.
|
97 |
| -4. Run the Android app: |
| 10 | +4. Run the app: |
98 | 11 |
|
99 | 12 | ```bash
|
100 | 13 | flutter run
|
101 | 14 | ```
|
102 | 15 |
|
103 |
| -5. Run the iOS app: |
104 |
| -
|
105 |
| - ```bash |
106 |
| - flutter run -d ios |
107 |
| - ``` |
108 |
| -
|
109 | 16 | ## Integrating our SDK
|
110 | 17 |
|
111 | 18 | For detailed instructions on integrating our SDK, please refer to our [integration guide](https://docs.complycube.com/documentation/guides/mobile-sdk-guide/mobile-sdk-integration-guide).
|
|
0 commit comments