POST api/OTP?isWeb={isWeb}

Request Information

URI Parameters

Name	Description	Type	Additional information
isWeb		boolean	Required

Body Parameters

OTPDTO

Name	Type	Additional information
GUID	globally unique identifier	None.
Mobile	string	None.
Email	string	None.
OTP	integer	None.
OTP_Encrypted	string	None.
ExpiryInMinutes	integer	None.
ExpiryDate	date	None.
IsValidated	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "GUID": "07d6157c-4c07-40a2-a1e8-03ad5c9339db",
  "Mobile": "sample string 3",
  "Email": "sample string 4",
  "OTP": 5,
  "OTP_Encrypted": "sample string 7",
  "ExpiryInMinutes": 1,
  "ExpiryDate": "2026-11-05T12:27:41.8010589+00:00",
  "IsValidated": true
}

text/xml

Sample:

<OTPDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Timepeaker.WebApi.DTO">
  <Email>sample string 4</Email>
  <ExpiryDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-11-05T12:27:41.8010589Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ExpiryDate>
  <ExpiryInMinutes>1</ExpiryInMinutes>
  <GUID>07d6157c-4c07-40a2-a1e8-03ad5c9339db</GUID>
  <ID>1</ID>
  <IsLicenceSpecific>true</IsLicenceSpecific>
  <IsValidated>true</IsValidated>
  <LicenceKey>05a843b5-1e65-4ce5-a62f-6cf8c8331b69</LicenceKey>
  <Mobile>sample string 3</Mobile>
  <OTP>5</OTP>
  <OTP_Clear>6</OTP_Clear>
  <OTP_Encrypted>sample string 7</OTP_Encrypted>
  <ValidateConsumerEmail>true</ValidateConsumerEmail>
</OTPDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OTPResultDTO

Name	Type	Additional information
IsSuccessful	boolean	None.
IsExpired	boolean	None.
OTPObject	OTPDTO	None.
ConsumerGUID	globally unique identifier	None.
Email	string	None.
OTP_GUID	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "IsExpired": true,
  "OTPObject": {
    "GUID": "399dc5f9-09af-4611-8ae9-b8def053dfba",
    "Mobile": "sample string 3",
    "Email": "sample string 4",
    "OTP": 5,
    "OTP_Encrypted": "sample string 7",
    "ExpiryInMinutes": 1,
    "ExpiryDate": "2026-11-05T12:27:41.8010589+00:00",
    "IsValidated": true
  },
  "ConsumerGUID": "2e668ebb-5a19-4d30-baca-4ef32a44b7ab",
  "Email": "sample string 3",
  "OTP_GUID": "e9ac6c36-9456-4660-a3f1-367aab45ba64"
}

text/xml

Sample:

<OTPResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Timepeaker.WebApi.DTO">
  <ConsumerGUID>2e668ebb-5a19-4d30-baca-4ef32a44b7ab</ConsumerGUID>
  <Email>sample string 3</Email>
  <IsExpired>true</IsExpired>
  <IsSuccessful>true</IsSuccessful>
  <OTPObject>
    <Email>sample string 4</Email>
    <ExpiryDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-11-05T12:27:41.8010589Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </ExpiryDate>
    <ExpiryInMinutes>1</ExpiryInMinutes>
    <GUID>399dc5f9-09af-4611-8ae9-b8def053dfba</GUID>
    <ID>1</ID>
    <IsLicenceSpecific>true</IsLicenceSpecific>
    <IsValidated>true</IsValidated>
    <LicenceKey>42dd23f2-1c4b-4ae3-a991-db522da0b564</LicenceKey>
    <Mobile>sample string 3</Mobile>
    <OTP>5</OTP>
    <OTP_Clear>6</OTP_Clear>
    <OTP_Encrypted>sample string 7</OTP_Encrypted>
    <ValidateConsumerEmail>true</ValidateConsumerEmail>
  </OTPObject>
  <OTP_GUID>e9ac6c36-9456-4660-a3f1-367aab45ba64</OTP_GUID>
</OTPResultDTO>