Users

From Videntity Wiki - The API Documentation

Videntity API users will have to create their own user base for use with Videntity's web services. Their are two main types of users that Videntity recognizes: ENT and POP. POP user types are the general public population. Examples of this user type would be a patient in a patient provider scenario (i.e Mr. John Doe). Whereas, ENT are physical entities such as a hospital or a buisness.

Creating a User

Request: Creating a User

To create a user send a form POST to the User Create method

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

with your user data as the form POST fields. All user is optional unless specified as required.

Session Data

session_key (required): key to your current session. Your session key is given to you in response to your login request.

Personal Information

user_type: type of Videntity user POP or ENT. If user_type is not specified it defaults to POP

POP = population ~ general public population (i.e. Mr. John Doe).

ENT = entity ~ physical entity (i.e Your Hospital)

first_name (required): first name of the user

last_name (required): last_name of the user

email: email address of the user (i.e. john_doe@videntity.com)

title_prefix: title_prefix of the user (i.e. Dr., Mr., Ms., Mrs., Miss)

middle1_name: first middle name of the user

middle2_name: second middle name of the user

title_suffix: title_suffix of the user (i.e. Jr.)

credential: credential of the user (i.e. M.D.)

birthdate: birthdate of the user in mmddyyyy format

Address Info

entity_name (required for user_type = 'ENT'): Name of the entity

address1: first address line of the user (i.e. 1234 High St.)

address2: second address line (i.e. 2nd floor)

address3: third address line (i.e. Apartment 21)

city: user's city

state: user's state

zip_code: zip code of the user in XXXXX or XXXXX-XXXX format

Phone Numbers

phone_system_number (required): user's main phone number in XXX-XXX-XXXX format (i.e. 304-291-2480)

sms_system_number: user's main text message number in XXX-XXX-XXXX format (i.e. 304-291-2480)

home_phone_number: user's alternate home phone number in XXX-XXX-XXXX format (i.e. 304-291-2480). This number will only be used if automated_phone_number repeatedly fails.

mobile_phone_number: user's alternate mobile phone number in XXX-XXX-XXXX format (i.e. 304-291-2480). This number will only be used if automated_phone_number repeatedly fails.

work_phone_number: user's alternate work phone number in XXX-XXX-XXXX format (i.e. 304-291-2480). This number will only be used if automated_phone_number repeatedly fails.

alternate_phone_number: user's alternate phone number in XXX-XXX-XXXX format (i.e. 304-291-2480). This number will only be used if automated_phone_number repeatedly fails.

fax_number: user's main fax number in XXX-XXX-XXXX format (i.e. 304-291-2480)

Authentication

username: user specified username

pin: 4 digit pin number

url: user authentication url

password: user specified password

Transaction Preferences

timezone: user's current timezone

tx_start_time: user's start time to receive transactions in HH:MM:SS format

tx_stop_time: user's stop time to receive transactions in HH:MM:SS format

URL encoded

credential=&first_name=John&last_name=Doe&home_phone_number=&alternate_phone_number=&session_key=3U3oCoGptjgMznt&user_type=POP
&birthdate=02262000&agent_entity=&mobile_phone_number=&work_phone_number=&middle2_name=&title_suffix=&automated_phone_number=
1-304-291-2480&title_prefix=Mr.&middle1_name=Christopher&sms_number=304-291-2480&email=cboyce%40videntity.com&fax_number=&zip_code=26505

For more information on the create user method please see the User Create method URL section.

Response: Creating a User

Once your create user request is submitted the Videntity server will check the form field data for errors ( see the User Create method for errors). If no errors are found the server will then insert the user into our database and return with a response of the users first name, last name, and newly generated account number

  <?xml version="1.0" encoding="utf-8"?>
  <response api_method="/user/create">
       <status>STATUS</status>
       <api_tx_number>TRANSACTION_NUMBER</api_tx_number>
       <detail>DETAILS</detail>
       <response_name_value>
           <first_name>FIRST_NAME</first_name> 
	     <last_name>LAST_NAME</last_name> 
	     <account_number>ACCOUNT_NUMBER</account_number>
       </response_name_value>
       <timestamp>TIMESTAMP</timestamp>
  </response>

under the response_name_value element of the XML schema.

User Types

Currently there are only two user types that the Videntity servers recognize. The POP user type

POP: This is the user type of the general population

and the ENT user type

ENT: This is the user type of an entity (i.e. Business, Hospital)

User Data Formats

When calling the create_user method URL, some user form fields have a specific format. This is a listing of each format that is required for a specific field. If the form field is not listed hear it means that the form field input does not matter.

user_type

user type must be either ENT or POP

ENT = entity ~ business or organizations (i.e Your Hospital)

POP = population ~ general public population (i.e. Mr. John Doe)

birthdate

birthdate of the user in mmddyyyy format (i.e 02261982 would be February 26,1982)

zip_code

zip code of the user in XXXXX or XXXXX-XXXX format (i.e 26508 or 26508-1234)

title_prefix

title_prefix must be Dr., Mr., Ms., Mrs., or Miss (note the periods)