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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"channel":"String","type":0,"expirationTime":"0001-01-01T00:00:00.000Z","payload":String,"captcha":{"id":"String","sets":["String"],"optionsPerSet":0,"optionSize":0,"isExpired":true}}