api_auth

<back to all web services

ConfirmDetailRequest

The following routes are available for this service:
GET/api/confirm_infoDetailed information about confirmation request related to provided confirmation token
ConfirmDetailRequest Parameters:
NameParameterData TypeRequiredDescription
TokenquerystringNoConfirmation token
ConfirmDetail Parameters:
NameParameterData TypeRequiredDescription
ChannelformstringNoConfirmation channel type. E - email, T - telephone
TypeformshortYesConfirmation type. 1 - email confirmation, 2 - telephone confirmation, 3 - password reset confirmation
CreationTimeformDateTimeNo
ExpirationTimeformDateTime?No
PayloadformRawJsonNo
CaptchaformCaptchaNo
RawJson Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
Captcha Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
Setsformstring[]No
OptionsPerSetformintNo
OptionSizeformintNo
ExpiresformDateTimeNo
IsExpiredformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/confirm_info HTTP/1.1 
Host: 1.hyper.id 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ConfirmDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Requests">
  <Captcha xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bitpub.Api.Server.Common.Captcha">
    <d2p1:Expires>0001-01-01T00:00:00</d2p1:Expires>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:OptionSize>0</d2p1:OptionSize>
    <d2p1:OptionsPerSet>0</d2p1:OptionsPerSet>
    <d2p1:Sets xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Sets>
  </Captcha>
  <Channel>String</Channel>
  <CreationTime>0001-01-01T00:00:00</CreationTime>
  <ExpirationTime>0001-01-01T00:00:00</ExpirationTime>
  <Payload xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bitpub.Api.Common">
    <d2p1:Value>String</d2p1:Value>
  </Payload>
  <Type>0</Type>
</ConfirmDetail>