<commit_before><img src="https://raw.githubusercontent.com/voiceittech/VoiceItApi2IosSDK/master/Graphics/VoiceItAPI2ioSSDKHeaderImage.png" width="100%" style="width:100%">

[![Version](https://img.shields.io/cocoapods/v/VoiceItApi2IosSDK.svg?style=flat)](http://cocoapods.org/pods/VoiceItApi2IosSDK)
[![Build Status](https://travis-ci.org/voiceittech/VoiceItApi2IosSDK.svg?branch=master)](https://travis-ci.org/voiceittech/VoiceItApi2IosSDK)
![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)
[![Platform](https://img.shields.io/cocoapods/p/VoiceItApi2IosSDK.svg?style=flat)](http://cocoapods.org/pods/VoiceItApi2IosSDK)

A fully comprehensive SDK that gives you access to VoiceIt's API 2.0 featuring Voice + Face Verification and Identification with built in user interfaces and liveness detection.

* [Getting Started](#getting-started)
* [Previews](#previews)
* [Installation](#installation)
* [Strings and Prompts](#strings-and-prompts)
* [API Calls](#api-calls)
  * [Initialization](#initialization)
  * [Encapsulated Methods](#encapsulates-methods)
      * [Encapsulated Voice Enrollment](#encapsulated-voice-enrollment)
      * [Encapsulated Face Enrollment](#encapsulated-face-enrollment)
      * [Encapsulated Video Enrollment](#encapsulated-video-enrollment)
      * [Encapsulated Voice Verification](#encapsulated-voice-verification)
      * [Encapsulated Face Verification](#encapsulated-face-verification)
      * [Encapsulated Video Verification](#encapsulated-video-verification)
      * [Encapsulated Voice Identification](#encapsulated-voice-identification)
      * [Encapsulated Face Identification](#encapsulated-face-identification)
      * [Encapsulated Video Identification](#encapsulated-video-identification)
  * [User API Calls](#user-api-calls)
      * [Get All Users](#get-all-users)
      * [Create User](#create-user)
      * [Check User Exists](#check-if-specific-user-exists)
      * [Get Groups for User](#get-groups-for-user)
      * [Delete User](#delete-a-specific-user)
  * [Group API Calls](#group-api-calls)
      * [Get All Groups](#get-all-groups)
      * [Get Group](#get-a-specific-group)
      * [Group exists](#check-if-group-exists)
      * [Create Group](#create-group)
      * [Add User to Group](#add-user-to-group)
      * [Remove User from Group](#remove-user-from-group)     
      * [Delete Group](#delete-group)
  * [Enrollment API Calls](#enrollment-api-calls)
      * [Get All Voice Enrollments](#get-all-voice-enrollments)
      * [Get All Face Enrollments](#get-all-face-enrollments)
      * [Get All Video Enrollments](#get-all-video-enrollments)
      * [Create Voice Enrollment](#create-voice-enrollment)
      * [Create Face Enrollment](#create-face-enrollment)
      * [Create Video Enrollment](#create-video-enrollment)
      * [Delete Voice Enrollment](#delete-voice-enrollment)
      * [Delete Face Enrollment](#delete-face-enrollment)
      * [Delete Video Enrollment](#delete-video-enrollment)
      * [Delete All Voice Enrollments](#delete-all-voice-enrollments)
      * [Delete All Face Enrollments](#delete-all-face-enrollments)
      * [Delete All Video Enrollments](#delete-all-video-enrollments)
  * [Verification API Calls](#verification-api-calls)
      * [Voice Verification](#voice-verification)
      * [Face Verification](#face-verification)
      * [Video Verification](#video-verification)
  * [Identification API Calls](#identification-api-calls)
      * [Voice Identification](#voice-identification)
      * [Video Identification](#video-identification)

## Getting Started

Get a Developer Account at <a href="https://voiceit.io/signup" target="_blank">VoiceIt</a> and view your API Key and Token in the settings page (as shown below). Also review the HTTP Documentation at <a href="https://api.voiceit.io" target="_blank">api.voiceit.io</a>. All the documentation shows code snippets in both Swift 4 and Objective-C.

<img src="Graphics/Settings.png" alt="View API Key and Token on Settings Page" width="600px" />

## Previews

Method | Preview
--- | ---
Encapsulated Video Enrollment | <img width="320px" src="Graphics/VideoEnrollment.gif" />
Encapsulated Video Verification | <img width="320px" src="Graphics/VideoVerification.gif" /><commit_msg>update README.md [skip ci]<commit_after><img src="https://raw.githubusercontent.com/voiceittech/VoiceItApi2IosSDK/master/Graphics/VoiceItAPI2ioSSDKHeaderImage.png" width="100%" style="width:100%">

[![Version](https://img.shields.io/cocoapods/v/VoiceItApi2IosSDK.svg?style=flat)](http://cocoapods.org/pods/VoiceItApi2IosSDK)
[![Build Status](https://travis-ci.org/voiceittech/VoiceItApi2IosSDK.svg?branch=master)](https://travis-ci.org/voiceittech/VoiceItApi2IosSDK)
![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)
[![Platform](https://img.shields.io/cocoapods/p/VoiceItApi2IosSDK.svg?style=flat)](http://cocoapods.org/pods/VoiceItApi2IosSDK)

A fully comprehensive SDK that gives you access to VoiceIt's API 2.0 featuring Voice + Face Verification and Identification with built in user interfaces and liveness detection.

## Table of Contents

* [Getting Started](#getting-started)
* [Previews](#previews)
* [Installation](#installation)
* [Strings and Prompts](#strings-and-prompts)
* [API Calls](#api-calls)
  * [Initialization](#initialization)
  * [Encapsulated Methods](#encapsulates-methods)
      * [Encapsulated Voice Enrollment](#encapsulated-voice-enrollment)
      * [Encapsulated Face Enrollment](#encapsulated-face-enrollment)
      * [Encapsulated Video Enrollment](#encapsulated-video-enrollment)
      * [Encapsulated Voice Verification](#encapsulated-voice-verification)
      * [Encapsulated Face Verification](#encapsulated-face-verification)
      * [Encapsulated Video Verification](#encapsulated-video-verification)
      * [Encapsulated Voice Identification](#encapsulated-voice-identification)
      * [Encapsulated Face Identification](#encapsulated-face-identification)
      * [Encapsulated Video Identification](#encapsulated-video-identification)
  * [User API Calls](#user-api-calls)
      * [Get All Users](#get-all-users)
      * [Create User](#create-user)
      * [Check User Exists](#check-if-specific-user-exists)
      * [Get Groups for User](#get-groups-for-user)
      * [Delete User](#delete-a-specific-user)
  * [Group API Calls](#group-api-calls)
      * [Get All Groups](#get-all-groups)
      * [Get Group](#get-a-specific-group)
      * [Group exists](#check-if-group-exists)
      * [Create Group](#create-group)
      * [Add User to Group](#add-user-to-group)
      * [Remove User from Group](#remove-user-from-group)     
      * [Delete Group](#delete-group)
  * [Enrollment API Calls](#enrollment-api-calls)
      * [Get All Voice Enrollments](#get-all-voice-enrollments)
      * [Get All Face Enrollments](#get-all-face-enrollments)
      * [Get All Video Enrollments](#get-all-video-enrollments)
      * [Create Voice Enrollment](#create-voice-enrollment)
      * [Create Face Enrollment](#create-face-enrollment)
      * [Create Video Enrollment](#create-video-enrollment)
      * [Delete Voice Enrollment](#delete-voice-enrollment)
      * [Delete Face Enrollment](#delete-face-enrollment)
      * [Delete Video Enrollment](#delete-video-enrollment)
      * [Delete All Voice Enrollments](#delete-all-voice-enrollments)
      * [Delete All Face Enrollments](#delete-all-face-enrollments)
      * [Delete All Video Enrollments](#delete-all-video-enrollments)
  * [Verification API Calls](#verification-api-calls)
      * [Voice Verification](#voice-verification)
      * [Face Verification](#face-verification)
      * [Video Verification](#video-verification)
  * [Identification API Calls](#identification-api-calls)
      * [Voice Identification](#voice-identification)
      * [Video Identification](#video-identification)

## Getting Started

Get a Developer Account at <a href="https://voiceit.io/signup" target="_blank">VoiceIt</a> and view your API Key and Token in the settings page (as shown below). Also review the HTTP Documentation at <a href="https://api.voiceit.io" target="_blank">api.voiceit.io</a>. All the documentation shows code snippets in both Swift 4 and Objective-C.

<img src="Graphics/Settings.png" alt="View API Key and Token on Settings Page" width="600px" />

## Previews

Encapsulated Video Enrollment | Encapsulated Video Verification
--- | ---
<img width="320px" src="Graphics/VideoEnrollment.gif" /> | <img width="320px" src="Graphics/VideoVerification.gif" />
{'fraction_non_alphanumeric': 0.14406381980290944, 'fraction_numerical': 0.006100422336931018, 'mean_word_length': 4.664451827242525, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 16, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '549969', 'n_tokens_mistral': 2808, 'n_tokens_neox': 2641, 'n_words': 494}