POST api/Signing/Account/SendForgottenPasswordEmail

Requests an an email containing a temporary password to be sent to the signer.

Request Information

URI Parameters

None.

Body Parameters

Request containing the email, username and the invitation code for the signer.

ESignSystems.SmartSAFE.Models.Signing.ForgotPasswordRequestModel
NameDescriptionTypeAdditional information
EmailAddress

Gets or sets email address of the user who requested the forgotten password.

 string

Required

Data type: EmailAddress

Matching regular expression pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]+

Max length: 256
Username

Gets or sets the user name of the user who requested the forgotten password.

 string

Required

Max length: 256
InvitationCode

Gets or sets the invitation code of the user who requested the forgotten password.

 string

Required

String length: inclusive between 6 and 60

Request Formats

application/json, text/json

Sample: 
{
  "EmailAddress": "sample string 1",
  "Username": "sample string 2",
  "InvitationCode": "sample string 3"
}

application/xml, text/xml

Sample: 
<ForgotPasswordRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
  <EmailAddress>sample string 1</EmailAddress>
  <InvitationCode>sample string 3</InvitationCode>
  <Username>sample string 2</Username>
</ForgotPasswordRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the operation.

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.