{"id":19283096,"url":"https://github.com/voiceittech/voiceit2-react-native-sdk","last_synced_at":"2025-06-12T04:34:57.865Z","repository":{"id":57341342,"uuid":"278908957","full_name":"voiceittech/VoiceIt2-React-Native-SDK","owner":"voiceittech","description":"VoiceIt","archived":false,"fork":false,"pushed_at":"2023-12-22T01:11:12.000Z","size":223,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-02-15T00:05:19.930Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voiceittech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-11T17:23:18.000Z","updated_at":"2021-10-08T20:05:24.000Z","dependencies_parsed_at":"2024-11-20T22:35:52.230Z","dependency_job_id":null,"html_url":"https://github.com/voiceittech/VoiceIt2-React-Native-SDK","commit_stats":{"total_commits":66,"total_committers":5,"mean_commits":13.2,"dds":0.5909090909090908,"last_synced_commit":"97818020fdbf072c391fa107c5adb765c509d3c9"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voiceittech%2FVoiceIt2-React-Native-SDK","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voiceittech%2FVoiceIt2-React-Native-SDK/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voiceittech%2FVoiceIt2-React-Native-SDK/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voiceittech%2FVoiceIt2-React-Native-SDK/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voiceittech","download_url":"https://codeload.github.com/voiceittech/VoiceIt2-React-Native-SDK/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240387187,"owners_count":19793298,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T21:29:42.197Z","updated_at":"2025-02-23T22:26:12.853Z","avatar_url":"https://github.com/voiceittech.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-native-voiceit\n\n* [Getting Started](#getting-started)\n* [Billing](#billing)\n* [Voiceprint Phrases](#voiceprint-phrases)\n* [Plist Permissions](#plist-permissions)\n* [Local Installation ](#local-installation)\n  * [Android](#android)\n  * [IOS](#ios)\n* [Usage](#usage)\n* [Funtions](#functions)\n* [User Token Initializing](#user-token)\n* [Theme Color](#theme)\n\n## Getting started\n`$ npm install react-native-voiceit --save`\n\n## Requirements\n\n#### IOS Deployment Target (IOS Version)\nPlease make sure that the minimum Deployment Target for your project is IOS 11\n\n#### Android SDK Version\nThe minumum Android SDK version (API level) should be set to 17 in your build.gradle file: \n```\nminSdkVersion: 17\n```\n\n#### Billing \nIn order to use en-US or other content languages you need to have a developer account that has funds. In order to add funds to your account please login at: https://voiceit.io/login and navigate to: https://voiceit.io/billing and add funds.\n\n#### Voiceprint Phrases \nMake sure you review your Voiceprint Phrases by navigating to: https://voiceit.io/phraseManagement in order to know what to pass for voicePrintPhrase parameter\n\n#### Plist Permissions \nFor IOS, please make sure your project has Camera and Microphone permissions in the info.plist file. Also, make sure that the app runs in light theme. Add the following inside the \u003cdict\u003e XML:\n```\n\u003ckey\u003eNSCameraUsageDescription\u003c/key\u003e\n\u003cstring\u003eThis app requires to access your camera for biometric services\u003c/string\u003e\n\u003ckey\u003eNSMicrophoneUsageDescription\u003c/key\u003e\n\u003cstring\u003eThis app requires to access your microphone for biometric services\u003c/string\u003e\n\u003ckey\u003eUIUserInterfaceStyle\u003c/key\u003e\n\u003cstring\u003eLight\u003c/string\u003e\n```\n\n### Mostly automatic installation\n\n`$ react-native link react-native-voiceit`\n\n## Local Installation \nFirstly, to use the SDK locally, please clone the repo and drag it into your root React Native project. In the Package.json, replace to \"react-native-voiceit\": \"file:./VoiceIt2-React-Native-SDK\"\n\n#### Android \nGet the \u003ca href=\"https://github.com/voiceittech/VoiceIt2-AndroidSDK#local-installation\"\u003e Android-SDK\u003c/a\u003e locally by doing the following: \n\n\u003cul\u003e\n \u003cli\u003e Clone the Android-SDK repo\n \u003cli\u003e Open your main android project/folder in android studio, and navigate to File -\u003e New -\u003e Import Module\n \u003cli\u003e Select the Android SDK repo that you just cloned. Check off the app module, only include the voiceit2 module\n \u003cli\u003e Navigate to you local VoiceIt2-React-Native-SDK Folder\n \u003cli\u003e In the android/build.gradle, add \n  ```\n  implementation project(path: ':voiceit2')\n  ```\n  under dependencies \n\u003c/ul\u003e\n\n#### IOS\n\nPlease navigate to the podfile of your main IOS folder, and replace to:\n```\n  pod 'react-native-voiceit', :path =\u003e '../VoiceIt2-React-Native-SDK'\n  pod \"VoiceIt2-IosSDK\", :path =\u003e './VoiceIt2-IosSDK'\n```\n\n\n\n## Usage\n```javascript\nimport {NativeModules} from 'react-native';\nconst Voiceit = NativeModules.Voiceit;\n\n//  Initialize the VoiceIt Native Module\n//  Voiceit.init(\"API_KEY\",\"API_TOKEN\",(res)=\u003e{\n//  console.log(res);\n//  } ;\n\n//  Call the methods with the same signature as the IOS/Android SDK. For instance\n//  Voiceit.encapsulatedFaceEnrollment(\"USR_ID\",(res)=\u003e{\n//  console.log(res);\n//  });\n```\n\n#### Functions\nInitialize the module as follows:\n```\nimport {NativeModules} from 'react-native';\nconst Voiceit = NativeModules.Voiceit;\nVoiceit.initVoiceIt(\"API_KEY\",\"API_TOKEN\",(res)=\u003e{\nconsole.log(res);\n};\n```\nThe React Native SDK wraps the IOS and Android SDKs, and hence the methods exposed are the same as those.\nPlease refer to the [The Android SDK](https://github.com/voiceittech/VoiceIt2-AndroidSDK)/[The IOS SDK](https://github.com/voiceittech/VoiceIt2-IosSDK) for complete method reference. For instance\n\n```\nvoiceItModule.encapsulatedFaceVerification(\"USER_ID\",\"CONTENT_LANGUAGE\", LIVENESS_BOOLEAN, AUDIO_LIVENESS_BOOLEAN, (res)=\u003e{\ncallback(res);\n});\n```\n \n#### User Token \n To initialize Voiceit Module with User token and not use your API key and token, first generate a user token: https://api.voiceit.io/#user-token-generation\n Initialize Voiceit by placing the generated user token in palce of the API Key, and leave the API token as blank: \n```\nVoiceit.initVoiceIt(\"GENERATED_USER_TOKEN\",\"\",(res)=\u003e{\nconsole.log(res);\n};\n```\n \n #### Theme\n To set a theme color, please initialize the voiceit Object as follows:\n ```\nVoiceit.initVoiceItWithTheme(\"API_KEY\",\"API_TOKEN\", \"HEX_COLOR_VALUE\",(res)=\u003e{\nconsole.log(res);\n};\n ```\n \n Example: \n ```\nVoiceit.initVoiceItWithTheme(\"key_...\",\"tok_.....\", \"#fbc132\",(res)=\u003e{\nconsole.log(res);\n};\n ```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoiceittech%2Fvoiceit2-react-native-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoiceittech%2Fvoiceit2-react-native-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoiceittech%2Fvoiceit2-react-native-sdk/lists"}