Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

169 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Test Dependabot Version License: MIT Platform VoiceIt API

A Ruby wrapper for VoiceIt's API 3.0 featuring Voice + Face Verification and Identification.

Features

This SDK wraps the full VoiceIt API 3.0 surface:

  • User management — create, fetch, check existence, and delete users; list the groups a user belongs to
  • Sub-account management — create and manage sub-accounts under a parent account
  • Group management — create, fetch, check, and delete groups; add and remove users
  • Voice, Face & Video enrollment — enroll from a local file or a remote URL (including split-video)
  • Voice, Face & Video verification — 1:1 authentication from file or URL
  • Voice & Video identification — 1:N matching of a sample against everyone in a group
  • Phrase management — list the enrollment phrases available for a content language
  • Notification webhooks — register/remove callback URLs to receive asynchronous results
  • Passive liveness & deepfake detection — performed automatically by the API on face/video calls (API 3.0)

See the HTTP API 3.0 Documentation for per-call parameters and response codes.

Installation

git clone https://github.com/voiceittech/voiceit3-ruby.git

Then require in your project:

require_relative "voiceit3-ruby/voiceit3"

Getting Started

Sign up at voiceit.io/pricing to get your API Key and Token, then log in to the Dashboard to manage your account.

API Key and Token

API Calls

You can visit our HTTP API 3.0 Documentation for detailed information on each API call.

Support

If you find this SDK useful, please consider giving it a star on GitHub — it helps others discover the project!

GitHub stars

License

voiceit3-ruby is available under the MIT license. See the LICENSE file for more info.