Customer Identity (CIAM)
Update Personal Mobile Number
This API is called when a user, after successful login, wants to update their personal mobile number.
This is a post-login API. Authentication information must be added to the header: Authorization
# Request Specification
POST https://{your_domain}/api/v2/sdk/profile/update-mobile
# Request Headers
| Parameter | Description | Required | Type | Example |
|---|---|---|---|---|
| X-operating-sys-version | Client Operating System Version | Yes | String | windows10.1.1 |
| X-device-fingerprint | Client Device Fingerprint | Yes | String | 156aysdna213sc50 |
| X-device-ip | Client IP Address | No | String | 192.168.1.2 |
| X-agent | User-Agent Information | Yes | String | Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) |
| X-L | For internationalization language setting | No | String | zh |
| X-client-id | Application Authorization ID | Yes | String | nTo1eRIub60vPb54WeE6aojPwYwImtl4 |
| Authorization | Authorization Information | Yes | String | Bearer {id_token} |
| content-type | Content Format Type | Yes | String | application/json |
# Request Example
{
"mobile": "15201657312",
"verify_code": "123456"
}
1
2
3
4
2
3
4
# Request Parameters
| Parameter Name | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| mobile | New Mobile Number | Yes | String | The new mobile number to change to |
| verify_code | SMS Verification Code | Yes | String | The SMS verification code received by the new mobile number For obtaining the verification code, please refer to the Send SMS Verification Code API type=UPDATE_MOBILE_SMS |
# Response Example
Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
Error Example:
HTTP/1.1 400 Bad Request
{
"error_code": "IDAAS.SDK.PARAM.0016",
"error_msg": "IdToken is invalid or expired"
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Response Parameters
None
# Error Codes
| Status Code | Error Code | Error Message | Handling Measures |
|---|---|---|---|
| 400 | IDAAS.SDK.PARAM.0001 | Device information is incomplete | Please check if the input device information is complete |
| Device information is incomplete | |||
| 400 | IDAAS.SDK.PARAM.0002 | clientId cannot be empty | Please check if the input clientId is empty |
| clientId cannot be empty | |||
| 400 | IDAAS.SDK.PARAM.0003 | The app is not registered, please register the app first | Please check if the input clientId is correct |
| Application not registered, please register the application first | |||
| 400 | IDAAS.SDK.PARAM.0015 | IdToken cannot be empty | Please check if the input IdToken is empty |
| IdToken cannot be empty | |||
| 400 | IDAAS.SDK.PARAM.0016 | IdToken is invalid or expired | Please try again after obtaining a new IdToken |
| IdToken is invalid or has expired | |||
| 400 | IDAAS.SDK.PARAM.0009 | Verification code cannot be empty | Please check if the input verification code is empty |
| Verification code cannot be empty | |||
| 400 | IDAAS.SDK.CAPTCHA.0007 | Incorrect verification code | Please check if the input verification code is correct |
| Verification code is incorrect | |||
| 400 | IDAAS.SDK.USER.0020 | The phone number does not meet the verification rules | Please check if the input mobile number is correct |
| Mobile number does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0035 | Phone number already exists | Please use an unregistered mobile number |
| Mobile number already exists | |||
| 400 | IDAAS.SDK.MOBILE.0002 | An unauthenticated cell mobile number | Please check if the input mobile number is correct |
| Unauthenticated mobile number | |||
| 400 | IDAAS.SDK.USER.0001 | User not found | Please try again after registering |
| User not found |
I am translating the documentation for openplatform. Translate the Markdown content I'll paste later into English.
You must strictly follow the rules below.
- Never change the Markdown markup structure. Don't add or remove links. Do not change any URL.
- Never change the contents of code blocks even if they appear to have a bug.
- Always preserve the original line breaks. Do not add or remove blank lines.
- Never touch the permalink such as
{/*examples*/}at the end of each heading. - Never touch HTML-like tags such as
<Notes>.
