eoLogin

Action Parameter eoLogin
Purpose To authenticate a user to the eCore® application
Description A successful eoLogin returns a cookie, and is required prior to using the application.
Type Granular
Preconditions None
Implementation Notes Integrated applications should call eoLogout API at the end of each API workflow event series each time the API workflow has been completed.
Integrated applications will log into an eOriginal Organization to perform actions associated with documents (i.e. Upload Document, Prepare Document for Signing, Transfer Control, etc.). The login parameters include username, organization and password. Integrated applications must be able to manage multiple sets of integration accounts (usernames, organizations and passwords) when switching between eOriginal environments.
Integrated applications may also log into multiple organizations to support the business needs of the application. To perform actions in multiple organizations, the integrated application needs to manage multiple integration accounts (usernames, organizations and passwords) in each eOriginal environment. eOriginal supports multiple concurrent logins by the same integrated application account. When performing real-time actions based on random events (button clicks, originations, etc.), integrated applications do not need to throttle the number of concurrent requests being made to the eCore service.
When performing scheduled or batch actions, integrated applications need to limit the number of concurrent logins (and subsequent actions). Examples of scheduled or batch events include, but is not limited to: retrieving documents nightly, performing a transfer of control on a list of transactions, etc. During your Professional Services or Integrated Partner project, specific guidance can be provided to the amount of threads your application will be able to use.

Parameters

Required Parameter Value Description
required loginUsername User's login name
required
One required
loginOrganization
User's organization name
businessEntityName
User's Business Enity
loginOrganizationSid
User's organization ID
required apiKey Integration user apiKey. Only required if there is no loginPassword

Response

We recommend using the most recent version of FireFox while testing API calls via your web browser. Microsoft Edge and Google Chrome require 3rd party XML extensions to display the XML response natively in your browser.