POST api/auth/verify-email

Verifies a user's email address using a verification token sent to their email.

Request Information

URI Parameters

None.

Body Parameters

Verification request containing the email verification token.

VerifyEmailRequestDTO
NameDescriptionTypeAdditional information
Email

string

Required
Code

string

Required

Matching regular expression pattern: ^\d{4,10}$
DeviceIdentifier

string

Max length: 128
LegalWebsiteId

byte

None.

Request Formats

application/json, text/json

Sample: 
{
  "email": "sample string 1",
  "code": "sample string 2",
  "deviceIdentifier": "sample string 3",
  "legalWebsiteId": 64
}

application/xml, text/xml

Sample: 
<VerifyEmailRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CruiseParking.Website.API.Models">
  <Code>sample string 2</Code>
  <DeviceIdentifier>sample string 3</DeviceIdentifier>
  <Email>sample string 1</Email>
  <LegalWebsiteId>64</LegalWebsiteId>
</VerifyEmailRequestDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'VerifyEmailRequestDTO'.

Response Information

Resource Description

Success status indicating whether the email was verified successfully.

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.