RHP_API

<back to all web services

VerifyUserPhone

Validates the Verification Code submitted. Also updates the Visibility and SMSOnly setting.

Requires Authentication
The following routes are available for this service:
POST/User/Phone/Verification
VerifyUserPhone Parameters:
NameParameterData TypeRequiredDescription
VerificationCodebodystringNo
IsVisiblebodyboolNo
IsSmsOnlybodyboolNo
UserPhone Parameters:
NameParameterData TypeRequiredDescription
IsVerifiedformboolNoIf true the user's phone number has been verified.
UserCountryformstringNoThe user's profile Country.
UserCountryCodeformstringNoThe user's profile Country Code.
UserPhoneBasic Parameters:
NameParameterData TypeRequiredDescription
PhoneNumberformstringNoThe phone number, can start with a '0'
IsVisibleformboolNoIf true the user's phone number will be displayed on their profile
IsSmsOnlyformboolNoIf true a note will be added to the user's open profile next to the phone number.
PhoneAlpha2CodeformstringNo2 character country code eg. AU, VN
PhoneCountryCodeformstringNoThe countries phone code, the starting '+' is optional. eg. AU=+61, US=+1

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /User/Phone/Verification HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"VerificationCode":"String","IsVisible":false,"IsSmsOnly":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsVerified":false,"UserCountry":"String","UserCountryCode":"String","PhoneNumber":"String","IsVisible":false,"IsSmsOnly":false,"PhoneAlpha2Code":"String","PhoneCountryCode":"String"}