Phone Validate

GET {{baseUrl}}/phone-validate?number=<string>&country-code=<string>&ip=<string>

Parse, validate and get location information about a phone number

Request Params

KeyDatatypeRequiredDescription
numberstring(Required) A phone number. This can be in international format (E.164) or local format. If passing local format you must also set either the 'country-code' OR 'ip' options as well
country-codestringISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)
ipstringPass in a users IP address and we will assume numbers are based in the country of the IP address

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;valid&quot;:&quot;\u003cboolean\u003e&quot;,&quot;international-calling-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;country-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;location&quot;:&quot;\u003cstring\u003e&quot;,&quot;is-mobile&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;international-number&quot;:&quot;\u003cstring\u003e&quot;,&quot;local-number&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;country-code3&quot;:&quot;\u003cstring\u003e&quot;,&quot;currency-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;prefix-network&quot;:&quot;\u003cstring\u003e&quot;}