This API endpoint allows you to perform Phone Number Validation checks on behalf of your users in an almost identical fashion to our standard API structure.
Phone Number Validity Checks
About Phone Number Validity Checks in Custom Integrations
API Request URL
Warning: For security reasons, you should only call this API server-side. |
You can use the following URL to submit phone numbers to the phone number validation API:
Request Parameters
Parameter | Description | Example Value / Format |
key | Required. Your site's domain or the domain that requested this integration. | google.com |
secret | Required. Your user's current secret created during the authentication process. | char(128) |
phone | Required. The phone number you wish to validate. If you do not supply a country parameter as well your phone number must include the full country code. | integer or formatted phone number |
strictness | How in depth (strict) do you want this reputation check to be? Stricter checks may provide a higher false-positive rate. We recommend starting at "0", the lowest strictness setting, and increasing to "1" or "2" depending on your levels of fraud. | integer, 0 - 2 |
country (recommended) | You can optionally provide us with the default country or countries this phone number is suspected to be associated with. Our system will prefer to use a country on this list for verification or will require a country to be specified in the event the phone number is less than 10 digits. | string or array of strings |
Response Parameters
Note: Only JSON responses are available from this API. |
Parameter | Description | Format | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
valid | Is the phone number properly formatted and considered valid based on assigned phone numbers available to carriers in that country? | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
active | Is this phone number a live usable phone number that is currently active? | boolean, null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
formatted | The phone number formatted in the international dialing code. N/A if not formattable. | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
local_format | The phone number formatted in the country's local routing rules with area code. N/A if not formattable. | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fraud_score | The IPQS risk score which estimates how likely a phone number is to be fraudulent. Scores 85+ are high risk. | integer, 0 - 100 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recent_abuse | Has this phone number been associated with recent or ongoing fraud? | boolean, null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VOIP | Is this phone number a Voice Over Internet Protocol (VOIP) or digital phone number? | boolean, null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
prepaid | Is this phone number associated with a prepaid service plan? | boolean, null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
risky | Is this phone number associated with fraudulent activity, scams, robo calls, fake accounts, or other unfriendly behavior? | boolean, null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
carrier | The carrier (service provider) this phone number has been assigned to or "N/A" if unknown. | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
line_type | The type of line this phone number is associated with (Toll Free, Mobile, Landline, Satellite, VOIP, Premium Rate, Pager, etc...) or "N/A" if unknown. | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
country | The two character country code for this phone number. | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
region | Region (state) of the phone number if available or "N/A" if unknown. | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
city | City of the phone number if available or "N/A" if unknown. | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
zip_code | Zip or Postal code of the phone number if available or "N/A" if unknown. | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dialing_code | The 1 to 4 digit dialing code for this phone number or null if unknown. | integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_details | Additional scoring variables for risk analysis are available when transaction scoring data is passed through the API request. These variables are also useful for scoring user data such as physical addresses, phone numbers, usernames, and transaction details. The data points below are populated when at least 1 transaction data parameter is present in the initial API request. The following transaction variables are "null" when the necessary transaction parameters are not passed with the initial API request. For instance, not passing the "billing_email" will return "valid_billing_email" as null. | object
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message | A generic status message, either success or some form of an error notice. | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
success | Was the request successful? | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
errors | Array of errors which occurred while attempting to process this request. | array of strings |
EXAMPLE CODE