NAV Navbar
shell python
  • Introduction
  • Authentication
  • Users
  • Groups
  • Enrollments
  • Verification
  • Identification
  • Content Languages
  • Response Codes
  • Errors
  • Introduction

    VoiceIt API 2.0 Technology Preview!

    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 in shell and python, and you can switch the programming language of the examples with the tabs in the top right.

    Authentication

    To authorize, use this code:

    # 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/users"
    
    # Make sure you have requests installed (http://www.python-requests.org/en/latest/user/install)
    import requests
    
    # This credentials variable will be referenced in all the other Python code snippets
    voiceit_basic_auth_credentials = ('API_KEY_HERE', 'API_TOKEN_HERE')
    response = requests.get('https://api.voiceit.io/users', auth = voiceit_basic_auth_credentials)
    print response.json()
    

    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"
    
    import requests
    
    response = requests.get('https://api.voiceit.io/users', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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.

    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"
    
    import requests
    
    response = requests.post('https://api.voiceit.io/users', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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/<userId>

    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

    Check If a Specific User Exists

    curl -u API_KEY_HERE:API_TOKEN_HERE "https://api.voiceit.io/users/usr_feb6d1fcd80448628db8ec6a7ddb6322"
    
    import requests
    
    response = requests.get('https://api.voiceit.io/users/usr_feb6d1fcd80448628db8ec6a7ddb6322', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    response = requests.delete('https://api.voiceit.io/users/usr_feb6d1fcd80448628db8ec6a7ddb6322', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    response = requests.get('https://api.voiceit.io/users/usr_feb6d1fcd80448628db8ec6a7ddb6322/groups', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    response = requests.get('https://api.voiceit.io/groups', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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.

    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"
    
    import requests
    
    response = requests.get('https://api.voiceit.io/groups/grp_4225f88a571f4bd790b51a91109bab88', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    response = requests.get('https://api.voiceit.io/groups/grp_4225f88a571f4bd790b51a91109bab88/exists', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    dataObj = {}
    dataObj['description'] = 'Family'
    response = requests.post('https://api.voiceit.io/groups', auth=voiceit_basic_auth_credentials, data = dataObj)
    print response.json()
    

    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

    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"
    
    import requests
    dataObj = {}
    dataObj['groupId'] = 'grp_801e4d6dc1e941bf9165ba5c84bd94d2'
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    response = requests.put('https://api.voiceit.io/groups/addUser', auth=voiceit_basic_auth_credentials, data=dataObj)
    print response.json()
    

    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

    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"
    
    import requests
    dataObj = {}
    dataObj['groupId'] = 'grp_801e4d6dc1e941bf9165ba5c84bd94d2'
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    response = requests.put('https://api.voiceit.io/groups/removeUser', auth=voiceit_basic_auth_credentials, data=dataObj)
    print response.json()
    

    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

    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"
    
    import requests
    
    response = requests.delete('https://api.voiceit.io/groups/grp_801e4d6dc1e941bf9165ba5c84bd94d2', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    response = requests.get('https://api.voiceit.io/enrollments/usr_feb6d1fcd80448628db8ec6a7ddb6322', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    response = requests.get('https://api.voiceit.io/enrollments/face/usr_feb6d1fcd80448628db8ec6a7ddb6322', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    voiceFilePath = '/Users/username/voices/enrollment.wav'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    dataObj['contentLanguage'] = 'en-US'
    filesObj = [('recording', ('enrollment.wav', open(voiceFilePath, 'rb'), 'audio/wav'))]
    response = requests.post('https://api.voiceit.io/enrollments', auth=voiceit_basic_auth_credentials, data=dataObj, files=filesObj)
    print response.json()
    

    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

    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"
    
    import requests
    
    voiceFileURL = 'https://voiceit.io/enrollment.wav'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    dataObj['fileUrl'] = voiceFileURL
    response = requests.post('https://api.voiceit.io/enrollments', auth=voiceit_basic_auth_credentials, data=dataObj)
    print response.json()
    

    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

    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"
    
    import requests
    
    videoFilePath = '/Users/username/videos/video.mp4'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    filesObj = [('video', ('video.mp4', open(videoFilePath, 'rb'), 'video/mp4'))]
    response = requests.post('https://api.voiceit.io/enrollments/face', auth=voiceit_basic_auth_credentials, data=dataObj, files=filesObj)
    print response.json()
    

    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 true by default ( to remove blinksCount from the JSON response, set to false, this could also speed up the API call ) True

    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"
    
    import requests
    
    videoFilePath = '/Users/username/videos/video.mp4'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    dataObj['doBlinkDetection'] = False
    dataObj['contentLanguage'] = 'en-US'
    filesObj = [('video', ('video.mp4', open(videoFilePath, 'rb'), 'video/mp4'))]
    response = requests.post('https://api.voiceit.io/enrollments/video', auth=voiceit_basic_auth_credentials, data=dataObj, files=filesObj)
    print response.json()
    

    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 true by default ( to remove blinksCount from the JSON response, set to false, this could also speed up the API call ) True

    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"
    
    import requests
    
    videoFileURL = '/Users/username/videos/video.mp4'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    dataObj['contentLanguage'] = 'en-US'
    dataObj['fileUrl'] = 'https://voiceit.io/video.mp4'
    response = requests.post('https://api.voiceit.io/enrollments/video/byUrl', auth=voiceit_basic_auth_credentials, data=dataObj)
    print response.json()
    

    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 true by default ( to remove blinksCount from the JSON response, set to false, this could also speed up the API call ) False

    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"
    
    import requests
    
    response = requests.delete('https://api.voiceit.io/enrollments/face/usr_feb6d1fcd80448628db8ec6a7ddb6322/35', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    response = requests.delete('https://api.voiceit.io/enrollments/usr_feb6d1fcd80448628db8ec6a7ddb6322/35', auth=voiceit_basic_auth_credentials)
    print response.json()
    

    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

    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"
    
    import requests
    
    voiceFilePath = '/Users/username/voices/verification.wav'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    dataObj['contentLanguage'] = 'en-US'
    filesObj = [('recording', ('verification.wav', open(voiceFilePath, 'rb'), 'audio/wav'))]
    response = requests.post('https://api.voiceit.io/verification', auth=voiceit_basic_auth_credentials, data=dataObj, files=filesObj)
    print response.json()
    
    > The above command returns JSON structured like this:
    
    ```json
    {
        "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 previous enrollments 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

    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"
    
    import requests
    
    voiceFilePath = '/Users/username/voices/verification.wav'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    dataObj['contentLanguage'] = 'en-US'
    dataObj['fileUrl'] = 'https://voiceit.io/verification.wav'
    response = requests.post('https://api.voiceit.io/verification/byUrl', auth=voiceit_basic_auth_credentials, data=dataObj)
    print response.json()
    

    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 previous enrollments 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

    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"
    
    import requests
    
    videoFilePath = '/Users/username/videos/video.mp4'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    filesObj = [('video', ('video.mp4', open(videoFilePath, 'rb'), 'video/mp4'))]
    response = requests.post('https://api.voiceit.io/verification/face', auth=voiceit_basic_auth_credentials, data=dataObj, files=filesObj)
    print response.json()
    

    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 true by default ( to remove blinksCount from the JSON response, set to false, this could also speed up the API call ) False

    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"
    
    import requests
    
    videoFilePath = '/Users/username/videos/video.mp4'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    dataObj['contentLanguage'] = 'en-US'
    filesObj = [('video', ('video.mp4', open(videoFilePath, 'rb'), 'video/mp4'))]
    response = requests.post('https://api.voiceit.io/verification/video', auth=voiceit_basic_auth_credentials, data=dataObj, files=filesObj)
    print response.json()
    

    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 previous enrollments 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 true by default ( to remove blinksCount from the JSON response, set to false, this could also speed up the API call ) False

    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"
    
    import requests
    
    videoFileURL = 'https://voiceit.io/video.mp4'
    dataObj = {}
    dataObj['userId'] = 'usr_feb6d1fcd80448628db8ec6a7ddb6322'
    dataObj['contentLanguage'] = 'en-US'
    dataObj['fileUrl'] = videoFileURL
    response = requests.post('https://api.voiceit.io/verification/video', auth=voiceit_basic_auth_credentials, data=dataObj)
    print response.json()
    

    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 previous enrollments 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 true by default ( to remove blinksCount from the JSON response, set to false, this could also speed up the API call ) False

    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"
    
    import requests
    
    voiceFilePath = '/Users/username/voices/identification.wav'
    dataObj = {}
    dataObj['groupId'] = 'grp_801e4d6dc1e941bf9165ba5c84bd94d2'
    dataObj['contentLanguage'] = 'en-US'
    filesObj = [('recording', ('identification.wav', open(voiceFilePath, 'rb'), 'audio/wav'))]
    response = requests.post('https://api.voiceit.io/identification', auth=voiceit_basic_auth_credentials, data=dataObj, files=filesObj)
    print response.json()
    
    > The above command returns JSON structured like this:
    
    ```json
    {
        "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

    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"
    
    import requests
    
    voiceFileURL = 'https://voiceit.io/identification.wav'
    dataObj = {}
    dataObj['groupId'] = 'grp_801e4d6dc1e941bf9165ba5c84bd94d2'
    dataObj['contentLanguage'] = 'en-US'
    dataObj['fileUrl'] = voiceFileURL
    response = requests.post('https://api.voiceit.io/identification/byUrl', auth=voiceit_basic_auth_credentials, data=dataObj)
    print response.json()
    
    > The above command returns JSON structured like this:
    
    ```json
    {
        "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

    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"
    
    import requests
    
    videoFilePath = '/Users/username/videos/video.mp4'
    dataObj = {}
    dataObj['groupId'] = 'grp_801e4d6dc1e941bf9165ba5c84bd94d2'
    dataObj['contentLanguage'] = 'en-US'
    filesObj = [('video', ('video.mp4', open(videoFilePath, 'rb'), 'video/mp4'))]
    response = requests.post('https://api.voiceit.io/identification/video', auth=voiceit_basic_auth_credentials, data=dataObj, files=filesObj)
    print response.json()
    

    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 true by default ( to remove blinksCount from the JSON response, set to false, this could also speed up the API call ) False

    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"
    
    import requests
    
    videoFileURL = 'https://voiceit.io/video.mp4'
    dataObj = {}
    dataObj['groupId'] = 'grp_801e4d6dc1e941bf9165ba5c84bd94d2'
    dataObj['contentLanguage'] = 'en-US'
    dataObj['fileUrl'] = videoFileURL
    response = requests.post('https://api.voiceit.io/identification/video', auth=voiceit_basic_auth_credentials, data=dataObj)
    print response.json()
    

    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 true by default ( to remove blinksCount from the JSON response, set to false, this could also speed up the API call ) False

    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:

    Content Language Language
    af-ZA Afrikaans (South Africa)
    id-ID Indonesian (Indonesia)
    ms-MY Malay (Malaysia)
    ca-ES Catalan (Spain)
    cs-CZ Czech (Czech Republic)
    da-DK Danish (Denmark)
    de-DE German (Germany)
    en-AU English (Australia)
    en-CA English (Canada)
    en-GB English (United Kingdom)
    en-IN English (India)
    en-IE English (Ireland)
    en-NZ English (New Zealand)
    en-PH English (Philippines)
    en-ZA English (South Africa)
    en-US English (United States)
    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-ES Spanish (Spain)
    es-US Spanish (United States)
    es-GT Spanish (Guatemala)
    es-HN Spanish (Honduras)
    es-MX Spanish (Mexico)
    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)
    fil-PH Filipino (Philippines)
    fr-FR French (France)
    gl-ES Galician (Spain)
    hr-HR Croatian (Croatia)
    zu-ZA Zulu (South Africa)
    is-IS Icelandic (Iceland)
    it-IT Italian (Italy)
    lt-LT Lithuanian (Lithuania)
    hu-HU Hungarian (Hungary)
    nl-NL Dutch (Netherlands)
    nb-NO Norwegian Bokmal (Norway)
    pl-PL Polish (Poland)
    pt-BR Portuguese (Brazil)
    pt-PT Portuguese (Portugal)
    ro-RO Romanian (Romania)
    sk-SK Slovak (Slovakia)
    sl-SI Slovenian (Slovenia)
    fi-FI Finnish (Finland)
    sv-SE Swedish (Sweden)
    vi-VN Vietnamese (Vietnam)
    tr-TR Turkish (Turkey)
    el-GR Greek (Greece)
    bg-BG Bulgarian (Bulgaria)
    ru-RU Russian (Russia)
    sr-RS Serbian (Serbia)
    uk-UA Ukrainian (Ukraine)
    he-IL Hebrew (Israel)
    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)
    fa-IR Persian (Iran)
    hi-IN Hindi (India)
    th-TH Thai (Thailand)
    ko-KR Korean (South Korea)
    cmn-Hant-TW Chinese, Mandarin (Traditional, Taiwan)
    yue-Hant-HK Chinese, Cantonese (Traditional, Hong Kong)
    ja-JP Japanese (Japan)
    cmn-Hans-HK Chinese, Mandarin (Simplified, Hong Kong)
    cmn-Hans-CN Chinese, Mandarin (Simplified, China)

    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)

    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.