Home > Aria Crescendo Documentation > Aria Crescendo core api > set_session_m


Starts an Aria session for a specified user ID. Within an Aria session, you can perform functions such as securely processing payment transactions or securely retrieving account information in registration or User Self Service applications.

For information on error messages generated by this API, see set_session_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.












Account's user ID.


Client-defined account identifier.

Note: If you pass in a <client_acct_id>, an <acct_no>, and a <user_id> Aria will use this order of precedence to decide which account to take action on:

  1. <acct_no>
  2. <user_id>
  3. <client_acct_id>
  alt_caller_id string 30 User ID given by user when creating the session.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

Output Arguments

Field Name Field Type Description
session_id string Client-assigned identifier for the application session.
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
Last modified


This page has no custom tags.


This page has no classifications.