Credential API RequestSenderToken

This method is used to get a onetime use login token that allows the user to be placed into the Docusign sending wizard. Upon sending completion the user is returned to the return URL provided by the API application.

Schema

Name	Schema Type	Description
Email	String	Email to authenticate with. Place your bracketed integration key in front of the email if you have received one from Docusign. Example: [integration key]email
Password	String	Password to authenticate with.
EnvelopeID	String	Optional envelope ID. If provided the user will be placed into the envelope in process. If left blank the user will be placed into a new envelope for sending.
AccountID	String	Docusign account ID to map the envelope to.
ReturnURL	String	URL to send the user to upon completion of the sending process. The URL will have an event passed to it as a query parameter. The parameter will be named “event”, see “In-session sending events” below for description of the valid events. The Docusign Envelope Id will also be returned in the “envelopeId” parameter. Important: You must include `HTTPS://` in the URL or the redirect might be blocked by some browsers.

In-session sending events

Events returned on the ReturnURL as a query string parameter. The event is sent in the parameter named “event”. The ReturnURL is called with the event on any completion state of the envelope send. Valid events can be found in the schema type InSessionSendEvent in the eSignature SOAP API XSD.

Event	Description
Send	User sends the envelope.
Save	User saves a draft of the envelope.
Cancel	User cancels the sending transaction. No envelope ID returned.
Error	Error performing the send.
SessionEnd	Sending session ended before the user completed.

Rules and exceptions for RequestSenderToken

User_Does_Not_Exist_In_System – API user requesting the sending token URL does not have access to the system.
Account_Does_Not_Exist_In_System – Account is not valid.
Account_Lacks_Permissions – Account does not have valid permissions.
User_Lacks_Permissions – user does not have valid permissions.
User_Authentication_Failed – user/password is not valid.