POST api/users/{guid}/phone/verify

Verify a code a user has obtained from their verification SMS

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

globally unique identifier

Required

Body Parameters

PostPhoneCodeReq
NameDescriptionTypeAdditional information
VerificationCode

The verification code the user was sent in the SMS. Currently a 5 digit integer (10000-99999)

 integer

Required

Request Formats

application/json, text/json

Sample: 
{
  "verificationCode": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Verify a code a user has obtained from their verification SMS

PostPhoneCodeResp
NameDescriptionTypeAdditional information
IsVerified

Whether the passed verification code was correct, and the phone number has been successfully validated

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "isVerified": true
}

Error responses

  • invalid_fields - The submitted information is incomplete or otherwise invalid. The description of the error will be a detailed summary of invalid fields