Mobile Verification
Mobile verification can contain details such as whether a mobile is valid/invalid as well as information around porting and roaming.
Minimum Requirements​
Input | Description |
---|---|
mobile | Full mobile without or without country prefix |
Service Request​
To request a Mobile Verification, add a MOBILE_VERIFICATION
action to the request body entity PeopleActionsRequest
:
{
"actions": [
{ "action": "MOBILE_VERIFICATION" }
]
}
PeopleActionsRequest
​
Service Response​
As part of the PersonActionsResponse
entity, the property mobileVerification
contains the results of the request.
MobileVerificationActionResponse
​
If no Mobile Verification has been requested, the response is empty.
If a Mobile Verification has been requested, the following response is available:
Description | ||
---|---|---|
mobileVerification | mobile | The mobile number supplied |
result | The response will be based on the status supplied through the Contact Verification Result. | |
originalCountryName | The originating country where the mobile was registered | |
originalNetworkName | The originating network provider with whom the mobile was first registered | |
ported | Boolean value to derive whether the mobile has been ported True: The mobile has been ported False: The mobile has not been ported | |
portedNetworkName | The network name the mobile has been ported to If the ported value is false, then this is blank. | |
roaming | Boolean value to derive whether the mobile is deemed as roaming and out of the country True: The mobile has been flagged as roaming. False: The mobile has been flagged as not roaming. | |
roamingNetworkName | The network name the mobile was last seen roaming If roaming value is false, then this is blank. |