For the complete documentation index, see llms.txt. This page is also available as Markdown.

Recovery Access

Initiates the password recovery process by sending a verification code to the user's registered email or phone number. Returns a temporary token for the next recovery step.

Endpoint

POST/v2/auth/recovery/request

Link

Request

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Content-Type

application/json

Yes

Accept

application/json

Yes

Request Body (JSON)

Field
Type
Description
Required
Example

login

string

User's email or username.

Yes

"[email protected]"

Example Request Body:

json


Response (200 OK)

Returns a temporary token to be used in the recovery confirmation step.

Response Fields

Field
Type
Description
Example

token

string

One-time token for password reset. Valid for 15 minutes.

"xyz789abc"

Example Response:

json


Error Responses

  1. User Not Found:

    json

  2. Too Many Requests:

    json


Next Steps

  1. Check Email/SMS for a 6-digit recovery code.

  2. Submit Code + Token to /v2/auth/recovery/confirm with a new password.


Notes

  • Token Validity: 15 minutes (configurable).

  • Security:

    • Codes are sent only to verified emails/phones.

    • Rate-limited to 3 attempts per hour.

  • UI Flow:

Examples

Real request

Real response

200 OK

Last updated