Brief Introduction

From Videntity Documentaion Wiki

The Videntity API defines how to interact with the Videntity service or other Videntity server. The API allows you or your client to perform tasks such as create sessions, create user accounts, search for users, upload audio messages, generate fax forms, and most importantly send transactions. These tasks each have a URL for submission. All Videntity API communication happens over SSL/HTTPS using 2048KB encryption. Note that all API Requests are only accepted via HTTPS POST. If you send an overloaded HTTPS GET request (submitted directly to the browser's URL) will simply respond with our HTML website login page. For a more in depth look at our API POST calls and functionality please refer to the API POSTS section. All methods are invoked by sending a properly formatted HTTP post to specific method URL. For a detailed explanation of all URLs and POST parameters, please read API Methods. Afer the HTTP POST is received, Videntity will respond with XML document. (see API Responses). The response contains a status code of SUCCESSFUL, PENDING, or FAIL. If while processing Videntity finds an error, the status code will return ERROR. The XML may contain additional information on any error. Videntity can also return other HTTP error messages (e.g. 3xx,4xx, 5xx, HTTP errors). any client created must handle these errors gracefully. For a more detailed description of error handling please read the API Errors section. To use the Videntity API, you must first login and establish a session with our server. For a detailed explanation of Videntity's session handling please go to API Sessions. Before an API user can use Videntity to send transactions a user base must be created. For a detailed explanation of Videntity users please read API Users. Videntity gives you a way of customizing specific messages that are played to your user base when they receive phone calls. You can upload custom enrollment and introduction audio files for these messages. For details on uploading messages please see API Messages The main functionality of Videntity's web service is provided through transactions. For an in-depth look at generating and sending transactions please read API Transactions. We also provide an open-source Python Wrapper to make development and integration easier. Other language specific wrappers are actively in development. Check back for the release of a Java Wrapper and .NET wrapper soon.