v1

latestOpenAPI 3.0.0BSD-3-Clause2026-07-146135105.7 KB

account

Create Password Recovery

Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the PUT /account/recovery endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.

post/account/recovery

Request body

emailstring required

User email.

urlstring required

URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.

Response

Token

$idstring required

Token ID.

expireinteger required

Token expiration date in Unix timestamp.

secretstring required

Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.

userIdstring required

User ID.