Methods

From Videntity Wiki - The API Documentation

Methods represent the core of the API.

You invoke a method via HTTP POST. To make things easy, each method has its own URL. Videntity responds with an XML formatted document indicating status such as 'SUCCESS', 'PENDING', or FAILURE'. Click on a method to learn more.

Contents 1 Method: /session/login 2 Method: /session/logout 3 Method: /session/ping 4 Method: /user/create 5 Method: /user/read 6 Method: /user/update 7 Method: /user/delete 8 Method: /associate/create 9 Method: /associate/read 10 Method: /associate/update 11 Method: /associate/delete 12 Method: /message/create 13 Method: /message/read 14 Method: /message/update 15 Method: /message/delete 16 Method: /transaction/create 17 Method: /transaction/read 18 Method: /transaction/delete 19 Method: /telephony/voice/login 20 Method: /telephony/site_key/login 21 Method: /file/create 22 Method: /file/read 23 Method: /file/delete 24 Method: /fax_form/create 25 Method: /search

Method: /session/login

Method /session/login establishes an API connection to the server and returns a session key. You must execute this command to perform any activity on the server. A session key expires after 30 minutes.

The method URL is:

https://api.videntity.com/session/login

Method: /session/logout

Method /session/logout closes the API connection to the Videntity server. The current session key is no longer valid after executing this method.

The method URL is:

https://api.videntity.com/session/logout

Method: /session/ping

Method /session/ping "pings" the Videntity server to maintain an active session key for your API calls. A session key expires after 30 minutes of no activity.

The method URL is:

https://api.videntity.com/session/ping

Method: /user/create

Method /user/create creates a user in the Videntity Server that can use Videntity's Services. User have to have a unique first name, last name, and phone number. If username is submitted it must also be unique. If username is not submitted we will automatically generate one for you using the first and last name of the subject (i.e. firstname_lastname)

https://api.videntity.com/user/create

Method: /user/read

Method /user/read reads a previously created Videntity user.

https://api.videntity.com/user/read

Method: /user/update

Method /user/update updates a previously created Videntity user.

https://api.videntity.com/user/update

Method: /user/delete

Method /user/delete deletes a previously created Videntity user.

https://api.videntity.com//user/delete

Method: /associate/create

Method /associate/create creates an association between two Videntity users.

https://api.videntity.com/associate/create

Method: /associate/read

Method /user/read reads a specific Videntity user's association information.

https://api.videntity.com/session/update

Method: /associate/update

Method /associate/update updates a Videntity user's association.

https://api.videntity.com/associate/update

Method: /associate/delete

Method /associate/delete deletes an association between two Videntity users.

https://api.videntity.com/associate/delete

Method: /message/create

Method /message/create creates a message that can be used by the Videntity Server. Currently all recorded audio messages must be either in .wav or .gsm format and be sampled at 8000HZ.

https://api.videntity.com/message/create

Method: /message/read

Method /message/read reads a previously uploaded message from the Videntity Server.

https://api.videntity.com/message/read

Method: /message/update

Method /message/update updates a previously uploaded message on the Videntity Server.

https://api.videntity.com/message/update

Method: /message/delete

Method /message/delete deletes a previously uploaded message on the Videntity Server.

https://api.videntity.com/message/delete

Method: /transaction/create

Method /transaction/create is the primary method used for sending all transactions to the system. It is the workhorse of Videntity. There are a variety of Types or Transactions (TOT) you can send to the server. Each TOT has its own defined input requirements and response.

The method URL is:

https://api.videntity.com/transaction/create

Method: /transaction/read

Method /transaction/read reads a previously created transaction from the Videntity Server. This method can be used to check the status of transactions that have not been returned in a response.

https://api.videntity.com/transaction/read

Method: /transaction/delete

Method /transaction/delete deletes a previously created transaction from the Videntity Server. Once a transaction has been deleted it will no longer be sent out (i.e trigger phone calls)

https://api.videntity.com/transaction/delete

Method: /telephony/voice/login

Method /telephony/voice/login initiates a phone call to verify the users voice and pin.

https://api.videntity.com/telephony/voice/login

Method: /telephony/site_key/login

Method /telephony/site_key/login generates a six character one time password and sends it via SMS (mobile text message) to a user's phone (by phone call or text message) and is returned in the response. Since the requesting site and the user both know the site key, the key can then be entered in by the user as an extra layer of authentication. To generate the site key you must send the Videntiy Server the users account number and pin. Thus, this login method combines something the 'user knows' (users pin and account number) and something the 'user poses' (the phone) to get the site key.

https://api.videntity.com/telephony/site_key/login

Method: /file/create

Method /file/create uploads a file object to the Videntity Server.

https://api.videntity.com/file/create

Method: /file/read

Method /file/reads a previously file object to the Videntity Server.

https://api.videntity.com/file/read

Method: /file/delete

Method /file/delete deletes a file object to the Videntity Server.

https://api.videntity.com/file/delete

Method: /fax_form/create

Method /fax_form/create generates a fax form that can be sent too the Videntity fax server number to be processed automatically just like and other file transaction. The difference is that the information is converted into PDF.

https://api.videntity.com/fax_form/create

It returns a simple xml document like so:

<?xml version="1.0" encoding="utf-8"?>
<faxcover>
	<url>https://videntityfaxform.s3.amazonaws.com/5b455470-a0cd-43ce-9be2-fda0576f918a.pdf</url>
</faxcover>

Here is a snip it examples that shows how to call this method through Curl.

curl -d "fax_pages=001&sender_account_number=141073427605443&receiver_account_number=141073427605443&subject_account_number=141073427605443&security_level=1&subject_cc=1&receiver_verify=1&sender_verify=1" https://api.videntity.com/fax_form/create

Method: /search

Method /search looks up a videntity users by name or phone nubmer and returns the account number

https://api.videntity.com/session/update