api_auth

<back to all web services

PasswordResetRequest

The following routes are available for this service:
POST/api/password/resetCreates pending password reset request. User should follow the link sent to his email\telephone to confirm the operation.
PasswordResetRequest Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringNoEmail of account to reset password for. Either email or Telephone is required.
Telephonebodylong?NoTelephone of account to reset password for. Either email or Telephone is required.
NewPasswordbodystringNoNew password. Will not have effect until confirmed by user.
CaptchaIDbodystringNoCaptcha unique id
CaptchaSolutionbodyint[]NoSolution to the provided captcha

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

HTTP + JSV

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

POST /api/password/reset HTTP/1.1 
Host: 1.hyper.id 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: String,
	telephone: 0,
	newPassword: String,
	captchaID: String,
	captchaSolution: 
	[
		0
	]
}