Verification Code

Location /api/apps/{appID}/users/{accountType}:{address}/phone-number/verification-code
This resource represents the code to verify the phone number of the user.

Request Headers (Applies to all methods)

Authorization
header
Required: Yes

GET

/api/apps/{appID}/users/{accountType}:{address}/phone-number/verification-code

Description

Get the verification code for validating the phone number.

Security

Can be performed only by administrator

Headers
Name Required? type Description
Authorization Yes string Authorization header. OAuth2 Bearer token
Responses
200

Content-Type application/vnd.kii.VerificationCodeRetrievalResponse+json

The verification code has been retrieved 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 get 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).
404

Content-Type application/vnd.kii.VerificationCodeNotFoundException+json

The user did not have verification code for the phone number.
Contents
Name Type Description
errorCode string Error code "VERIFICATION_CODE_NOT_FOUND".
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.