Starts a signing session that was created previously by providing a signing session ID.

Notes about Start Session call when dealing with Anchor Tags:

  • Start session checks the status of the session to see if everything (signers, tags etc…) are ready to start the session, and it will correctly return validation errors if it runs into any issues.
  • There could be a timing issue between calling Create Session and Start Session, so if you get this error you might want to attempt calling Start Session in a couple of seconds again or schedule the Start Session to run after a couple of seconds from calling Create Session. But, if the validation errors persist, then this is a permanent issue that you need to review as instructed by the validation message(s).

URI PUT rest/v1/sessions/{signingSessionId}/start?returnUrl={returnUrl}

Returns – A RequestResponse containing a string (“True” or “False”) representation of a Boolean indicating whether or not the call was a success or failure in the ReturnValue.  (See RequestResponse in Appendix B)


Name Type Description
encryptedToken string Required. Encrypted Token returned from client authentication.
Returns null if token has expired or is invalid.
signingSessionId string Required. The ID of the signing session to start.
returnURL string Required. Your Host URL.

Example – C#

string uri = “rest/v1/sessions/{0}/start?returnURL={1}”;
string responseString = string.Empty;
JavaScriptSerializer jss = new JavaScriptSerializer();
RequestResponse requestResponse;

uri = string.Format(uri, signingSessionId, returnURL);
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(host + uri);
request.Headers.Add(“Authorization” , encryptedToken);
request.ContentLength = 0;
request.Method = “PUT”;
request.ContentType = “application/json”;

HttpWebResponse response = (HttpWebResponse)request.GetResponse();
responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
requestResponse = jss.Deserialize<RequestResponse>(responseString);