Introduction

VoiceIt API 2.0 Technology Preview!

#Import the module
from voiceit2 import VoiceIt2

<repositories>
  ...
  <repository>
      <id>jitpack.io</id>
      <url>https://jitpack.io</url>
  </repository>
  ...
</repositories>

<dependencies>
  ...
  <dependency>
    <groupId>com.github.voiceittech</groupId>
    <artifactId>VoiceIt2-Java</artifactId>
    <version>JAVA_VERSION_HERE</version>
  </dependency>
  ...
</dependencies>

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

#Require the wrapper
require 'VoiceIt2'

// Make sure to add the import statement
import (
  voiceit2 "github.com/voiceittech/voiceit2-go"
)

package main

import (
  "encoding/json"
  "fmt"

  voiceit2 "github.com/voiceittech/voiceit2-go"
  "github.com/voiceittech/voiceit2-go/structs"
)

func main() {
  myVoiceIt := voiceit2.NewClient("<apiKey>", "<apiToken>")
  str := myVoiceIt.GetAllUsers()
  var x structs.GetAllUsersReturn
  json.Unmarshal([]byte(str), &x)
  x.Unmarshal(str)
  fmt.Println(x.Users[0].UserId)
  // (Print out the user ID of the first user
  // in the returned users from the get all users call.)
}

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

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

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

require "./voiceIt2.pm";

#include "VoiceIt2.hpp";

import voiceit2.VoiceIt2

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

Basic Authentication

Parameter	Type	Description	Required
apiKey	String	Your API 2.0 key	True
apiToken	String	Your API 2.0 token	True

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

curl -u <apiKey>:<apiToken> "https://api.voiceit.io"

my_voiceit = VoiceIt2('<apiKey>','<apiToken>')

VoiceIt2 myVoiceIt = new VoiceIt2("<apiKey>","<apiToken>");

myVoiceIt = VoiceIt2.new("<apiKey>", "<apiToken>")

myVoiceIt := voiceit2.NewClient("<apiKey>", "<apiToken>")

let myVoiceIt = new voiceit2("<apiKey>", "<apiToken>");

VoiceIt2 myVoiceIt = new VoiceIt2("<apiKey>", "<apiToken>");

<?php
$myVoiceIt = new VoiceIt\VoiceIt2("<apiKey>", "<apiToken>");
?>

my $myVoiceIt = voiceIt2->new("<apiKey>","<apiToken>");

VoiceIt2 myVoiceIt("<apiKey>", "<apiToken>");

VoiceIt2 myVoiceIt("<apiKey>", "<apiToken>")

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

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==

You must replace <apiKey> with your personal API key and <apiToken> with the associated token.

Phrases

Get Phrases

curl -u <apiKey>:<apiToken> "https://api.voiceit.io/phrases/<contentLanguage>"

my_voiceit.get_phrases("<contentLanguage>")

myVoiceIt.getPhrases("<contentLanguage>");

myVoiceIt.getPhrases("<contentLanguage>")

myVoiceIt.GetPhrases("<contentLanguage>")

myVoiceIt.getPhrases({ contentLanguage : "<contentLanguage>" }, (jsonResponse)=>{
  //handle response
});

myVoiceIt.GetPhrases("<contentLanguage>");

<?php
$myVoiceIt->getPhrases("<contentLanguage>");
?>

$myVoiceIt->getPhrases("<contentLanguage>");

myVoiceIt.GetPhrases("<contentLanguage>");

myVoiceIt.getPhrases("<contentLanguage>")

{
"message":"Successfully got en-US phrases for account",
"count":2,
"status":200,
"timeTaken":"0.009s",
"phrases":
[
  {
    "text": "Never forget tomorrow is a new day",
    "contentLanguage": "en-US",
  },
  {
    "text": "My face and voice identify me",
    "contentLanguage": "en-US",
  }
],
"responseCode":"SUCC"
}

This endpoint retrieves all of a developer's approved phrases for a given contentLanguage.

HTTP Request

GET https://api.voiceit.io/phrases/<contentLanguage>

URL Parameters

Parameter	Type	Description	Required
contentLanguage	String	Choose from a list of 88 content language parameters	True

SUCC and INCP See detailed descriptions for response codes here

Users

Get all Users

curl -u <apiKey>:<apiToken> "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();
?>

$myVoiceIt->getAllUsers();

myVoiceIt.GetAllUsers();

myVoiceIt.getAllUsers()

