Sofar logo
Sofar logo
API
Activate email OTP POSTActivate TOTP POSTGet active 2FA methods GETSet or reset email OTP POSTInitiate email OTP challenge POSTInitiate an email address transfer POSTSet or reset TOTP POSTTime until the next email OTP may be generated GETSend a password reset email POSTComplete an email address transfer PUTTime until the next recovery code guess GETDeactivate email OTP DELETEDeactivate TOTP DELETEReset the recovery codes of a user POSTSend a password reset OTP POSTTime until the next TOTP guess GETUpdate password via OTP PUTUpdate password via sudo token PUTCheck a password reset OTP POSTComplete email OTP challenge POSTVerify a recovery code POSTVerify TOTP code POST
User
POST
/v1/auth/forgot-password

Authorization

accessBearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

origin?string

Time until the next email OTP may be generated GET

Get the minimum time until the next OTP can be sent

Complete an email address transfer PUT

Complete an account email transfer

language?string

The language which should be used for sending the email

Request Body

application/json

The email address to send the password reset link to

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.eniris.be/v1/auth/forgot-password" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
null
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Missing or misformatted query parameter or body"
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Forbidden email provider"
}
{
  "statusCode": 429,
  "error": "Too many requests",
  "message": "Last password forgot call was too recent"
}

Send a password reset email to an existing user. Wait at least 60 seconds between successive calls

In the value field below, fill in the access token. It has a 10 minutes validity period. A valid token can be obtained via the /accesstoken endpoint (call), AFTER authorization with refreshBearerAuth and the refresh token.

The mail configuration which should be used to send the email

email*string
Formatemail
Length5 <= length <= 100