Resetting Password Using Mobile Number

Function

A user clicks "Forgot password" on the login page and resets the password using the mobile number. This API is called after the user enters the mobile number, verification code, and new password.

URI

POST /api/v2/sdk/pwd/update-by-mobile

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Set this field to "application/json;charset=utf8".
X-operating-sys-version	Yes	String	Caller OS version, for example, Android 10.
X-device-fingerprint	Yes	String	Caller device fingerprint, for example, 156aysdna213sc50.
X-device-ip	No	String	Caller IP address, for example, 10.10.10.1
X-agent	Yes	String	User agent information, for example, Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L	No	String	Language type, for example, en.
X-client-id	Yes	String	Application ID, which is a ClientId allocated to an application after registration.
X-tenant-id	No	String	Tenant ID. This parameter is mandatory when calling an ISV application. Replace "{domain_name}" with the ISV common domain name "{common_domain}". In the request header, specify tenant_id of the corresponding tenant and replace X-client-id with client_id of the ISV application template.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
mobile	Yes	String	Mobile number for receiving a verification code.
verify_code	Yes	String	Verification code that is received.
password	Yes	String	New password.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
-	String

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error details.

Example Requests

Reset password using mobile number. The mobile number is 12345678901, the verification code is 123456, and the new password is P******d.

POST https://{domain_name}/api/v2/sdk/pwd/update-by-mobile

X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

{
  "mobile": "12345678901",
  "verify_code": "123456",
  "password": "P******d"
}