post
https://{host}/auth/v1/web/password/forget
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Resource Information
| URI for Mobile App | auth/v1/password/forget |
| URI for Web App | auth/v1/web/password/forget |
| Rate Limit | Demo and testing clusters: 1000 requests per minute per API key. Other organizations: Rate limit is brand-specific. |
| Authentication | Not required |
| HTTP Method | POST |
| Batch Support | No |
Request URL
For mobile application:
http://{ae-host}/auth/v1/password/forget
For web application:
http://{ae-host}/auth/v1/web/password/forget
Example request
curl --location 'https://eu.api.capillarytech.com/auth/v1/password/forget' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data '{
"identifierType": "MOBILE",
"identifierValue": "919999922332",
"password": "QWERTY12345",
"confirmPassword": "QWERTY12345",
"brand": "DocDemo",
"deviceId": "123456785",
"sessionId": "P-d13b591a-b4ff-4b8d-ab0b-20be09b3272e"
}'curl --location 'https://eu.api.capillarytech.com/auth/v1/web/password/forget' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data '{
"identifierType": "MOBILE",
"identifierValue": "919999922332",
"password": "QWERTY12345",
"confirmPassword": "QWERTY12345",
"brand": "DocDemo",
"deviceId": "123456785",
"sessionId": "P-0b18c430-ed15-461c-8315-8c745f1f4ff2"
}'| Parameter | Datatype | Description |
|---|---|---|
| identifierType* | enum | Values: MOBILE, EMAIL, USERNAME. |
| identifierValue* | string | Value of the specified identifierType. For example, if identifierType is MOBILE, the identifierValue is a mobile number. |
| deviceId** | string | Unique ID of the device used to reset the password. |
| brand* | string | Name of the brand or organization associated with the current account. |
| sessionId* | string | Unique sessionId generated for the identifierType and deviceId combination. |
| password* | string | New password for the account. |
| confirmPassword* | string | Reenter the new password. |
Parameters marked with * are mandatory
Parameter marked with ** is mandatory for the mobile application and optional for web application.
Example response
{
"status": {
"success": true,
"code": 200,
"message": "SUCCESS"
}
}{
"status": {
"success": true,
"code": 200,
"message": "SUCCESS"
}
}