{
"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.

SUCC
See detailed descriptions for response codes here

Create a User

curl -u <apiKey>:<apiToken> -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();
?>

$myVoiceIt->createUser();

myVoiceIt.CreateUser();

myVoiceIt.createUser()

{
    "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.

SUCC
See detailed descriptions for response codes here

Make sure to save the userId returned by this API call on the client side, possibly in a database as it is needed for all future API calls related directly to this user profile.

Check If a Specific User Exists

curl -u <apiKey>:<apiToken> "https://api.voiceit.io/users/<userId>"

my_voiceit.check_user_exists("<userId>")

myVoiceIt.checkUserExists("<userId>");

myVoiceIt.checkUserExists("<userId>")

myVoiceIt.CheckUserExists("<userId>")

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

myVoiceIt.CheckUserExists("<userId>");

<?php
$myVoiceIt->checkUserExists("<userId>");
?>

$myVoiceIt->checkUserExists("<userId>");

myVoiceIt.CheckUserExists("<userId>");

myVoiceIt.checkUserExists("<userId>")

{
"message":"User with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322 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 ID of the user	True

SUCC
See detailed descriptions for response codes here

Delete a Specific User

curl -u <apiKey>:<apiToken> -X DELETE "https://api.voiceit.io/users/<userId>"

my_voiceit.delete_user("<userId>")

myVoiceIt.deleteUser("<userId>");

myVoiceIt.deleteUser("<userId>")

myVoiceIt.DeleteUser("<userId>")

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

myVoiceIt.DeleteUser("<userId>");

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

$myVoiceIt->deleteUser("<userId>");

myVoiceIt.DeleteUser("<userId>");

myVoiceIt.deleteUser("<userId>")

{
    "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 ID of the user	True

SUCC and UNFD
See detailed descriptions for response codes here

Get Groups for User

curl -u <apiKey>:<apiToken> "https://api.voiceit.io/users/<userId>/groups"

my_voiceit.get_groups_for_user("<userId>")

myVoiceIt.getGroupsForUser("<userId>");

myVoiceIt.getGroupsForUser("<userId>")

myVoiceIt.GetGroupsForUser("<userId>")

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

myVoiceIt.GetGroupsForUser("<userId>");

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

$myVoiceIt->getGroupsForUser("<userId>");

myVoiceIt.GetGroupsForUser("<userId>");

myVoiceIt.getGroupsForUser("<userId>")

{
"message":"Successfully returned all groups that user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322 is a part of",
"groups":["grp_4225f88a571f4bd790b51a91109bab88", "grp_801e4d6dc1e941bf9165ba5c84bd94d2"],
"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 ID of the user	True

SUCC and UNFD
See detailed descriptions for response codes here

Groups

Get all Groups

curl -u <apiKey>:<apiToken> "https://api.voiceit.io/groups"

my_voiceit.get_all_groups()

myVoiceIt.getAllGroups();

myVoiceIt.getAllGroups()

myVoiceIt.GetAllGroups()

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

myVoiceIt.GetAllGroups();

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

$myVoiceIt->getAllGroups();

myVoiceIt.GetAllGroups();

myVoiceIt.getAllGroups()

{
"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.

SUCC
See detailed descriptions for response codes here

Get a Specific Group

curl -u <apiKey>:<apiToken> "https://api.voiceit.io/groups/<groupId>"

my_voiceit.get_group("<groupId>")

myVoiceIt.getGroup("<groupId>");

myVoiceIt.getGroup("<groupId>")

myVoiceIt.GetGroup("<groupId>")

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

myVoiceIt.GetGroup("<groupId>");

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

$myVoiceIt->getGroup("<groupId>");

myVoiceIt.GetGroup("<groupId>");

myVoiceIt.getGroup("<groupId>")

{
    "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 ID of the group	True

SUCC and GNFD
See detailed descriptions for response codes here

Check if Group Exists

curl -u <apiKey>:<apiToken> "https://api.voiceit.io/groups/<groupId>/exists"

my_voiceit.group_exists("<groupId>")

myVoiceIt.groupExists("<groupId>");

myVoiceIt.groupExists("<groupId>")

myVoiceIt.CheckGroupExists("<groupId>")

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

myVoiceIt.GroupExists("<groupId>");

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

$myVoiceIt->groupExists("<groupId>");

myVoiceIt.CheckGroupExists("<groupId>");

myVoiceIt.checkGroupExists("<groupId>")

{
  "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 ID of the group	True

SUCC
See detailed descriptions for response codes here

Create a Group

curl -u <apiKey>:<apiToken> -F "description=<description>" -X POST "https://api.voiceit.io/groups"

my_voiceit.create_group("<description>")

myVoiceIt.createGroup("<description>");

myVoiceIt.createGroup("<description>")

myVoiceIt.CreateGroup("<description>")

myVoiceIt.createGroup({
  description: "<description>")=>{
  //handle response
});

myVoiceIt.CreateGroup("<description>");

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

$myVoiceIt->createGroup("<description>");

myVoiceIt.CreateGroup("<description>");

myVoiceIt.createGroup("<description>")

{
    "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 help identify the group	False

SUCC
See detailed descriptions for response codes here

Make sure to save the groupId returned by this API call on the client side, possibly in a database as it is needed for all future API calls related directly to this group.

Add User to Group

curl -u <apiKey>:<apiToken> \
-F "groupId=<groupId>" \
-F "userId=<userId>" \
-X PUT "https://api.voiceit.io/groups/addUser"

my_voiceit.add_user_to_group("<groupId>", "<userId>")

myVoiceIt.addUserToGroup("<groupId>", "<userId>");

myVoiceIt.addUserToGroup("<groupId>", "<userId>")

myVoiceIt.AddUserToGroup("<groupId>", "<userId>")

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

myVoiceIt.AddUserToGroup("<groupId>", "<userId>");

<?php
$myVoiceIt->addUserToGroup("<groupId>", "<userId>");
?>

$myVoiceIt->addUserToGroup("<groupId>", "<userId>");

myVoiceIt.AddUserToGroup("<groupId>", "<userId>");

myVoiceIt.addUserToGroup("<groupId>", "<userId>")

{
    "message": "Successfully added user with userId : 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 ID of the user	True
groupId	String	The ID of the group	True

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

Remove User from Group

curl -u <apiKey>:<apiToken> \
-F "groupId=<groupId>" \
-F "userId=<userId>" \
-X PUT "https://api.voiceit.io/groups/removeUser"

my_voiceit.remove_user_from_group("<groupId>", "<userId>")

myVoiceIt.removeUserFromGroup("<groupId>", "<userId>");

myVoiceIt.removeUserFromGroup( "<groupId>", "<userId>")

myVoiceIt.RemoveUserFromGroup( "<groupId>", "<userId>")

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

myVoiceIt.RemoveUserFromGroup( "<groupId>", "<userId>");

<?php
$myVoiceIt->removeUserFromGroup("<groupId>", "<userId>");
?>

$myVoiceIt->removeUserFromGroup("<groupId>", "<userId>");

myVoiceIt.RemoveUserFromGroup("<groupId>", "<userId>");

myVoiceIt.removeUserFromGroup("<groupId>", "<userId>")

{
    "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 ID of the user	True
groupId	String	The ID of the group	True

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

Delete a Specific Group

curl -u <apiKey>:<apiToken> -X DELETE "https://api.voiceit.io/groups/<groupId>"

my_voiceit.delete_group("<groupId>")

myVoiceIt.deleteGroup("<groupId>");

myVoiceIt.deleteGroup("<groupId>")

myVoiceIt.DeleteGroup("<groupId>")

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

myVoiceIt.DeleteGroup("<groupId>");

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

$myVoiceIt->deleteGroup("<groupId>");

myVoiceIt.DeleteGroup("<groupId>");

myVoiceIt.deleteGroup("<groupId>")

{
    "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 ID of the group	True

SUCC and GNFD
See detailed descriptions for response codes here

Enrollments

Get All Voice Enrollments

curl -u <apiKey>:<apiToken> "https://api.voiceit.io/enrollments/voice/<userId>"

my_voiceit.get_all_voice_enrollments("<userId>")

myVoiceIt.getAllVoiceEnrollments("<userId>");

myVoiceIt.getAllVoiceEnrollments("<userId>")

myVoiceIt.GetAllVoiceEnrollments("<userId>")

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

myVoiceIt.GetAllVoiceEnrollments("<userId>");

<?php
$myVoiceIt->getAllVoiceEnrollments("<userId>");
?>

$myVoiceIt->getAllVoiceEnrollments("<userId>");

myVoiceIt.GetAllVoiceEnrollments("<userId>");

myVoiceIt.getAllVoiceEnrollments("<userId>")

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

This endpoint retrieves all the voice enrollments for a user.

HTTP Request

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

URL Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True

SUCC and UNFD See detailed descriptions for response codes here

Get All Face Enrollments

curl -u <apiKey>:<apiToken> "https://api.voiceit.io/enrollments/face/<userId>"

my_voiceit.get_all_face_enrollments("<userId>")

myVoiceIt.getAllFaceEnrollments("<userId>");

myVoiceIt.getAllFaceEnrollments("<userId>")

myVoiceIt.GetAllFaceEnrollments("<userId>")

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

myVoiceIt.GetAllFaceEnrollments("<userId>");

<?php
$myVoiceIt->getAllFaceEnrollments("<userId>");
?>

$myVoiceIt->getAllFaceEnrollments("<userId>");

myVoiceIt.GetAllFaceEnrollments("<userId>");

myVoiceIt.getAllFaceEnrollments("<userId>")

{
"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 ID of the user	True

SUCC and UNFD See detailed descriptions for response codes here

Get All Video Enrollments

curl -u <apiKey>:<apiToken> "https://api.voiceit.io/enrollments/video/<userId>"

my_voiceit.get_all_video_enrollments("<userId>")

myVoiceIt.getAllVideoEnrollments("<userId>");

myVoiceIt.getAllVideoEnrollments("<userId>")

myVoiceIt.GetAllVideoEnrollments("<userId>")

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

myVoiceIt.GetAllVideoEnrollments("<userId>");

<?php
$myVoiceIt->getAllVideoEnrollments("<userId>");
?>

$myVoiceIt->getAllVideoEnrollments("<userId>");

myVoiceIt.GetAllVideoEnrollments("<userId>");

myVoiceIt.getAllVideoEnrollments("<userId>")

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

This endpoint retrieves all the video enrollments for a user.

HTTP Request

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

URL Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True

SUCC and UNFD See detailed descriptions for response codes here

Create Voice Enrollment

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "recording=@<recording>" \
  "https://api.voiceit.io/enrollments/voice"

my_voiceit.create_voice_enrollment("<userId>", "<contentLanguage>", "<phrase>", "<recording>")

myVoiceIt.createVoiceEnrollment("<userId>", "<contentLanguage>", "<phrase>", <recording>);

myVoiceIt.createVoiceEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<recording>")

myVoiceIt.CreateVoiceEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<recording>")

myVoiceIt.createVoiceEnrollment({
  userId : "<userId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  audioFilePath : "<recording>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.CreateVoiceEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<recording>");

<?php
$myVoiceIt->createVoiceEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<recording>");
?>

$myVoiceIt->createVoiceEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<recording>");

myVoiceIt.CreateVoiceEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<recording>");

myVoiceIt.createVoiceEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<recording>")

{
"message": "Successfully enrolled voice 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/voice

Request Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
phrase	String	The text of a valid phrase for the developer account	True
recording	File / String	The binary audio data uploaded as a file. Our wrappers also accept the absolute path to the audio file ( we recommend a wav formatted audio file)	True

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

Create Voice Enrollment by URL

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "fileUrl=<fileUrl>" \
  "https://api.voiceit.io/enrollments/voice/byUrl"

my_voiceit.create_voice_enrollment_by_url("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.createVoiceEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.createVoiceEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.CreateVoiceEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.createVoiceEnrollmentByUrl({
  userId : "<userId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  audioFileURL : "<fileUrl>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.CreateVoiceEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

<?php
$myVoiceIt->createVoiceEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");
?>

$myVoiceIt->createVoiceEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.CreateVoiceEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.createVoiceEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

{
"message": "Successfully enrolled voice 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/voice/byUrl

Request Parameters

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

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

Create Face Enrollment

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "video=@<video>" \
  "https://api.voiceit.io/enrollments/face"

my_voiceit.create_face_enrollment("<userId>",  "<video>")

myVoiceIt.createFaceEnrollment("<userId>", "<video>");

myVoiceIt.createFaceEnrollment("<userId>", "<video>")

myVoiceIt.CreateFaceEnrollment("<userId>", "<video>")

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

myVoiceIt.CreateFaceEnrollment("<userId>", "<video>");

<?php
$myVoiceIt->createFaceEnrollment("<userId>", "<video>");
?>

$myVoiceIt->createFaceEnrollment("<userId>", "<video>");

myVoiceIt.CreateFaceEnrollment("<userId>", "<video>");

myVoiceIt.createFaceEnrollment("<userId>", "<video>", false)

{
    "message": "Successfully enrolled face for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 201,
    "blinksCount": 1,
    "timeTaken": "5.055s",
    "faceEnrollmentId":34,
    "createdAt": 1487026658000,
    "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 ID of the user	True
video	File / String	The binary video data uploaded as a file. Our wrappers also accept the absolute path to the video file ( we recommend an mp4 formatted video)	True
doBlinkDetection	Boolean	Is set to false by default ( In order to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

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

Create Face Enrollment by URL

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "fileUrl=<fileUrl>" \
  "https://api.voiceit.io/enrollments/face/byUrl"

my_voiceit.create_face_enrollment_by_url("<userId>", "<fileUrl>")

myVoiceIt.createFaceEnrollmentByUrl("<userId>", "<fileUrl>");

myVoiceIt.createFaceEnrollmentByUrl("<userId>", "<fileUrl>")

myVoiceIt.CreateFaceEnrollmentByUrl("<userId>", "<fileUrl>")

myVoiceIt.createFaceEnrollmentByUrl({
  userId : "<userId>",
  videoFileURL : "<fileUrl>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.CreateFaceEnrollmentByUrl("<userId>", "<fileUrl>");

<?php
$myVoiceIt->createFaceEnrollmentByUrl("<userId>", "<fileUrl>");
?>

$myVoiceIt->createFaceEnrollmentByUrl("<userId>", "<fileUrl>");

myVoiceIt.CreateFaceEnrollmentByUrl("<userId>", "<fileUrl>");

myVoiceIt.createFaceEnrollmentByUrl("<userId>", "<fileUrl>", false)

{
    "message": "Successfully enrolled face for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 201,
    "blinksCount": 1,
    "timeTaken": "5.055s",
    "faceEnrollmentId":34,
    "createdAt": 1487026658000,
    "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/byUrl

Request Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	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

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

Create Video Enrollment

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "doBlinkDetection=false" \
  -F "video=@<video>" \
  "https://api.voiceit.io/enrollments/video"

my_voiceit.create_video_enrollment("<userId>", "<contentLanguage>", "<phrase>", "<video>")

myVoiceIt.createVideoEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<video>");

myVoiceIt.createVideoEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<video>")

myVoiceIt.CreateVideoEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<video>")

myVoiceIt.createVideoEnrollment({
  userId : "<userId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  videoFilePath : "<video>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.CreateVideoEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<video>");

<?php
$myVoiceIt->createVideoEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<video>");
?>

$myVoiceIt->createVideoEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<video>");

myVoiceIt.CreateVideoEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<video>");

myVoiceIt.createVideoEnrollment("<userId>", "<contentLanguage>", "<phrase>", "<video>", false)

{
"message": "Successfully enrolled video 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 ID of the user	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
phrase	String	The text of a valid phrase for the developer account	True
video	File / String	The binary video data uploaded as a file. Our wrappers also accept the absolute path to the video 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

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

Create Video Enrollment by URL

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "fileUrl=<fileUrl>" \
  "https://api.voiceit.io/enrollments/video/byUrl"

my_voiceit.create_video_enrollment_by_url("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.createVideoEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.createVideoEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.CreateVideoEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.createVideoEnrollmentByUrl({
  userId : "<userId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  videoFileURL : "<fileUrl>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.CreateVideoEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

<?php
$myVoiceIt->createVideoEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");
?>

$myVoiceIt->createVideoEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.CreateVideoEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.createVideoEnrollmentByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>", false)

{
"message": "Successfully enrolled video 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 ID of the user	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
phrase	String	The text of a valid phrase for the developer account	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

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

Delete Voice Enrollment

curl -u <apiKey>:<apiToken> -X DELETE "https://api.voiceit.io/enrollments/voice/<userId>/<voiceEnrollmentId>"

my_voiceit.delete_voice_enrollment("<userId>", <voiceEnrollmentId>)

myVoiceIt.deleteVoiceEnrollment("<userId>", <voiceEnrollmentId>);

myVoiceIt.deleteVoiceEnrollment("<userId>", <voiceEnrollmentId>)

myVoiceIt.DeleteVoiceEnrollment("<userId>", <voiceEnrollmentId>)

myVoiceIt.deleteVoiceEnrollment({
  userId : "<userId>",
  voiceEnrollmentId : <voiceEnrollmentId>
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.DeleteVoiceEnrollment("<userId>", <voiceEnrollmentId>);

<?php
$myVoiceIt->deleteVoiceEnrollment("<userId>", <voiceEnrollmentId>);
?>

$myVoiceIt->deleteVoiceEnrollment("<userId>", <voiceEnrollmentId>);

myVoiceIt.DeleteVoiceEnrollment( "<userId>", <voiceEnrollmentId>);

myVoiceIt.deleteVoiceEnrollment("<userId>", <voiceEnrollmentId>)

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

This endpoint deletes a specific voice enrollment with the given voiceEnrollmentId.

HTTP Request

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

URL Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True
voiceEnrollmentId	Integer	The ID for the voice enrollment to delete for the user	True

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

Delete Face Enrollment

curl -u <apiKey>:<apiToken> -X DELETE "https://api.voiceit.io/enrollments/face/<userId>/<faceEnrollmentId>"

my_voiceit.delete_face_enrollment("<userId>", <faceEnrollmentId>)

myVoiceIt.deleteFaceEnrollment("<userId>", <faceEnrollmentId>);

myVoiceIt.deleteFaceEnrollment("<userId>", <faceEnrollmentId>)

myVoiceIt.DeleteFaceEnrollment("<userId>", <faceEnrollmentId>)

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

myVoiceIt.DeleteFaceEnrollment("<userId>", <faceEnrollmentId>);

<?php
$myVoiceIt->deleteFaceEnrollment("<userId>", <faceEnrollmentId>);
?>

$myVoiceIt->deleteFaceEnrollment("<userId>", <faceEnrollmentId>);

myVoiceIt.DeleteFaceEnrollment( "<userId>", <faceEnrollmentId>);

myVoiceIt.deleteFaceEnrollment("<userId>", <faceEnrollmentId>)

{
    "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 ID of the user	True
faceEnrollmentId	Integer	The ID for the face enrollment to delete for the user	True

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

Delete Video Enrollment

curl -u <apiKey>:<apiToken> -X DELETE "https://api.voiceit.io/enrollments/video/<userId>/<videoEnrollmentId>"

my_voiceit.delete_video_enrollment("<userId>", <videoEnrollmentId>)

myVoiceIt.deleteVideoEnrollment("<userId>", <videoEnrollmentId>);

myVoiceIt.deleteVideoEnrollment("<userId>", <videoEnrollmentId>)

myVoiceIt.DeleteVideoEnrollment("<userId>", <videoEnrollmentId>)

myVoiceIt.deleteVideoEnrollment({
  userId : "<userId>",
  videoEnrollmentId : <videoEnrollmentId>
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.DeleteVideoEnrollment("<userId>", <videoEnrollmentId>);

<?php
$myVoiceIt->deleteVideoEnrollment("<userId>", <videoEnrollmentId>);
?>

$myVoiceIt->deleteVideoEnrollment("<userId>", <videoEnrollmentId>);

myVoiceIt.DeleteVideoEnrollment( "<userId>", <videoEnrollmentId>);

myVoiceIt.deleteVideoEnrollment("<userId>", <videoEnrollmentId>)

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

This endpoint deletes a specific video enrollment with the given videoEnrollmentId.

HTTP Request

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

URL Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True
videoEnrollmentId	Integer	The ID for the video enrollment to delete for the user	True

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

Delete All Voice Enrollments

curl -u <apiKey>:<apiToken> -X DELETE "https://api.voiceit.io/enrollments/<userId>/voice"

my_voiceit.delete_all_voice_enrollments("<userId>")

myVoiceIt.deleteAllVoiceEnrollments("<userId>");

myVoiceIt.deleteAllVoiceEnrollments("<userId>")

myVoiceIt.DeleteAllVoiceEnrollments("<userId>")

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

myVoiceIt.DeleteAllVoiceEnrollments("<userId>");

<?php
$myVoiceIt->deleteAllVoiceEnrollments("<userId>");
?>

$myVoiceIt->deleteAllVoiceEnrollments("<userId>");

myVoiceIt.DeleteAllVoiceEnrollments("<userId>");

myVoiceIt.deleteAllVoiceEnrollments("<userId>")

{
"message": "All voice enrollments for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322 were deleted",
"responseCode": "SUCC",
"status": 200,
"timeTaken": "0.016s"
}

This endpoint deletes all registered voice enrollments for a given userId.

HTTP Request

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

URL Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True

SUCC, MISP, and UNFD

Delete All Face Enrollments

curl -u <apiKey>:<apiToken> -X DELETE "https://api.voiceit.io/enrollments/<userId>/face"

my_voiceit.delete_all_face_enrollments("<userId>")

myVoiceIt.deleteAllFaceEnrollments("<userId>");

myVoiceIt.deleteAllFaceEnrollments("<userId>")

myVoiceIt.DeleteAllFaceEnrollments("<userId>")

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

myVoiceIt.DeleteAllFaceEnrollments("<userId>");

<?php
$myVoiceIt->deleteAllFaceEnrollments("<userId>");
?>

$myVoiceIt->deleteAllFaceEnrollments("<userId>");

myVoiceIt.DeleteAllFaceEnrollments("<userId>");

myVoiceIt.deleteAllFaceEnrollments("<userId>")

{
"message": "All face enrollments for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322 were deleted",
"responseCode": "SUCC",
"status": 200,
"timeTaken": "0.016s"
}

This endpoint deletes all registered face enrollments for a given userId.

HTTP Request

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

URL Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True

SUCC, MISP, and UNFD

Delete All Video Enrollments

curl -u <apiKey>:<apiToken> -X DELETE "https://api.voiceit.io/enrollments/<userId>/video"

my_voiceit.delete_all_video_enrollments("<userId>")

myVoiceIt.deleteAllVideoEnrollments("<userId>");

myVoiceIt.deleteAllVideoEnrollments("<userId>")

myVoiceIt.DeleteAllVideoEnrollments("<userId>")

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

myVoiceIt.DeleteAllVideoEnrollments("<userId>");

<?php
$myVoiceIt->deleteAllVideoEnrollments("<userId>");
?>

$myVoiceIt->deleteAllVideoEnrollments("<userId>");

myVoiceIt.DeleteAllVideoEnrollments("<userId>");

myVoiceIt.deleteAllVideoEnrollments("<userId>")

{
"message": "All video enrollments for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322 were deleted",
"responseCode": "SUCC",
"status": 200,
"timeTaken": "0.016s"
}

This endpoint deletes all registered video enrollments for a given userId.

HTTP Request

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

URL Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True

SUCC, MISP, and UNFD

Delete All Enrollments

curl -u <apiKey>:<apiToken> -X DELETE "https://api.voiceit.io/enrollments/<userId>/all"

my_voiceit.delete_all_enrollments("<userId>")

myVoiceIt.deleteAllEnrollments("<userId>");

myVoiceIt.deleteAllEnrollments("<userId>")

myVoiceIt.DeleteAllEnrollments("<userId>")

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

myVoiceIt.DeleteAllEnrollments("<userId>");

<?php
$myVoiceIt->deleteAllEnrollments("<userId>");
?>

$myVoiceIt->deleteAllEnrollments("<userId>");

myVoiceIt.DeleteAllEnrollments("<userId>");

myVoiceIt.deleteAllEnrollments("<userId>")

{
"message": "All enrollments for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322 were deleted",
"responseCode": "SUCC",
"status": 200,
"timeTaken": "0.016s"
}

This endpoint deletes all registered enrollments for a given userId.

HTTP Request

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

URL Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True

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

Verification

Verify a User's Voice

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "recording=@<recording>" \
  "https://api.voiceit.io/verification/voice"

my_voiceit.voice_verification("<userId>", "<contentLanguage>", "<phrase>", "<recording>")

myVoiceIt.voiceVerification("<userId>", "<contentLanguage>", "<phrase>", "<recording>");

myVoiceIt.voiceVerification("<userId>", "<contentLanguage>", "<phrase>", "<recording>")

myVoiceIt.VoiceVerification("<userId>", "<contentLanguage>", "<phrase>", "<recording>")

myVoiceIt.voiceVerification({
  userId : "<userId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  audioFilePath : "<recording>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.VoiceVerification("<userId>", "<contentLanguage>", "<phrase>", "<recording>");

<?php
$myVoiceIt->voiceVerification("<userId>", "<contentLanguage>", "<phrase>", "<recording>");
?>

$myVoiceIt->voiceVerification("<userId>", "<contentLanguage>", "<phrase>", "<recording>");

myVoiceIt.VoiceVerification("<userId>", "<contentLanguage>", "<phrase>", "<recording>");

myVoiceIt.voiceVerification("<userId>", "<contentLanguage>", "<phrase>", "<recording>")

{
    "message": "Successfully verified voice for 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/voice

Request Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
phrase	String	The text of a valid phrase for the developer account	True
recording	File / String	The binary audio data uploaded as a file. Our wrappers also accept the absolute path to the audio file ( we recommend a wav formatted audio file)	True

SUCC, FAIL, MISP, INCP, INPP, 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 <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "fileUrl=<fileUrl>" \
  "https://api.voiceit.io/verification/voice/byUrl"

my_voiceit.voice_verification_by_url("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.voiceVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.voiceVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.VoiceVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.voiceVerificationByUrl({
  userId : "<userId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  audioFileURL : "<fileUrl>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.VoiceVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

<?php
$myVoiceIt->voiceVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");
?>

$myVoiceIt->voiceVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.VoiceVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.voiceVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

{
    "message": "Successfully verified voice for 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/voice/byUrl

Request Parameters

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

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

Verify a User's Face

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "video=@<video>" \
  "https://api.voiceit.io/verification/face"

my_voiceit.face_verification("<userId>", "<video>")

myVoiceIt.faceVerification("<userId>", "<video>");

myVoiceIt.faceVerification("<userId>", "<video>")

myVoiceIt.FaceVerification("<userId>", "<video>")

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

myVoiceIt.FaceVerification("<userId>", "<video>");

<?php
$myVoiceIt->faceVerification("<userId>", "<video>");
?>

$myVoiceIt->faceVerification("<userId>", "<video>");

myVoiceIt.FaceVerification("<userId>", "<video>");

myVoiceIt.faceVerification("<userId>", "<video>", false)

{
    "message": "Successfully verified face for 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 ID of the user	True
video	File / String	The binary video data uploaded as a file. Our wrappers also accept the absolute path to the video file ( we recommend an mp4 formatted video)	True
doBlinkDetection	Boolean	Is set to false by default ( In order to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

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

Verify a User's Face by URL

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "fileUrl=<fileUrl>" \
  "https://api.voiceit.io/verification/face/byUrl"

my_voiceit.face_verification_by_url("<userId>", "<fileUrl>")

myVoiceIt.faceVerificationByUrl("<userId>", "<fileUrl>");

myVoiceIt.faceVerificationByUrl("<userId>", "<fileUrl>")

myVoiceIt.FaceVerificationByUrl("<userId>", "<fileUrl>")

myVoiceIt.faceVerificationByUrl({
  userId : "<userId>",
  videoFileURL : "<fileUrl>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.FaceVerificationByUrl("<userId>", "<fileUrl>");

<?php
$myVoiceIt->faceVerificationByUrl("<userId>", "<fileUrl>");
?>

$myVoiceIt->faceVerificationByUrl("<userId>", "<fileUrl>");

myVoiceIt.FaceVerificationByUrl("<userId>", "<fileUrl>");

myVoiceIt.faceVerificationByUrl("<userId>", "<fileUrl>", false)

{
    "message": "Successfully verified face for user with userId : usr_feb6d1fcd80448628db8ec6a7ddb6322",
    "status": 200,
    "faceConfidence": 94.0,
    "blinksCount": 0,
    "timeTaken": "6.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/face/byUrl

Request Parameters

Parameter	Type	Description	Required
userId	String	The ID of the user	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 ( In order to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

SUCC, FAIL, MISP, DDNE, IFVD, FTMF and FNFD
See detailed descriptions for response codes here

Verify a User's Voice & Face

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "video=@<video>" \
  "https://api.voiceit.io/verification/video"

my_voiceit.video_verification("<userId>", "<contentLanguage>", "<phrase>", "<video>")

myVoiceIt.videoVerification("<userId>", "<contentLanguage>", "<phrase>", "<video>");

myVoiceIt.videoVerification("<userId>", "<contentLanguage>", "<phrase>", "<video>")

myVoiceIt.VideoVerification("<userId>", "<contentLanguage>", "<phrase>", "<video>")

myVoiceIt.videoVerification({
  userId : "<userId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  videoFilePath : "<video>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.VideoVerification("<userId>", "<contentLanguage>", "<phrase>", "<video>");

<?php
$myVoiceIt->videoVerification("<userId>", "<contentLanguage>", "<phrase>", "<video>");
?>

$myVoiceIt->videoVerification("<userId>", "<contentLanguage>", "<phrase>", "<video>");

myVoiceIt.VideoVerification("<userId>", "<contentLanguage>", "<phrase>", "<video>", true);

myVoiceIt.videoVerification("<userId>", "<contentLanguage>", "<phrase>", "<video>")

{
    "message": "Successfully verified video 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 ID of the user	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
phrase	String	The text of a valid phrase for the developer account	True
video	File / String	The binary video data uploaded as a file. Our wrappers also accept the absolute path to the video file ( we recommend an mp4 formatted video)	True
doBlinkDetection	Boolean	Is set to false by default ( In order to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

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

Verify a User's Voice & Face by URL

curl -u <apiKey>:<apiToken> -X POST \
  -F "userId=<userId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "fileUrl=<fileUrl>" \
  "https://api.voiceit.io/verification/video/byUrl"

my_voiceit.video_verification_by_url("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.videoVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.videoVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.VideoVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.videoVerificationByUrl({
  userId : "<userId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  videoFileURL : "<fileUrl>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.VideoVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

<?php
$myVoiceIt->videoVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");
?>

$myVoiceIt->videoVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.VideoVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.videoVerificationByUrl("<userId>", "<contentLanguage>", "<phrase>", "<fileUrl>", false)

{
    "message": "Successfully verified video 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 ID of the user	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
phrase	String	The text of a valid phrase for the developer account	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 ( In order to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

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

Identification

Identify a User's Voice

curl -u <apiKey>:<apiToken> -X POST \
  -F "groupId=<groupId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "recording=@<recording>" \
  "https://api.voiceit.io/identification/voice"

my_voiceit.voice_identification("<groupId>", "<contentLanguage>", "<phrase>", "<recording>")

myVoiceIt.voiceIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<recording>");

myVoiceIt.voiceIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<recording>")

myVoiceIt.VoiceIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<recording>")

myVoiceIt.voiceIdentification({
  groupId : "<groupId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  audioFilePath : "<recording>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.VoiceIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<recording>");

<?php
$myVoiceIt->voiceIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<recording>");
?>

$myVoiceIt->voiceIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<recording>");

myVoiceIt.VoiceIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<recording>");

myVoiceIt.voiceIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<recording>")

{
    "message": "Successfully identified voice for 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/voice

Request Parameters

Parameter	Type	Description	Required
groupId	String	The ID of the group	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
phrase	String	The text of a valid phrase for the developer account	True
recording	File / String	The binary audio data uploaded as a file. Our wrappers also accept the absolute path to the audio file ( we recommend a wav formatted audio file)	True

SUCC, FAIL, MISP, INCP, INPP, 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 <apiKey>:<apiToken> -X POST \
  -F "groupId=<groupId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "fileUrl=<fileUrl>" \
  "https://api.voiceit.io/identification/voice/byUrl"

my_voiceit.voice_identification_by_url("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.voiceIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.voiceIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.VoiceIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.voiceIdentificationByUrl({
  groupId : "<groupId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  audioFileURL : "<fileUrl>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.VoiceIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

<?php
$myVoiceIt->voiceIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");
?>

$myVoiceIt->voiceIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.VoiceIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.voiceIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

{
    "message": "Successfully identified voice for 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/voice/byUrl

Request Parameters

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

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

Identify a User's Face

curl -u <apiKey>:<apiToken> -X POST \
  -F "groupId=<groupId>" \
  -F "video=@<video>" \
  "https://api.voiceit.io/identification/face"

my_voiceit.face_identification("<groupId>", "<video>")

myVoiceIt.faceIdentification("<groupId>", "<video>");

myVoiceIt.faceIdentification("<groupId>", "<video>")

myVoiceIt.FaceIdentification("<groupId>", "<video>")

myVoiceIt.faceIdentification({
  groupId : "<groupId>",
  videoFilePath : "<video>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.FaceIdentification("<groupId>", "<video>");

<?php
$myVoiceIt->faceIdentification("<groupId>", "<video>");
?>

$myVoiceIt->faceIdentification("<groupId>", "<video>");

myVoiceIt.FaceIdentification("<groupId>", "<video>");

myVoiceIt.faceIdentification("<groupId>", "<video>", false)

{
    "message": "Successfully identified face for user with userId : usr_49c98304252549239775e2b52a84006a in group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "userId": "usr_49c98304252549239775e2b52a84006a",
    "groupId": "grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "status": 200,
    "faceConfidence": 94.0,
    "blinksCount": 2,
    "timeTaken": "8.055s",
    "responseCode":"SUCC"
}

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

HTTP Request

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

Request Parameters

Parameter	Type	Description	Required
groupId	String	The ID of the group	True
video	File / String	The binary video data uploaded as a file. Our wrappers accept the absolute path to the video file ( we recommend an mp4 formatted video)	True
doBlinkDetection	Boolean	Is set to false by default ( In order to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

SUCC, FAIL, MISP, DDNE, IFVD, FTMF, FNFD and GNFD
See detailed descriptions for response codes here

Identify a User's Face by URL

curl -u <apiKey>:<apiToken> -X POST \
  -F "groupId=<groupId>" \
  -F "fileUrl=<fileUrl>" \
  "https://api.voiceit.io/identification/face/byUrl"

my_voiceit.face_identification_by_url("<groupId>", "<fileUrl>")

myVoiceIt.faceIdentificationByUrl("<groupId>", "<fileUrl>");

myVoiceIt.faceIdentificationByUrl("<groupId>", "<fileUrl>")

myVoiceIt.FaceIdentificationByUrl("<groupId>", "<fileUrl>")

myVoiceIt.faceIdentificationByUrl({
  groupId : "<groupId>",
  videoFileURL : "<fileUrl>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.FaceIdentificationByUrl("<groupId>", "<fileUrl>");

<?php
$myVoiceIt->faceIdentificationByUrl("<groupId>", "<fileUrl>");
?>

$myVoiceIt->faceIdentificationByUrl("<groupId>", "<fileUrl>");

myVoiceIt.faceIdentificationByUrl("<groupId>", "<fileUrl>");

myVoiceIt.faceIdentificationByUrl("<groupId>", "<fileUrl>", false)

{
    "message": "Successfully identified face for user with userId : usr_49c98304252549239775e2b52a84006a in group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "userId": "usr_49c98304252549239775e2b52a84006a",
    "groupId": "grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "status": 200,
    "faceConfidence": 94.0,
    "blinksCount": 2,
    "timeTaken": "8.055s",
    "responseCode":"SUCC"
}

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

HTTP Request

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

Request Parameters

Parameter	Type	Description	Required
groupId	String	The ID of the group	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 ( In order to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

SUCC, FAIL, MISP, DDNE, IFVD, FTMF, FNFD and GNFD
See detailed descriptions for response codes here

Identify a User's Voice & Face

curl -u <apiKey>:<apiToken> -X POST \
  -F "groupId=<groupId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "video=@<video>" \
  "https://api.voiceit.io/identification/video"

my_voiceit.video_identification("<groupId>", "<contentLanguage>", "<phrase>", "<video>")

myVoiceIt.videoIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<video>");

myVoiceIt.videoIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<video>")

myVoiceIt.VideoIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<video>")

myVoiceIt.videoIdentification({
  groupId : "<groupId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  videoFilePath : "<video>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.VideoIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<video>");

<?php
$myVoiceIt->videoIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<video>");
?>

$myVoiceIt->videoIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<video>");

myVoiceIt.VideoIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<video>");

myVoiceIt.videoIdentification("<groupId>", "<contentLanguage>", "<phrase>", "<video>", false)

{
    "message": "Successfully identified video for user with userId : usr_49c98304252549239775e2b52a84006a in group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "userId": "usr_49c98304252549239775e2b52a84006a",
    "groupId": "grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "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 ID of the group	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
phrase	String	The text of a valid phrase for the developer account	True
video	File / String	The binary video data uploaded as a file. Our wrappers accept the absolute path to the video file ( we recommend an mp4 formatted video)	True
doBlinkDetection	Boolean	Is set to false by default ( In order to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

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

Identify a User's Voice & Face by URL

curl -u <apiKey>:<apiToken> -X POST \
  -F "groupId=<groupId>" \
  -F "contentLanguage=<contentLanguage>" \
  -F "phrase=<phrase>" \
  -F "fileUrl=<fileUrl>" \
  "https://api.voiceit.io/identification/video/byUrl"

my_voiceit.video_identification_by_url("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.videoIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.videoIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.VideoIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>")

myVoiceIt.videoIdentificationByUrl({
  groupId : "<groupId>",
  contentLanguage : "<contentLanguage>",
  phrase : "<phrase>",
  videoFileURL : "<fileUrl>"
},(jsonResponse)=>{
  //handle response
});

myVoiceIt.VideoIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

<?php
$myVoiceIt->videoIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");
?>

$myVoiceIt->videoIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.VideoIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>");

myVoiceIt.videoIdentificationByUrl("<groupId>", "<contentLanguage>", "<phrase>", "<fileUrl>", false)

{
    "message": "Successfully identified video for user with userId : usr_49c98304252549239775e2b52a84006a in group with groupId : grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "userId": "usr_49c98304252549239775e2b52a84006a",
    "groupId": "grp_801e4d6dc1e941bf9165ba5c84bd94d2",
    "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 ID of the group	True
contentLanguage	String	Choose from a list of 88 content language parameters	True
phrase	String	The text of a valid phrase for the developer account	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 ( In order to get the blinksCount from the JSON response, set to true. This may increase the processing time of the API call )	False

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

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

Premium Languages with an upcharge($0.006)

Content Language	Language
Afrikaans (South Africa)	af-ZA
Amharic (Ethiopia)	am-ET
Arabic (United Arab Emirates)	ar-AE
Arabic (Bahrain)	ar-BH
Arabic (Algeria)	ar-DZ
Arabic (Egypt)	ar-EG
Arabic (Israel)	ar-IL
Arabic (Iraq)	ar-IQ
Arabic (Jordan)	ar-JO
Arabic (Kuwait)	ar-KW
Arabic (Lebanon)	ar-LB
Arabic (Morocco)	ar-MA
Arabic (Oman)	ar-OM
Arabic (State of Palestine)	ar-PS
Arabic (Qatar)	ar-QA
Arabic (Saudi Arabia)	ar-SA
Arabic (Tunisia)	ar-TN
Azerbaijani (Azerbaijan)	az-AZ
Bulgarian (Bulgaria)	bg-BG
Bengali (Bangladesh)	bn-BD
Bengali (India)	bn-IN
Czech (Czech Republic)	cs-CZ
Greek (Greece)	el-GR
English (Ghana)	en-GH
English (Ireland)	en-IE
English (India)	en-IN
English (Kenya)	en-KE
English (Nigeria)	en-NG
English (New Zealand)	en-NZ
English (Philippines)	en-PH
English (Tanzania)	en-TZ
English (South Africa)	en-ZA
Spanish (Argentina)	es-AR
Spanish (Bolivia)	es-BO
Spanish (Chile)	es-CL
Spanish (Colombia)	es-CO
Spanish (Costa Rica)	es-CR
Spanish (Dominican Republic)	es-DO
Spanish (Ecuador)	es-EC
Spanish (Guatemala)	es-GT
Spanish (Honduras)	es-HN
Spanish (Nicaragua)	es-NI
Spanish (Panama)	es-PA
Spanish (Peru)	es-PE
Spanish (Puerto Rico)	es-PR
Spanish (Paraguay)	es-PY
Spanish (El Salvador)	es-SV
Spanish (Uruguay)	es-UY
Spanish (Venezuela)	es-VE
Basque (Spain)	eu-ES
Persian (Iran)	fa-IR
Filipino (Philippines)	fil-PH
Galician (Spain)	gl-ES
Gujarati (India)	gu-IN
Hebrew (Israel)	he-IL
Hindi (India)	hi-IN
Croatian (Croatia)	hr-HR
Hungarian (Hungary)	hu-HU
Armenian (Armenia)	hy-AM
Indonesian (Indonesia)	id-ID
Icelandic (Iceland)	is-IS
Italian (Italy)	it-IT
Javanese (Indonesia)	jv-ID
Georgian (Georgia)	ka-GE
Khmer (Cambodia)	km-KH
Kannada (India)	kn-IN
Lao (Laos)	lo-LA
Lithuanian (Lithuania)	lt-LT
Latvian (Latvia)	lv-LV
Malayalam (India)	ml-IN
Marathi (India)	mr-IN
Malay (Malaysia)	ms-MY
Nepali (Nepal)	ne-NP
Romanian (Romania)	ro-RO
Sinhala (Sri Lanka)	si-LK
Slovak (Slovakia)	sk-SK
Slovenian (Slovenia)	sl-SI
Serbian (Serbia)	sr-RS
Sundanese (Indonesia)	su-ID
Swahili (Kenya)	sw-KE
Swahili (Tanzania)	sw-TZ
Tamil (India)	ta-IN
Tamil (Sri Lanka)	ta-LK
Tamil (Malaysia)	ta-MY
Tamil (Singapore)	ta-SG
Telugu (India)	te-IN
Thai (Thailand)	th-TH
Turkish (Turkey)	tr-TR
Ukrainian (Ukraine)	uk-UA
Urdu (India)	ur-IN
Urdu (Pakistan)	ur-PK
Vietnamese (Vietnam)	vi-VN
Chinese, Cantonese (Traditional, Hong Kong)	yue-Hant-HK
Zulu (South Africa)	zu-ZA

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
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
INCP	Incorrect contentLanguage parameter
INPP	Incorrect phrase parameter
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
PDNM	Phrase does not match
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)
FBDN	Forbidden, please make sure to only access the API via HTTPS
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.

Introduction

VoiceIt API 2.0 Technology Preview!

Authentication

Basic Authentication

Phrases

Get Phrases

HTTP Request

URL Parameters

Related Response Codes

Users

Get all Users

HTTP Request

Parameters

Related Response Codes

Create a User

HTTP Request

Parameters

Related Response Codes

Check If a Specific User Exists

HTTP Request

URL Parameters

Related Response Codes

Delete a Specific User

HTTP Request

URL Parameters

Related Response Codes

Get Groups for User

HTTP Request

URL Parameters

Related Response Codes

Groups

Get all Groups

HTTP Request

Parameters

Related Response Codes

Get a Specific Group

HTTP Request

URL Parameters

Related Response Codes

Check if Group Exists

HTTP Request

URL Parameters

Related Response Codes

Create a Group

HTTP Request

Request Parameters

Related Response Codes

Add User to Group

HTTP Request

Request Parameters

Related Response Codes

Remove User from Group

HTTP Request

Request Parameters

Related Response Codes

Delete a Specific Group

HTTP Request

URL Parameters

Related Response Codes

Enrollments

Get All Voice Enrollments

HTTP Request

URL Parameters

Related Response Codes

Get All Face Enrollments

HTTP Request

URL Parameters

Related Response Codes

Get All Video Enrollments

HTTP Request

URL Parameters

Related Response Codes

Create Voice Enrollment

HTTP Request

Request Parameters

Related Response Codes

Create Voice Enrollment by URL

HTTP Request

Request Parameters

Related Response Codes