Initiate password reset process

POST

/api/v2/auth/forgot-password

Sends a password reset token to user's email or phone number

Request

Body Params application/json

Examples

Responses

🟢201Created

application/json

Password reset initiated successfully

Body

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v2/auth/forgot-password' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "user@example.com or +1234567890"
}'

Response Example

201 - Example 1

{
    "data": {
        "username": "string",
        "expires_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-01-14 11:09:15

Authenticate user