Introduction

VoiceIt API 2.0 Technology Preview!

Make sure you have curl installed
https://curl.haxx.se

Make sure you have requests installed:
pip3 install requests

Use pip to get the VoiceIt module:
pip3 install voiceit2

#Import the module
from voiceit2 import VoiceIt2

We recommend using jitpack to grab the wrapper into your project. Add the following if you are using Maven for you project:

 <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
   </repositories>
   <dependency>
        <groupId>com.github.voiceittech</groupId>
        <artifactId>VoiceIt2-Java</artifactId>
        <version>0.0.1</version>
   </dependency>

For Gradle, you may need to disable offline mode in case you are using Intellij. We also recommend using Java 8. Add the following to your Gradle build file:

allprojects {
   repositories {
     ...
     maven { url 'https://jitpack.io' }
   }
 }
dependencies {
         implementation 'com.github.voiceittech:VoiceIt2-Java:0.0.1'
 }

Please make sure you have the rest client installed

gem install rest-client

Install VoiceIt2's gem

gem install VoiceIt2

#Require the wrapper
require 'VoiceIt2'

Install the voiceit go module first

go get github.com/voiceittech/VoiceIt2-Go/voiceit2

//Make sure to add the import statement
import "github.com/voiceittech/VoiceIt2-Go/voiceit2"

Install the voiceit2 package via npm

npm install --save voiceit2-nodejs

//Make sure to require the project
let voiceit2 = require('voiceit2-nodejs');

Please make sure you have the RestSharp REST and HTTP Client package:

https://www.nuget.org/packages/RestSharp

dotnet add package RestSharp --version 106.3.0

The VoiceIt2 module can easily be fetched from nuget :

https://www.nuget.org/packages/VoiceIt/1.0.1

dotnet add package VoiceIt --version 1.0.1

Get the wrapper by directly downloading the file from Github :

https://github.com/voiceittech/VoiceIt2-PHP

under voiceit/VoiceIt2.php and include in your project

<?php
include('VoiceIt2.php');
?>

Or, use composer via the command line to get the package :

composer require voiceit-php/voiceit2

<?php
//Make sure to add this at top when using composer
require_once 'vendor/autoload.php';
?>

API 2.0 can be used to add Voice + Face Verification and Identification to your projects. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

Initialize VoiceIt by passing in your API credentials

With shell, you can just use the -u flag to pass the credentials
without having to manually base64 encode them

curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io"

my_voiceit = VoiceIt2('API_KEY_HERE','API_TOKEN_HERE')

myVoiceIt = VoiceIt2.new("API_KEY_HERE", "API_TOKEN_HERE")

myVoiceIt := voiceit2.NewClient("API_KEY_HERE", "API_TOKEN_HERE")

let myVoiceIt = new voiceit2("API_KEY_HERE", "API_TOKEN_HERE");

VoiceIt2 myVoiceIt = new VoiceIt2("API_KEY_HERE", "API_TOKEN_HERE");

<?php
$myVoiceIt = new VoiceIt2("API_KEY_HERE", "API_TOKEN_HERE");
?>

myVoiceIt VoiceIt2 = new VoiceIt2("API_KEY_HERE","API_TOKEN_HERE");

Make sure to replace API_KEY_HERE with your API key and API_TOKEN_HERE with your auth token.

VoiceIt uses an API Key and Authorization Token to allow access to the API. You can sign up for a VoiceIt developer account, and then activate API 2.0 from the settings view under the developer console to retrieve your credentials.

Requests are authenticated using HTTP Basic Auth. Provide your API key as the basic auth username and the the Auth token as the basic auth password. Thus, you can build the authorization header manually by base64 encoding your credentials in the format API_KEY_HERE:AUTH_TOKEN_HERE resulting in something like QVBJX0tFWV9IRVJFOkFFVEhfVE9LRU5fSEVSRQ==,then, add that to the authorization header like this:

Authorization: Basic QVBJX0tFWV9IRVJFOkFFVEhfVE9LRU5fSEVSRQ==

Users

Get all Users

curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io/users"

my_voiceit.get_all_users()

myVoiceIt.getAllUsers();

myVoiceIt.getAllUsers()

myVoiceIt.GetAllUsers()

myVoiceIt.getAllUsers((jsonResponse)=>{
  //handle response
});

myVoiceIt.getAllUsers();

<?php
$myVoiceIt->getAllUsers();
?>

The above command returns JSON structured like this:

{
"message":"Successfully got all users",
"count":2,
"status":200,
"timeTaken":"0.009s",
"users":
[
  {
    "createdAt": 1486672854000,
    "userId": "usr_49c98304252549239775e2b52a84006a"
  },
  {
    "createdAt": 1487026658000,
    "userId": "usr_feb6d1fcd80448628db8ec6a7ddb6322"
  }
],
"responseCode":"SUCC"
}

This endpoint retrieves all the users for an API Key.

HTTP Request

GET https://api.voiceit.io/users

Parameters

No additional parameters needed for this request just basic authentication and a GET request to the end point.

Related Response Codes

SUCC
See detailed descriptions for response codes here

Create a User

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST "https://api.voiceit.io/users"

my_voiceit.create_user()

myVoiceIt.createUser();

myVoiceIt.createUser()

myVoiceIt.CreateUser()

myVoiceIt.createUser((jsonResponse)=>{
  //handle response
});

myVoiceIt.createUser();

<?php
$myVoiceIt->createUser();
?>

The above command returns JSON structured like this:

{
    "message": "Created user with userId: usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 201,
    "timeTaken": "0.055s",
    "createdAt": 1487026658000,
    "userId": "usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "responseCode":"SUCC"
}

This endpoint creates a new user in the system and returns a unique userId.

HTTP Request

POST https://api.voiceit.io/users

Parameters

No additional parameters needed for this request just basic authentication and a POST request to the end point.

Related Response Codes

SUCC
See detailed descriptions for response codes here

Check If a Specific User Exists

curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io/users/usr_feb6d1fcd80448628db8ec6a7ddb6322"

my_voiceit.get_user("USER_ID_HERE")

myVoiceIt.getUser("USER_ID_HERE");

myVoiceIt.getUser("USER_ID_HERE")

myVoiceIt.CheckUserExists("USER_ID_HERE")

