post
https://{host}/auth/v1/mfa/password/forget
Generate new password when you forget your password.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This API creates a new password when you forget your current password. Use the session ID generated by the /mfa/token/generate API in the request.
The flow chart below shows the steps involved.
API endpoint example
Resource information
| URI | auth/v1/mfa/password/forget |
| HTTP method | GET |
| Pagination supported? | NA |
| Rate limit | NA |
| Batch support | NA |
Request body parameters
| Parameter
| (Parameters marked with * are mandatory) | Data Type | Description |
|---|---|---|
| deviceId* | String | Unique ID of the device used for password generation. It should be the same device used to generate the token. |
| brand* | String | Name of the brand or organisation that needs verification. |
| sessionId* | String | Unique ID created from /mfa/token/generate API. |
| password* | String | New password. |
| confirmPassword* | String | Re-enter new password. |
| identifierType* | String | Type of identifier to identify the customer. Values: MOBILE, EMAIL, USERNAME, EXTERNALID |
| identifierValue* | String | Value of the identifier. |
curl --location 'https://eu.api.capillarytech.com/auth/v1/mfa/password/forget' \
--header 'Content-Type: application/json' \
--header 'Cookie: _cfuvid=dRemgq7Qg.5EBlaabzopnNFgjUrozMPqS0k_jtCO218-1717046418965-0.0.1.1-604800000' \
--data '{
"deviceId":"1234",
"brand":"Bukl",
"sessionId":"P-58cae40f-b505-4f0d-88d2-fa39242daa45",
"password":"12345",
"confirmPassword":"12345",
"identifierType":"MOBILE",
"identifierValue":"18767431754"
}'Response parameters
| Parameter | Datatype | Description |
|---|---|---|
| status | object | Object containing status information. |
| - success | boolean | Boolean indicating the status of the request. |
| - code | integer | HTTP status code indicating the result. Example: 200 indicates success. |
| - message | string | Message describing the status of the request. |
{
"status": {
"success": true,
"code": 200,
"message": "SUCCESS"
}
}