Appendix A: Glossary
From Videntity Documentaion Wiki
The following is a list of terms used throughout the documentation. Understanding these can help you get the most out of the documentation and Videntity.
Videntity ID - (sometimes referred to as VID for short) - a 15 digit account number assigned to all users within videntity including agents, population, API, and entity accounts.
Agent Account - a business account associated with an entity. This is typically employees or people acting on behalf of the entity. If Bob works for Ruby Hospital, then Bob is an AGENT of the ENTITY Ruby Hospital.
API Account - a special type account with the privilege to create entities, agent, accounts, pop accounts, and perform other transactions. When other users act against the system they do so by using this user a a surrogate. For Unix users, you can draw a parallel between the API user and using "sudo."
Entity Account - an account class representing a group such as a hospital, government, business etc. Agent users and API users require an association with at least one entity. Population users do not require any association.
Population Account - an account class representing users under management who are not employees or acting on an entity's behalf. In a health care situation, there are the patients; in banking, customers, and so on.
Sender - the account from which the transaction is sent
Receiver - the account which receives the transaction
Subject - the account that the transaction is about (optional)
Transaction - a formatted request to perform some action. Fields may include the sender, receiver, subject, API account credentials, payload, directives to play specific audio, and other information.
Transaction ID - a unique ID generated from the server identifying the transaction.
Response - a Response from the Videntity server. Responses are returned in formatted XML according to the response schema (XSD). Responses either are returned directly from an HTTP request, reported back via a response server, or reported back through a response URL. Response status codes are either: SUCCESSFUL, PENDING, OR FAIL. When a response is PENDING, status updates are reported to a response server.
Response Server - a response server is a special daemon process that listens for response updates from the Videntity server. VSI provides Response servers as part of the service, but it is also possible to build your own.
Security Level - A number between 0-3 indicating the sensitivity of the transaction. 0.) indicates to use the account default. 1.) indicates no verification/authorization is required, 2.) Indicates verification/authorization required, and 3.) indicates highly sensitive information where verification/authorization required.
Payload - The binary object attached to the transaction. Depending on the operation, the payload may be delivered to the receiver, or may be created as part of the transaction be returned with a SUCCESSFUL response. Not all transactions, such as verify, have a payload.