myVoiceIt.checkUserExists({
  userId:"USER_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

<?php
$myVoiceIt->getUser("USER_ID_HERE");
?>

myVoiceIt.checkUserExists("USER_ID_HERE");

The above command returns JSON structured like this:

{
"message":"User exists",
"exists":true,
"status":200,
"timeTaken":"0.007s",
"responseCode":"SUCC"
}

This endpoint retrieves a specific user with the given userId.

HTTP Request

GET https://api.voiceit.io/users/<userId>

URL Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to retrieve	True

Related Response Codes

SUCC
See detailed descriptions for response codes here

Delete a Specific User

curl -u API_KEY_HERE:API_TOKEN_HERE -X DELETE "https://api.voiceit.io/users/usr_feb6d1fcd80448628db8ec6a7ddb6322"

my_voiceit.delete_user("USER_ID_HERE")

myVoiceIt.deleteUser("USER_ID_HERE");

<?php
$myVoiceIt->deleteUser("USER_ID_HERE");
?>

myVoiceIt.deleteUser("USER_ID_HERE")

myVoiceIt.DeleteUser("USER_ID_HERE")

myVoiceIt.deleteUser("USER_ID_HERE");

myVoiceIt.deleteUser({
  userId:"USER_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Deleted user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 200,
    "timeTaken": "0.037s",
    "responseCode":"SUCC"
}

This endpoint deletes a specific user with the given userId.

HTTP Request

DELETE https://api.voiceit.io/users/<userId>

URL Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to delete	True

Related Response Codes

SUCC and UNFD
See detailed descriptions for response codes here

Get Groups for User

curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io/users/usr_feb6d1fcd80448628db8ec6a7ddb6322/groups"

my_voiceit.get_groups_for_user("USER_ID_HERE")

myVoiceIt.getGroupsForUser("USER_ID_HERE");

<?php
$myVoiceIt->getGroupsForUser("USER_ID_HERE");
?>

myVoiceIt.getGroupsForUser("USER_ID_HERE")

myVoiceIt.GetGroupsForUser("USER_ID_HERE")

myVoiceIt.getGroupsForUser("USER_ID_HERE");

myVoiceIt.getGroupsForUser({
  userId:"USER_ID_HERE"
},(jsonResponse)=>{
  //handle response
  });

The above command returns JSON structured like this:

{
"message":"Successfully returned all groups that user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322 is a part of",
"groups":[],
"count":0,
"status":200,
"timeTaken":"0.007s",
"responseCode":"SUCC"
}

This endpoint retrieves a list of groups that the user with the given userId is a part of

HTTP Request

GET https://api.voiceit.io/users/<userId>/groups

URL Parameters

Parameter	Type	Description	Required
userId	String	The userId to get groups for	True

Related Response Codes

SUCC and UNFD
See detailed descriptions for response codes here

Groups

Get all Groups

curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io/groups"

my_voiceit.get_all_groups()

myVoiceIt.getAllGroups();

<?php
$myVoiceIt->getAllGroups();
?>

myVoiceIt.getAllGroups()

myVoiceIt.GetAllGroups()

myVoiceIt.getAllGroups((jsonResponse)=>{
  //handle response
});

myVoiceIt.getAllGroups();

The above command returns JSON structured like this:

{
"message":"Successfully got all groups",
"count":1,
"status":200,
"timeTaken":"0.009s",
"groups":
[
  {
    "createdAt": 1486672854000,
    "description": "Main Group",
    "groupId" : "grp_4225f88a571f4bd790b51a91109bab88",
    "users" : ["usr_feb6d1fcd80448628db8ec6a7ddb6322"]
  }
],
"responseCode":"SUCC"
}

This endpoint retrieves all the groups for an API Key.

HTTP Request

GET https://api.voiceit.io/groups

Parameters

No additional parameters needed for this request just basic authentication and a GET request to the end point.

Related Response Codes

SUCC
See detailed descriptions for response codes here

Get a Specific Group

curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io/groups/grp_4225f88a571f4bd790b51a91109bab88"

my_voiceit.get_group("GROUP_ID_HERE")

myVoiceIt.getGroup("GROUP_ID_HERE");

<?php
$myVoiceIt->getGroup("GROUP_ID_HERE");
?>

myVoiceIt.getGroup("GROUP_ID_HERE")

myVoiceIt.GetGroup("GROUP_ID_HERE")

myVoiceIt.getGroup({
  groupId: "GROUP_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.getGroup("GROUP_ID_HERE");

The above command returns JSON structured like this:

{
    "message": "Successfully returned group with groupId : grp_4225f88a571f4bd790b51a91109bab88",
    "description": "Family",
    "groupId": "grp_4225f88a571f4bd790b51a91109bab88",
    "createdAt": 1486991883000,
    "users": [ "usr_feb6d1fcd80448628db8ec6a7ddb6322" ],
    "status": 200,
    "timeTaken": "0.008s",
    "responseCode" : "SUCC"
}

This endpoint retrieves the group and associated fields for the group with the given groupId

HTTP Request

GET https://api.voiceit.io/groups/<groupId>

URL Parameters

Parameter	Type	Description	Required
groupId	String	The groupId of the group to get	True

Related Response Codes

SUCC and GNFD
See detailed descriptions for response codes here

Check if Group Exists

curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io/groups/grp_4225f88a571f4bd790b51a91109bab88/exists"

my_voiceit.group_exists("GROUP_ID_HERE")

myVoiceIt.groupExists("GROUP_ID");

<?php
$myVoiceIt->groupExists("GROUP_ID");
?>

myVoiceIt.groupExists("GROUP_ID_HERE")

myVoiceIt.CheckGroupExists("GROUP_ID_HERE")

myVoiceIt.checkGroupExists({
  groupId: "GROUP_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.checkGroupExists("GROUP_ID_HERE");

The above command returns JSON structured like this:

{
  "message": "Group with groupId : grp_4225f88a571f4bd790b51a91109bab88 exists",
  "exists": true,
  "status": 200,
  "timeTaken": "0.001s",
  "responseCode" : "SUCC"
}

This endpoint can be used to check if a group with the given groupId exists

HTTP Request

GET https://api.voiceit.io/groups/<groupId>/exists

URL Parameters

Parameter	Type	Description	Required
groupId	String	The groupId of the group	True

Related Response Codes

SUCC
See detailed descriptions for response codes here

Create a Group

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST "https://api.voiceit.io/groups"

my_voiceit.create_group("GROUP_DESCRIPTION","GROUP_NAME")

myVoiceIt.createGroup("GROUP_DESCRIPTION");

<?php
$myVoiceIt->createGroup("GROUP_DESCRIPTION");
?>

myVoiceIt.createGroup("Sample Group Description")

myVoiceIt.CreateGroup("Sample Group Description")

myVoiceIt.createGroup({
  description: "Sample Group Description"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.createGroup("Sample Group Description");

The above command returns JSON structured like this:

{
    "message": "Created group with groupId: grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "description": "Family",
    "groupId": "grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "status": 201,
    "createdAt" : 1487026658000,
    "timeTaken": "0.011s",
    "responseCode" : "SUCC"
}

This endpoint creates a new group in the system and returns a unique groupId.

HTTP Request

POST https://api.voiceit.io/groups

Request Parameters

Parameter	Type	Description	Required
description	String	An optional description for the group, to help identify it	False

Related Response Codes

SUCC
See detailed descriptions for response codes here

Add User to Group

curl -u API_KEY_HERE:API_TOKEN_HERE -X PUT
-F "groupId=grp_801e4d6dc1e941bf9165ba5c84bd94d2" \
-F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
"https://api.voiceit.io/groups/addUser"

my_voiceit.add_user_to_group("GROUP_ID_HERE","USER_ID_HERE")

myVoiceIt.addUserToGroup("GROUP_ID_HERE","USER_ID_HERE");

<?php
$myVoiceIt->addUserToGroup("GROUP_ID_HERE","USER_ID_HERE");
?>

myVoiceIt.addUserToGroup("GROUP_ID_HERE", "USER_ID_HERE")

myVoiceIt.AddUserToGroup("GROUP_ID_HERE", "USER_ID_HERE")

myVoiceIt.addUserToGroup({
  userId: "USER_ID_HERE",
  groupId: "GROUP_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.addUserToGroup("GROUP_ID_HERE", "USER_ID_HERE");

The above command returns JSON structured like this:

{
    "message": "Successfully added user usr_49c98304252549239775e2b52a84006a to group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "status": 200,
    "timeTaken": "0.002s",
    "responseCode" : "SUCC"
}

This endpoint adds a specific user with the given userId to a specific group with the given groupId.

HTTP Request

PUT https://api.voiceit.io/groups/addUser

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to add to the group	True
groupId	String	The groupId of the group to add the user to	True

Related Response Codes

SUCC, MISP, FAIL, GNFD and UNFD
See detailed descriptions for response codes here

Remove User from Group

curl -u API_KEY_HERE:API_TOKEN_HERE -X PUT
-F "groupId=grp_801e4d6dc1e941bf9165ba5c84bd94d2" \
-F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
"https://api.voiceit.io/groups/removeUser"

my_voiceit.remove_user_from_group("GROUP_ID","USER_ID")

myVoiceIt.removeUserFromGroup("GROUP_ID_HERE","USER_ID_HERE");

<?php
$myVoiceIt->removeUserFromGroup("GROUP_ID_HERE","USER_ID_HERE");
?>

myVoiceIt.removeUserFromGroup( "GROUP_ID_HERE", "USER_ID_HERE")

myVoiceIt.RemoveUserFromGroup( "GROUP_ID_HERE", "USER_ID_HERE")

myVoiceIt.removeUserFromGroup({
  userId: "USER_ID_HERE",
  groupId: "GROUP_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.removeUserFromGroup( "GROUP_ID_HERE", "USER_ID_HERE");

The above command returns JSON structured like this:

{
    "message": "Successfully removed user usr_49c98304252549239775e2b52a84006a from group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "status": 200,
    "timeTaken": "0.002s",
    "responseCode" : "SUCC"
}

This endpoint removes a specific user with the given userId from a specific group with the given groupId.

HTTP Request

PUT https://api.voiceit.io/groups/removeUser

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to remove from the group	True
groupId	String	The groupId of the group to remove the user from	True

Related Response Codes

SUCC, MISP, FAIL, GNFD, and UNFD
See detailed descriptions for response codes here

Delete a Specific Group

curl -u API_KEY_HERE:API_TOKEN_HERE -X DELETE "https://api.voiceit.io/groups/grp_801e4d6dc1e941bf9165ba5c84bd94d2"

my_voiceit.delete_group("GROUP_ID_HERE")

myVoiceIt.deleteGroup("GROUP_ID_HERE");

<?php
$myVoiceIt->deleteGroup("GROUP_ID_HERE");
?>

myVoiceIt.deleteGroup("GROUP_ID_HERE")

myVoiceIt.DeleteGroup("GROUP_ID_HERE")

myVoiceIt.deleteGroup("GROUP_ID_HERE");

myVoiceIt.deleteGroup({
  groupId: "GROUP_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this

{
    "message": "Successfully deleted group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "status": 200,
    "timeTaken": "0.037s",
    "responseCode":"SUCC"
}

This endpoint deletes a specific group with the given groupId.

HTTP Request

DELETE https://api.voiceit.io/groups/<groupId>

URL Parameters

Parameter	Type	Description	Required
groupId	String	The groupId of the group to delete	True

Related Response Codes

SUCC and GNFD
See detailed descriptions for response codes here

Enrollments

Get All Enrollments for User

curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io/enrollments/usr_feb6d1fcd80448628db8ec6a7ddb6322"

my_voiceit.get_all_enrollments_for_user("USER_ID_HERE")

myVoiceIt.getAllEnrollmentsForUser("USER_ID");

<?php
$myVoiceIt->getAllEnrollmentsForUser("USER_ID");
?>

myVoiceIt.getAllEnrollmentsForUser("USER_ID_HERE")

myVoiceIt.GetAllEnrollmentsForUser("USER_ID_HERE")

myVoiceIt.getAllEnrollmentsForUser("USER_ID_HERE");

myVoiceIt.getAllEnrollmentsForUser({
  userId: "USER_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
"message":"Successfully got all enrollments for user with userId: usr_feb6d1fcd80448628db8ec6a7ddb6322",  
"count":2,
"status":200,
"timeTaken":"0.079s",
"enrollments":
[
  {
    "createdAt": 1487026658003,
    "contentLanguage": "en-US",
    "enrollmentId": 73,
    "text": "never forget tomorrow is a new day"
  },
  {
    "createdAt": 1487026658000,
    "contentLanguage": "en-US",
    "enrollmentId": 79,
    "text": "never forget tomorrow is a new day"
  }
],
"responseCode":"SUCC"
}

This endpoint retrieves all the enrollments for a user.

HTTP Request

GET https://api.voiceit.io/enrollments/<userId>

URL Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to retrieve enrollments for.	True

Related Response Codes

SUCC and UNFD
See detailed descriptions for response codes here

Get User's Face Enrollments

curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io/enrollments/face/usr_feb6d1fcd80448628db8ec6a7ddb6322"

my_voiceit.get_face_enrollments_for_user("USER_USER_ID_HERE)

myVoiceIt.getFaceEnrollmentsForUser("USER_ID_HERE");

<?php
$myVoiceIt->getFaceEnrollmentsForUser("USER_ID_HERE");
?>

myVoiceIt.getFaceEnrollmentsForUser("USER_ID_HERE")

myVoiceIt.GetFaceEnrollmentsForUser("USER_ID_HERE")

myVoiceIt.getFaceEnrollmentsForUser("USER_ID_HERE");

myVoiceIt.getFaceEnrollmentsForUser({
  userId: "USER_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
"message":"Successfully got all face enrollments for user with userId: usr_feb6d1fcd80448628db8ec6a7ddb6322",
"count":2,
"status":200,
"timeTaken":"0.079s",
"faceEnrollments":
[
  {
    "createdAt": 1486672854000,
    "faceEnrollmentId": 23
  },
  {
    "createdAt": 1487026658000,
    "faceEnrollmentId": 45
  }
],
"responseCode":"SUCC"
}

This endpoint retrieves all the face enrollments for a user.

HTTP Request

GET https://api.voiceit.io/enrollments/face/<userId>

URL Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to retrieve face enrollments for.	True

Related Response Codes

SUCC and UNFD See detailed descriptions for response codes here

Create Voice Enrollment

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "contentLanguage=en-US" \
  -F "recording=@/Users/username/voices/enrollment.wav" \
  "https://api.voiceit.io/enrollments"

my_voiceit.create_voice_enrollment("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.createVoiceEnrollment("USER_ID", "LANG_CODE", LOCAL_FILE);

<?php
$myVoiceIt->createVoiceEnrollment("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH");
?>

myVoiceIt.createVoiceEnrollment("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.CreateVoiceEnrollment("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.createVoiceEnrollment("USER_ID", "LANG_CODE", LOCAL_FILE);

myVoiceIt.createVoiceEnrollment({
  userId: "USER_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  audioFilePath : "FULL_AUDIO_PATH"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
"message": "Successfully added voice enrollment for user with userId:usr_49c98304252549239775e2b52a84006a",
"contentLanguage": "en-US",
"id": 57,
"status": 201,
"text": "never forget tomorrow is a new day",
"textConfidence": 100.00,
"createdAt": 1487026658000,
"timeTaken": "7.718s",
"responseCode" : "SUCC"
}

This endpoint creates a new voice enrollment in the system for the given user

HTTP Request

POST https://api.voiceit.io/enrollments

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to create a face enrollment for	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
recording	File	The binary audio data uploaded as a file ( we recommend a wav formatted audio file)	True

Related Response Codes

SUCC, MISP, DDNE, IFAD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU and UNFD
See detailed descriptions for response codes here

Create Voice Enrollment by URL

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "contentLanguage=en-US" \
  -F "fileUrl=https://voiceit.io/enrollment.wav" \
  "https://api.voiceit.io/enrollments/byUrl"

my_voiceit.create_voice_enrollment_by_url("USER_ID", "LANG_CODE", "URL")

myVoiceIt.createVoiceEnrollmentByUrl("USER_ID", "LANG_CODE", "URL");

<?php
$myVoiceIt->createVoiceEnrollmentByUrl("USER_ID", "LANG_CODE", "URL");
?>

myVoiceIt.createVoiceEnrollmentByUrl("USER_ID", "LANG_CODE", "URL")

myVoiceIt.CreateVoiceEnrollmentByUrl("USER_ID", "LANG_CODE", "URL")

myVoiceIt.createVoiceEnrollmentByUrl("USER_ID", "LANG_CODE", "URL");

myVoiceIt.createVoiceEnrollmentByUrl({
  userId: "USER_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  audioFileURL : "PUBLIC_URL_TO_AUDIO_FILE_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
"message": "Successfully added voice enrollment for user with userId:usr_49c98304252549239775e2b52a84006a",
"contentLanguage": "en-US",
"id": 57,
"status": 201,
"text": "never forget tomorrow is a new day",
"textConfidence": 100.00,
"createdAt": 1487026658000,
"timeTaken": "7.718s",
"responseCode" : "SUCC"
}

This endpoint creates a new voice enrollment in the system for the given user

HTTP Request

POST https://api.voiceit.io/enrollments/byUrl

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to create a face enrollment for	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
fileUrl	String	A fully qualified URL to the audio file to be used for enrollment	True

Related Response Codes

SUCC, MISP, DDNE, IFAD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU and UNFD
See detailed descriptions for response codes here

Create Face Enrollment

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "video=@/Users/username/videos/video.mp4" \
  "https://api.voiceit.io/enrollments/face"

my_voiceit.create_face_enrollment("USER_ID",  "LOCAL_FILE_PATH")

myVoiceIt.createFaceEnrollment("USER_ID", LOCAL_FILE);

<?php
$myVoiceIt->createFaceEnrollment("USER_ID", "LOCAL_FILE_PATH");
?>

myVoiceIt.createFaceEnrollment("USER_ID", "LOCAL_FILE_PATH")

myVoiceIt.CreateFaceEnrollment("USER_ID", "LOCAL_FILE_PATH")

myVoiceIt.createFaceEnrollment("USER_ID", LOCAL_FILE);

myVoiceIt.createFaceEnrollment({
  userId: "USER_ID_HERE",
  videoFilePath : "FULL_VIDEO_PATH"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully enrolled face for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 201,
    "blinksCount": 1,
    "createdAt": 1486672854000,
    "timeTaken": "5.055s",
    "faceEnrollmentId":34,
    "responseCode":"SUCC"
}

This endpoint creates a new face enrollment in the system for the given user

HTTP Request

POST https://api.voiceit.io/enrollments/face

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to create a face enrollment for	True
video	File	The binary video data uploaded as a file ( we recommend an mp4 formatted video)	True
doBlinkDetection	Boolean	Is set to false by default ( to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

Related Response Codes

SUCC, MISP, FTMF, FNFD and UNFD
See detailed descriptions for response codes here

Create Video Enrollment

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "contentLanguage=en-US" \
  -F "doBlinkDetection=false" \
  -F "video=@/Users/username/videos/video.mp4" \
  "https://api.voiceit.io/enrollments/video"

my_voiceit.create_video_enrollment("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.createVideoEnrollment("USER_ID", "LANG_CODE", LOCAL_FILE);

<?php
$myVoiceIt->createVideoEnrollment("USER_ID", "LANG_CODE", "LOCAL_FILE");
?>

myVoiceIt.createVideoEnrollment("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.CreateVideoEnrollment("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.createVideoEnrollment("USER_ID", "LANG_CODE", LOCAL_FILE);

myVoiceIt.createVideoEnrollment({
  userId: "USER_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  videoFilePath : "FULL_VIDEO_PATH"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
"message": "Successfully added video enrollment for user with userId : usr_49c98304252549239775e2b52a84006a",
"contentLanguage": "en-US",
"id": 57,
"status": 201,
"text": "never forget tomorrow is a new day",
"textConfidence": 100.00,
"createdAt": 1487026658000,
"timeTaken": "4.718s",
"responseCode" : "SUCC"
}

This endpoint creates a new voice + face enrollment in the system for the given user

HTTP Request

POST https://api.voiceit.io/enrollments/video

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to create a face enrollment for	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
video	File	The binary video data uploaded as a file ( we recommend an mp4 formatted video file)	True
doBlinkDetection	Boolean	Is set to false by default ( to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

Related Response Codes

SUCC, MISP, DDNE, IFVD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU, FTMF, FNFD, and UNFD
See detailed descriptions for response codes here

Create Video Enrollment by URL

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "contentLanguage=en-US" \
  -F "fileUrl=https://voiceit.io/video.mp4" \
  "https://api.voiceit.io/enrollments/video/byUrl"

my_voiceit.create_video_enrollment_by_url("USER_ID", "LANG_CODE", "URL")

myVoiceIt.createVideoEnrollmentByUrl("USER_ID", "LANG_CODE", "URL");

<?php
$myVoiceIt->createVideoEnrollmentByUrl("USER_ID", "LANG_CODE", "URL");
?>

myVoiceIt.createVideoEnrollmentByUrl("USER_ID", "LANG_CODE", "URL")

myVoiceIt.CreateVideoEnrollmentByUrl("USER_ID", "LANG_CODE", "URL")

myVoiceIt.createVideoEnrollmentByUrl("USER_ID", "LANG_CODE", "URL");

myVoiceIt.createVideoEnrollmentByUrl({
  userId: "USER_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  videoFileURL : "PUBLIC_URL_TO_VIDEO_FILE_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
"message": "Successfully added video enrollment for user with userId : usr_49c98304252549239775e2b52a84006a",
"contentLanguage": "en-US",
"id": 57,
"status": 201,
"blinksCount":1,
"text": "never forget tomorrow is a new day",
"textConfidence": 100.00,
"createdAt": 1487026658000,
"timeTaken": "7.718s",
"responseCode" : "SUCC"
}

This endpoint creates a new voice + face enrollment in the system for the given user

HTTP Request

POST https://api.voiceit.io/enrollments/video/byUrl

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to create a face enrollment for	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
fileUrl	String	A fully qualified url to the video file ( we recommend an mp4 formatted video file)	True
doBlinkDetection	Boolean	Is set to false by default ( to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

Related Response Codes

SUCC, MISP, DDNE, IFVD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU, FTMF, FNFD, and UNFD
See detailed descriptions for response codes here

Delete Face Enrollment

curl -u API_KEY_HERE:API_TOKEN_HERE -X DELETE "https://api.voiceit.io/enrollments/face/usr_feb6d1fcd80448628db8ec6a7ddb6322/35"

my_voiceit.delete_face_enrollment("USER_ID", "FACE_ENROLLMENT_ID")

myVoiceIt.deleteFaceEnrollment("USER_ID", "FACE_ENROLLMENT_ID");

<?php
$myVoiceIt->deleteFaceEnrollment("USER_ID", "FACE_ENROLLMENT_ID");
?>

myVoiceIt.deleteFaceEnrollment("USER_ID", "FACE_ENROLLMENT_ID")

myVoiceIt.DeleteFaceEnrollment("USER_ID", "FACE_ENROLLMENT_ID")

myVoiceIt.deleteFaceEnrollment("USER_ID", "FACE_ENROLLMENT_ID");

myVoiceIt.deleteFaceEnrollment({
  userId: "USER_ID_HERE",
  faceEnrollmentId : "FACE_ENROLLMENT_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Deleted face enrollment with faceEnrollmentId : 35 for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 200,
    "timeTaken": "0.057s",
    "responseCode" : "SUCC"
}

This endpoint deletes a specific face enrollment with the given faceEnrollmentId.

HTTP Request

DELETE https://api.voiceit.io/enrollments/face/<userId>/<faceEnrollmentId>

URL Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to delete the face enrollment for.	True
faceEnrollmentId	Integer	The faceEnrollmentId for the face enrollment to delete for the user.	True

Related Response Codes

SUCC, MISP, ENFD, and UNFD
See detailed descriptions for response codes here

Delete Enrollment for User

curl -u API_KEY_HERE:API_TOKEN_HERE -X DELETE "https://api.voiceit.io/enrollments/usr_feb6d1fcd80448628db8ec6a7ddb6322/35"

my_voiceit.delete_enrollment_for_user("USER_ID", "ENROLLMENT_ID")

myVoiceIt.deleteEnrollmentForUser("USER_ID","ENROLLMENT_ID");

<?php
$myVoiceIt->deleteEnrollmentForUser("USER_ID","ENROLLMENT_ID");
?>

myVoiceIt.deleteEnrollmentForUser("USER_ID","ENROLLMENT_ID")

myVoiceIt.DeleteEnrollmentForUser("USER_ID","ENROLLMENT_ID")

myVoiceIt.deleteEnrollmentForUser("USER_ID","ENROLLMENT_ID");

myVoiceIt.deleteEnrollmentForUser({
  userId: "USER_ID_HERE",
  enrollmentId : "ENROLLMENT_ID_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Deleted enrollment with id : 35 for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 200,
    "timeTaken": "0.057s",
    "responseCode":"SUCC"
}

This endpoint deletes a specific enrollment with the given enrollmentId.

HTTP Request

DELETE https://api.voiceit.io/enrollments/<userId>/<enrollmentId>

URL Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to delete the face enrollment for.	True
enrollmentId	Integer	The enrollmentId for the enrollment to delete for the user.	True

Related Response Codes

SUCC, MISP, ENFD, and UNFD
See detailed descriptions for response codes here

Verification

Verify a User's Voice

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "contentLanguage=en-US" \
  -F "recording=@/Users/username/voices/verification.wav" \
  "https://api.voiceit.io/verification"

my_voiceit.voice_verification("USER_ID","LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.voiceVerification("USER_ID","LANG_CODE", LOCAL_FILE);

<?php
$myVoiceIt->voiceVerification("USER_ID","LANG_CODE", "LOCAL_FILE_PATH");
?>

myVoiceIt.voiceVerification("USER_ID","LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.VoiceVerification("USER_ID","LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.voiceVerification("USER_ID","LANG_CODE",LOCAL_FILE);

myVoiceIt.voiceVerification({
  userId: "USER_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  audioFilePath : "FULL_AUDIO_PATH"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully verified user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 200,
    "confidence": 94.0,
    "text": "never forget tomorrow is a new day",
    "textConfidence": 100,
    "timeTaken": "6.055s",
    "responseCode":"SUCC"
}

This endpoint verifies the voice of the user against a minimum of three (3) previous enrollments of the same phrase for the given userId

HTTP Request

POST https://api.voiceit.io/verification

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to verify	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
recording	File	The binary audio data uploaded as a file ( we recommend a wav formatted audio file)	True

Related Response Codes

SUCC, FAIL, MISP, DDNE, IFAD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU and UNFD
See detailed descriptions for response codes here

Verify a User's Voice by URL

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "contentLanguage=en-US" \
  -F "fileUrl=https://voiceit.io/verification.wav" \
  "https://api.voiceit.io/verification/byUrl"

my_voiceit.voice_verification_by_url("USER_ID","LANG_CODE", "URL")

myVoiceIt.voiceVerificationByUrl("USER_ID","LANG_CODE", "URL");

<?php
$myVoiceIt->voiceVerificationByUrl("USER_ID","LANG_CODE", "URL");
?>

myVoiceIt.voiceVerificationByUrl("USER_ID","LANG_CODE", "URL")

myVoiceIt.VoiceVerificationByUrl("USER_ID","LANG_CODE", "URL")

myVoiceIt.voiceVerificationByUrl("USER_ID","LANG_CODE", "URL");

myVoiceIt.voiceVerificationByUrl({
  userId: "USER_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  audioFileURL : "PUBLIC_URL_TO_AUDIO_FILE_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully verified user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 200,
    "confidence": 94.0,
    "text": "never forget tomorrow is a new day",
    "textConfidence": 100,
    "timeTaken": "6.055s",
    "responseCode":"SUCC"
}

This endpoint verifies the voice of the user against a minimum of three (3) previous enrollments of the same phrase for the given userId

HTTP Request

POST https://api.voiceit.io/verification/byUrl

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to verify	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
fileUrl	String	A fully qualified URL to the audio file to be used for voice verification	True

Related Response Codes

SUCC, FAIL, MISP, DDNE, IFAD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU and UNFD
See detailed descriptions for response codes here

Verify a User's Face

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "video=@/Users/username/videos/video.mp4" \
  "https://api.voiceit.io/verification/face"

my_voiceit.face_verification("USER_ID", "LOCAL_FILE_PATH")

myVoiceIt.faceVerification("USER_ID", LOCAL_FILE);

<?php
$myVoiceIt->faceVerification("USER_ID", "LOCAL_FILE_PATH");
?>

myVoiceIt.faceVerification("USER_ID", "LOCAL_FILE_PATH")

myVoiceIt.FaceVerification("USER_ID", "LOCAL_FILE_PATH")

myVoiceIt.faceVerification("USER_ID", LOCAL_FILE);

myVoiceIt.faceVerification({
  userId: "USER_ID_HERE",
  videoFilePath : "FULL_VIDEO_PATH"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully verified user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 200,
    "faceConfidence": 94.0,
    "blinksCount": 0,
    "timeTaken": "6.055s",
    "responseCode":"SUCC"
}

This endpoint verifies the face of the user against previous enrollments for the given userId

HTTP Request

POST https://api.voiceit.io/verification/face

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to verify	True
video	File	The binary video data uploaded as a file ( we recommend an mp4 formatted video )	True
doBlinkDetection	Boolean	Is set to false by default ( to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

Related Response Codes

SUCC, FAIL, MISP, FNFD, FTMF, UNFD
See detailed descriptions for response codes here

Video Verification

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "contentLanguage=en-US" \
  -F "video=@/Users/username/videos/video.mp4" \
  "https://api.voiceit.io/verification/video"

my_voiceit.video_verification("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.videoVerification("USER_ID", "LANG_CODE", LOCAL_FILE);

<?php
$myVoiceIt->videoVerification("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH");
?>

myVoiceIt.videoVerification("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.VideoVerification("USER_ID", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.videoVerification("USER_ID", "LANG_CODE", LOCAL_FILE);

myVoiceIt.videoVerification({
  userId: "USER_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  videoFilePath : "FULL_VIDEO_PATH"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully verified user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 200,
    "voiceConfidence": 93.00,
    "faceConfidence": 94.0,
    "text" : "never forget tomorrow is a new day",
    "textConfidence" : 100.00,
    "blinksCount": 2,
    "timeTaken": "8.055s",
    "responseCode":"SUCC"
}

This endpoint verifies the face and voice of the user against a minimum of three (3) previous enrollments of the same phrase for the given userId

HTTP Request

POST https://api.voiceit.io/verification/video

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to verify	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
video	File	The binary video data uploaded as a file ( we recommend an mp4 formatted video )	True
doBlinkDetection	Boolean	Is set to false by default ( to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

Related Response Codes

SUCC, FAIL, MISP, DDNE, IFVD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU, FTMF, FNFD and GNFD
See detailed descriptions for response codes here

Video Verification by URL

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "userId=usr_feb6d1fcd80448628db8ec6a7ddb6322" \
  -F "contentLanguage=en-US" \
  -F "fileUrl=https://voiceit.io/video.mp4" \
  "https://api.voiceit.io/verification/video/byUrl"

my_voiceit.video_verification_by_url("USER_ID", "LANG_CODE", "URL")

myVoiceIt.videoVerificationByUrl("USER_ID", "LANG_CODE", "URL");

<?php
$myVoiceIt->videoVerificationByUrl("USER_ID", "LANG_CODE", "URL");
?>

myVoiceIt.videoVerificationByUrl("USER_ID", "LANG_CODE", "URL")

myVoiceIt.VideoVerificationByUrl("USER_ID", "LANG_CODE", "URL")

myVoiceIt.videoVerificationByUrl("USER_ID", "LANG_CODE", "URL");

myVoiceIt.videoVerificationByUrl({
  userId: "USER_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  videoFileURL : "PUBLIC_URL_TO_VIDEO_FILE_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully verified user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 200,
    "voiceConfidence": 93.00,
    "faceConfidence": 94.0,
    "text" : "never forget tomorrow is a new day",
    "textConfidence" : 100.00,
    "blinksCount": 2,
    "timeTaken": "8.055s",
    "responseCode":"SUCC"
}

This endpoint verifies the face and voice of the user against a minimum of three (3) previous enrollments of the same phrase for the given userId

HTTP Request

POST https://api.voiceit.io/verification/video/byUrl

Request Parameters

Parameter	Type	Description	Required
userId	String	The userId of the user to verify	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
fileUrl	File	A fully qualified url to the video file ( we recommend an mp4 formatted video file)	True
doBlinkDetection	Boolean	Is set to false by default ( to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

Related Response Codes

SUCC, FAIL, MISP, DDNE, IFVD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU, FTMF, FNFD and GNFD
See detailed descriptions for response codes here

Identification

Identify a User's Voice

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "groupId=grp_801e4d6dc1e941bf9165ba5c84bd94d2" \
  -F "contentLanguage=en-US" \
  -F "recording=@/Users/username/voices/identification.wav" \
  "https://api.voiceit.io/identification"

my_voiceit.voice_identification("GROUP_ID_HERE", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.voiceIdentification("GROUP_ID_HERE", "LANG_CODE", LOCAL_FILE);

<?php
$myVoiceIt->voiceIdentification("GROUP_ID_HERE", "LANG_CODE", "LOCAL_FILE_PATH");
?>

myVoiceIt.voiceIdentification("GROUP_ID_HERE", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.VoiceIdentification("GROUP_ID_HERE", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.voiceIdentification("GROUP_ID_HERE", "LANG_CODE", LOCAL_FILE);

myVoiceIt.voiceIdentification({
  groupId: "GROUP_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  audioFilePath : "FULL_AUDIO_PATH"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully identified user with userId : usr_49c98304252549239775e2b52a84006a in group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "userId": "usr_49c98304252549239775e2b52a84006a",
    "groupId": "grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "confidence": 96.00,
    "status": 200,
    "text": "never forget tomorrow is a new day",
    "textConfidence": 100.00,
    "timeTaken": "9.969s",
    "responseCode":"SUCC"
}

This endpoint identifies the voice of the user amongst other users in the group for the given groupId

HTTP Request

POST https://api.voiceit.io/identification

Request Parameters

Parameter	Type	Description	Required
groupId	String	The groupId of the group to identify the voice out of	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
recording	File	The binary audio data uploaded as a file ( we recommend a wav formatted audio file)	True

Related Response Codes

SUCC, FAIL, MISP, DDNE, IFAD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU and GNFD
See detailed descriptions for response codes here

Identify a User's Voice by URL

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "groupId=grp_801e4d6dc1e941bf9165ba5c84bd94d2" \
  -F "contentLanguage=en-US" \
  -F "fileUrl=https://voiceit.io/identification.wav" \
  "https://api.voiceit.io/identification/byUrl"

my_voiceit.voice_identification_by_url("GROUP_ID_HERE", "LANG_CODE", "URL")

myVoiceIt.voiceIdentificationByUrl("GROUP_ID","LANG_CODE","URL");

<?php
$myVoiceIt->voiceIdentificationByUrl("GROUP_ID","LANG_CODE","URL");
?>

myVoiceIt.voiceIdentificationByUrl("GROUP_ID","LANG_CODE","URL")

myVoiceIt.VoiceIdentificationByUrl("GROUP_ID","LANG_CODE","URL")

myVoiceIt.voiceIdentificationByUrl("GROUP_ID","LANG_CODE","URL");

myVoiceIt.voiceIdentificationByUrl({
  groupId: "GROUP_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  audioFileURL : "PUBLIC_URL_TO_AUDIO_FILE_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully identified user with userId : usr_49c98304252549239775e2b52a84006a in group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "userId": "usr_49c98304252549239775e2b52a84006a",
    "groupId": "grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "confidence": 96.00,
    "status": 200,
    "text": "never forget tomorrow is a new day",
    "textConfidence": 100.00,
    "timeTaken": "9.969s",
    "responseCode":"SUCC"
}

This endpoint identifies the voice of the user amongst other users in the group for the given groupId

HTTP Request

POST https://api.voiceit.io/identification/byUrl

Request Parameters

Parameter	Type	Description	Required
groupId	String	The groupId of the group to identify the voice out of	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
fileUrl	String	A fully qualified URL to the audio file to be used for voice verification	True

Related Response Codes

SUCC, FAIL, MISP, DDNE, IFAD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU and GNFD
See detailed descriptions for response codes here

Video Identification

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "groupId=grp_801e4d6dc1e941bf9165ba5c84bd94d2" \
  -F "contentLanguage=en-US" \
  -F "video=@/Users/username/videos/video.mp4" \
  "https://api.voiceit.io/identification/video"

my_voiceit.video_identification("GROUP_ID_HERE", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.videoIdentification("GROUP_ID_HERE", "LANG_CODE", LOCAL_FILE);

<?php
$myVoiceIt->videoIdentification("GROUP_ID_HERE", "LANG_CODE", "LOCAL_FILE_PATH");
?>

myVoiceIt.videoIdentification("GROUP_ID_HERE", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.VideoIdentification("GROUP_ID_HERE", "LANG_CODE", "LOCAL_FILE_PATH")

myVoiceIt.videoIdentification("GROUP_ID_HERE", "LANG_CODE", LOCAL_FILE);

myVoiceIt.videoIdentification({
  groupId: "GROUP_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  videoFilePath : "FULL_VIDEO_PATH"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully identified user with userId:usr_49c98304252549239775e2b52a84006a in group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "userId": "usr_49c98304252549239775e2b52a84006a",
    "status": 200,
    "voiceConfidence": 93.00,
    "faceConfidence": 94.0,
    "text" : "never forget tomorrow is a new day",
    "textConfidence" : 100.00,
    "blinksCount": 2,
    "timeTaken": "8.055s",
    "responseCode":"SUCC"
}

This endpoint identifies the face and voice of the user amongst other users in the group for the given groupId

HTTP Request

POST https://api.voiceit.io/identification/video

Request Parameters

Parameter	Type	Description	Required
groupId	String	The groupId of the group to identify the face and voice out of	True
video	File	The binary video data uploaded as a file ( we recommend an mp4 formatted video )	True
doBlinkDetection	Boolean	Is set to false by default ( to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

Related Response Codes

SUCC, FAIL, MISP, DDNE, IFVD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU, FTMF, FNFD and GNFD
See detailed descriptions for response codes here

Video Identification by URL

curl -u API_KEY_HERE:API_TOKEN_HERE -X POST \
  -F "groupId=grp_801e4d6dc1e941bf9165ba5c84bd94d2" \
  -F "contentLanguage=en-US" \
  -F "fileUrl=https://voiceit.io/video.mp4" \
  "https://api.voiceit.io/identification/video/byUrl"

my_voiceit.video_identification_by_url("GROUP_ID_HERE", "LANG_CODE", "URL")

myVoiceIt.videoIdentificationByUrl("GROUP_ID_HERE", "LANG_CODE", "URL");

<?php
$myVoiceIt->videoIdentificationByUrl("GROUP_ID_HERE", "LANG_CODE", "URL");
?>

myVoiceIt.videoIdentificationByUrl("GROUP_ID_HERE", "LANG_CODE", "URL")

myVoiceIt.VideoIdentificationByUrl("GROUP_ID_HERE", "LANG_CODE", "URL")

myVoiceIt.videoIdentificationByUrl("GROUP_ID_HERE", "LANG_CODE", "URL");

myVoiceIt.voiceIdentificationByUrl({
  groupId: "GROUP_ID_HERE",
  contentLanguage : "CONTENT_LANGUAGE_HERE",
  audioFileURL : "PUBLIC_URL_TO_AUDIO_FILE_HERE"
},(jsonResponse)=>{
  //handle response
});

The above command returns JSON structured like this:

{
    "message": "Successfully identified user with userId:usr_49c98304252549239775e2b52a84006a in group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "userId": "usr_49c98304252549239775e2b52a84006a",
    "status": 200,
    "voiceConfidence": 93.00,
    "faceConfidence": 94.0,
    "text" : "never forget tomorrow is a new day",
    "textConfidence" : 100.00,
    "blinksCount": 2,
    "timeTaken": "8.055s",
    "responseCode":"SUCC"
}

This endpoint identifies the face and voice of the user amongst other users in the group for the given groupId

HTTP Request

POST https://api.voiceit.io/identification/video/byUrl

Request Parameters

Parameter	Type	Description	Required
groupId	String	The groupId of the group to identify the face and voice out of	True
fileUrl	File	A fully qualified url to the video file ( we recommend an mp4 formatted video file)	True
doBlinkDetection	Boolean	Is set to false by default ( to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

Related Response Codes

SUCC, FAIL, MISP, DDNE, IFVD, SRNR, SSTQ, SSTL, NEHSD, STTF, RWPU, FTMF, FNFD and GNFD
See detailed descriptions for response codes here

Content Languages

The VoiceIt Voice and Video Enrollment/Verification/Identification API calls allow you to pass any of the following 88 supported content language parameters:

Languages without an upcharge

Content Language	Language
ca-ES	Catalan (Spain)
cmn-Hans-CN	Chinese, Mandarin (Simplified, China)
cmn-Hant-TW	Chinese, Mandarin (Traditional, Taiwan)
cmn-Hans-HK	Chinese, Mandarin (Simplified, Hong Kong)
de-DE	German (Germany)
da-DK	Danish (Denmark)
en-GB	English (United Kingdom)
en-US	English (United States)
en-AU	English (Australia)
en-CA	English (Canada)
es-ES	Spanish (Spain)
es-US	Spanish (United States)
es-MX	Spanish (Mexico)
fi-FI	Finnish (Finland)
fr-FR	French (France)
fr-CA	French (Canada)
ja-JP	Japanese (Japan)
ko-KR	Korean (South Korea)
nl-NL	Dutch (Netherlands)
nb-NO	Norwegian Bokmal (Norway)
pl-PL	Polish (Poland)
pt-BR	Portuguese (Brazil)
pt-PT	Portuguese (Portugal)
ru-RU	Russian (Russia)
sv-SE	Swedish (Sweden)

Premium Languages with an upcharge($0.006)

Content Language	Language
af-ZA	Afrikaans (South Africa)
ar-IL	Arabic (Israel)
ar-JO	Arabic (Jordan)
ar-AE	Arabic (United Arab Emirates)
ar-BH	Arabic (Bahrain)
ar-DZ	Arabic (Algeria)
ar-SA	Arabic (Saudi Arabia)
ar-IQ	Arabic (Iraq)
ar-KW	Arabic (Kuwait)
ar-MA	Arabic (Morocco)
ar-TN	Arabic (Tunisia)
ar-OM	Arabic (Oman)
ar-PS	Arabic (State of Palestine)
ar-QA	Arabic (Qatar)
ar-LB	Arabic (Lebanon)
ar-EG	Arabic (Egypt)
bg-BG	Bulgarian (Bulgaria)
cs-CZ	Czech (Czech Republic)
el-GR	Greek (Greece)
en-IN	English (India)
en-IE	English (Ireland)
en-NZ	English (New Zealand)
en-PH	English (Philippines)
en-ZA	English (South Africa)
es-AR	Spanish (Argentina)
es-BO	Spanish (Bolivia)
es-CL	Spanish (Chile)
es-CO	Spanish (Colombia)
es-CR	Spanish (Costa Rica)
es-EC	Spanish (Ecuador)
es-SV	Spanish (El Salvador)
es-GT	Spanish (Guatemala)
es-HN	Spanish (Honduras)
es-NI	Spanish (Nicaragua)
es-PA	Spanish (Panama)
es-PY	Spanish (Paraguay)
es-PE	Spanish (Peru)
es-PR	Spanish (Puerto Rico)
es-DO	Spanish (Dominican Republic)
es-UY	Spanish (Uruguay)
es-VE	Spanish (Venezuela)
eu-ES	Basque (Spain)
fa-IR	Persian (Iran)
fil-PH	Filipino (Philippines)
gl-ES	Galician (Spain)
he-IL	Hebrew (Israel)
hi-IN	Hindi (India)
hr-HR	Croatian (Croatia)
hu-HU	Hungarian (Hungary)
id-ID	Indonesian (Indonesia)
is-IS	Icelandic (Iceland)
it-IT-	Italian (Italy)
lt-LT	Lithuanian (Lithuania)
ms-MY	Malay (Malaysia)
ro-RO	Romanian (Romania)
sr-RS	Serbian (Serbia)
sk-SK	Slovak (Slovakia)
sl-SI	Slovenian (Slovenia)
th-TH	Thai (Thailand)
tr-TR	Turkish (Turkey)
uk-UA	Ukrainian (Ukraine)
vi-VN	Vietnamese (Vietnam)
yue-Hant-HK	Chinese, Cantonese (Traditional, Hong Kong)
zu-ZA	Zulu (South Africa)

Response Codes

The VoiceIt Face Verification API uses the following response codes:

Response Code	Meaning
SUCC	Successful API call
MISP	Missing parameters
MISU	Missing users
FAIL	The API call failed ( i.e.: Failed Face Verification )
UNFD	User not found
GNFD	Group not found
ENFD	Enrollment not found
FNFD	Face not found
DDNE	Data does not exist
FNFD	Face not found in video
FTMF	Found too many faces in video
IFAD	Incorrect formatted audio data
IFVD	Incorrect formatted video data
SRNR	Sound recording does not meet requirements
SSTQ	Speaker is speaking too quiet
SSTL	Speaker is speaking too loud
NEHSD	No human speech detected
STTF	Speech to text failed
RWPU	Recording was previously used
PNTE	Phrase needs a minimum of three enrollments
TVER	Three video enrollments required
NFEF	No face enrollments found
GERR	A general error occurred
DAID	Developer account is disabled ( most likely due to insufficient funds)
UNAC	Unauthorized access ( make sure you are using the right API Key and Token)
CLNE	Content language not enabled for free tier, only en-US is available on the VoiceIt free tier plan
ACLR	API Call Limit Reached

Errors

The VoiceIt Face Verification API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Something is wrong with your request.
401	Unauthorized -- Your API key is wrong.
404	Not Found -- The user could not be found.
405	Method Not Allowed -- You tried to access VoiceIt with an invalid method.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.