Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/SoftwareVerse/userverse/llms.txt

Use this file to discover all available pages before exploring further.

​
Request password reset

PATCH /password-reset/request Sends a one-time PIN (OTP) to the user’s email address to begin the password reset flow. No authentication is required.

​
Request

​
email
string
required
The email address of the account for which to initiate a password reset.

​
Response

Returns a 202 Accepted response when the OTP is dispatched.
​
message
string
Human-readable status message. Example: "OTP sent to email"
​
data
null
Always null for this endpoint.

​
Error codes

CodeDescription
400Malformed or missing email address.
404No account found for the provided email.
500Internal server error.

​
Example

curl --request PATCH \
  --url 'https://api.example.com/password-reset/request?email=user%40example.com'

​
Validate OTP and reset password

PATCH /password-reset/validate-otp Validates the OTP sent to the user’s email and, if correct, updates the password to the one supplied via Basic Auth.
This endpoint uses HTTP Basic Auth. Provide the user’s email as the username and the new desired password as the password. The OTP is passed as a query parameter.

​
Request

​
Authorization
string
required
Basic Auth credentials encoded as Base64(email:new_password). The password in this header becomes the new account password if the OTP is valid.
​
one_time_pin
string
required
The OTP code received in the password reset email.

​
Response

Returns a 202 Accepted response on successful password change.
​
message
string
Human-readable status message. Example: "Password changed successfully"
​
data
null
Always null for this endpoint.

​
Error codes

CodeDescription
400OTP is invalid, does not match, or has expired.
401Missing or invalid Basic Auth credentials.
404No account found for the provided email.
500Internal server error.

​
Example

curl --request PATCH \
  --url 'https://api.example.com/password-reset/validate-otp?one_time_pin=123456' \
  --header 'Authorization: Basic dXNlckBleGFtcGxlLmNvbTpuZXdwYXNzd29yZA=='

Build docs developers (and LLMs) love

Get started for freeTalk to us