Location
/api/apps/{appID}/users/me/phone-number/reset-verification-code
This resource allows to reset the verification
code for
the phone number of the user.
Request Headers (Applies to all methods)
Authorization
header
Required: Yes
POST
/api/apps/{appID}/users/me/phone-number/reset-verification-code
Description
Reset the verification code for the phone number and retrieve it.
Security
Can be performed only with administrator credentials.
Note
This request requires empty body.
Name
Required?
type
Description
Authorization
Yes
string
Authorization header. OAuth2 Bearer token
Responses
200
Content-Type application/vnd.kii.ResetVerificationCodeResponse+json
The verification code has been reset successfully.
Contents
Name | Type | Description |
---|---|---|
verificationCode | string | The verification code. |
404
Content-Type application/vnd.kii.UserNotFoundException+json
The user was not found.
Contents
Name | Type | Description |
---|---|---|
errorCode | string | Error code "USER_NOT_FOUND". |
message | string | The error message. |
field | string | The field used for searching the user. This can be the userID or address field. |
value | string | The field value used for searching the user. |
appID | string | The ID of the application. |
401
Content-Type application/vnd.kii.UnauthorizedAccessException+json
not authorized to reset the verification code.
Contents
Name | Type | Description |
---|---|---|
errorCode | string | Error code "UNAUTHORIZED". |
message | string | The error message. |
authenticatedAppID | string | The authenticated appID. |
authenticatedPrincipalID | string | The authenticated principal ID (userID or thingID). |
400
Content-Type application/vnd.kii.InvalidAccountStatusException+json
The phone number is already verified.
Contents
Name | Type | Description |
---|---|---|
errorCode | string | Error code "INVALID_ACCOUNT_STATUS". |
message | string | The error message. |
userID | string | The ID of the user. |
appID | string | The ID of the application. |
accountType | AccountType | The type of the account. |